Network.Google.Resource.GAN.Reports.Get

Retrieves a report of the specified type.

See: Google Affiliate Network API Reference for gan.reports.get.

REST Resource

type ReportsGetResource = "gan" :> ("v1beta1" :> (Capture "role" ReportsGetRole :> (Capture "roleId" Text :> ("report" :> (Capture "reportType" ReportsGetReportType :> (QueryParam "status" ReportsGetStatus :> (QueryParams "advertiserId" Text :> (QueryParam "endDate" Text :> (QueryParam "eventType" ReportsGetEventType :> (QueryParam "startDate" Text :> (QueryParam "calculateTotals" Bool :> (QueryParams "linkId" Text :> (QueryParams "orderId" Text :> (QueryParams "publisherId" Text :> (QueryParam "startIndex" (Textual Word32) :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get `[JSON]` Report)))))))))))))))))

A resource alias for gan.reports.get method which the ReportsGet request conforms to.

Creating a Request

reportsGet

Arguments

:: Text

rgRoleId

-> ReportsGetRole

rgRole

-> ReportsGetReportType

rgReportType

-> ReportsGet

Creates a value of ReportsGet with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rgStatus
• rgAdvertiserId
• rgEndDate
• rgRoleId
• rgRole
• rgEventType
• rgStartDate
• rgCalculateTotals
• rgLinkId
• rgOrderId
• rgPublisherId
• rgReportType
• rgStartIndex
• rgMaxResults

data ReportsGet

Retrieves a report of the specified type.

See: reportsGet smart constructor.

Instances

Eq ReportsGet

Data ReportsGet

Show ReportsGet

Generic ReportsGet

GoogleRequest ReportsGet

type Rep ReportsGet

type Rs ReportsGet = Report

Request Lenses

rgStatus :: Lens' ReportsGet (Maybe ReportsGetStatus)

Filters out all events that do not have the given status. Valid values: 'active', 'canceled', or 'invalid'. Optional.

rgAdvertiserId :: Lens' ReportsGet [Text]

The IDs of the advertisers to look up, if applicable.

rgEndDate :: Lens' ReportsGet (Maybe Text)

The end date (exclusive), in RFC 3339 format, for the report data to be returned. Defaults to one day after startDate, if that is given, or today. Optional.

rgRoleId :: Lens' ReportsGet Text

The ID of the requesting advertiser or publisher.

rgRole :: Lens' ReportsGet ReportsGetRole

The role of the requester. Valid values: 'advertisers' or 'publishers'.

rgEventType :: Lens' ReportsGet (Maybe ReportsGetEventType)

Filters out all events that are not of the given type. Valid values: 'action', 'transaction', or 'charge'. Optional.

rgStartDate :: Lens' ReportsGet (Maybe Text)

The start date (inclusive), in RFC 3339 format, for the report data to be returned. Defaults to one day before endDate, if that is given, or yesterday. Optional.

rgCalculateTotals :: Lens' ReportsGet (Maybe Bool)

Whether or not to calculate totals rows. Optional.

rgLinkId :: Lens' ReportsGet [Text]

Filters to capture one of given link IDs. Optional.

rgOrderId :: Lens' ReportsGet [Text]

Filters to capture one of the given order IDs. Optional.

rgPublisherId :: Lens' ReportsGet [Text]

The IDs of the publishers to look up, if applicable.

rgReportType :: Lens' ReportsGet ReportsGetReportType

The type of report being requested. Valid values: 'order_delta'. Required.

rgStartIndex :: Lens' ReportsGet (Maybe Word32)

Offset on which to return results when paging. Optional.

rgMaxResults :: Lens' ReportsGet (Maybe Word32)

Max number of items to return in this page. Optional. Defaults to return all results.