gogol-adsense-0.0.1: Google AdSense Management SDK.

Copyright(c) 2015 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.Google.Resource.AdSense.Reports.Generate

Contents

Description

Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify "alt=csv" as a query parameter.

See: AdSense Management API Reference for adsense.reports.generate.

Synopsis

REST Resource

type ReportsGenerateResource = ("adsense" :> ("v1.4" :> ("reports" :> (QueryParam "startDate" Text :> (QueryParam "endDate" Text :> (QueryParams "dimension" Text :> (QueryParam "locale" Text :> (QueryParams "accountId" Text :> (QueryParams "metric" Text :> (QueryParam "currency" Text :> (QueryParams "sort" Text :> (QueryParams "filter" Text :> (QueryParam "startIndex" (Textual Int32) :> (QueryParam "useTimezoneReporting" Bool :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get `[JSON]` AdsenseReportsGenerateResponse)))))))))))))))) :<|> ("adsense" :> ("v1.4" :> ("reports" :> (QueryParam "startDate" Text :> (QueryParam "endDate" Text :> (QueryParams "dimension" Text :> (QueryParam "locale" Text :> (QueryParams "accountId" Text :> (QueryParams "metric" Text :> (QueryParam "currency" Text :> (QueryParams "sort" Text :> (QueryParams "filter" Text :> (QueryParam "startIndex" (Textual Int32) :> (QueryParam "useTimezoneReporting" Bool :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltMedia :> Get `[OctetStream]` Stream)))))))))))))))) Source

A resource alias for adsense.reports.generate method which the ReportsGenerate request conforms to.

Creating a Request

reportsGenerate Source

Arguments

:: Text

rgEndDate

-> Text

rgStartDate

-> ReportsGenerate 

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

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

data ReportsGenerate Source

Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify "alt=csv" as a query parameter.

See: reportsGenerate smart constructor.

Instances

Request Lenses

rgDimension :: Lens' ReportsGenerate [Text] Source

Dimensions to base the report on.

rgLocale :: Lens' ReportsGenerate (Maybe Text) Source

Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified.

rgEndDate :: Lens' ReportsGenerate Text Source

End of the date range to report on in "YYYY-MM-DD" format, inclusive.

rgStartDate :: Lens' ReportsGenerate Text Source

Start of the date range to report on in "YYYY-MM-DD" format, inclusive.

rgAccountId :: Lens' ReportsGenerate [Text] Source

Accounts upon which to report.

rgMetric :: Lens' ReportsGenerate [Text] Source

Numeric columns to include in the report.

rgCurrency :: Lens' ReportsGenerate (Maybe Text) Source

Optional currency to use when reporting on monetary metrics. Defaults to the account's currency if not set.

rgSort :: Lens' ReportsGenerate [Text] Source

The name of a dimension or metric to sort the resulting report on, optionally prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is specified, the column is sorted ascending.

rgFilter :: Lens' ReportsGenerate [Text] Source

Filters to be run on the report.

rgStartIndex :: Lens' ReportsGenerate (Maybe Int32) Source

Index of the first row of report data to return.

rgUseTimezoneReporting :: Lens' ReportsGenerate (Maybe Bool) Source

Whether the report should be generated in the AdSense account's local timezone. If false default PST/PDT timezone will be used.

rgMaxResults :: Lens' ReportsGenerate (Maybe Int32) Source

The maximum number of rows of report data to return.