Network.Google.Resource.AdSense.Accounts.Reports.Generate

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.accounts.reports.generate.

REST Resource

type AccountsReportsGenerateResource = ("adsense" :> ("v1.4" :> ("accounts" :> (Capture "accountId" Text :> ("reports" :> (QueryParam "startDate" Text :> (QueryParam "endDate" Text :> (QueryParams "dimension" Text :> (QueryParam "locale" 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" :> ("accounts" :> (Capture "accountId" Text :> ("reports" :> (QueryParam "startDate" Text :> (QueryParam "endDate" Text :> (QueryParams "dimension" Text :> (QueryParam "locale" 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)))))))))))))))))

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

Creating a Request

accountsReportsGenerate

Arguments

:: Text

argEndDate

-> Text

argStartDate

-> Text

argAccountId

-> AccountsReportsGenerate

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

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

• argDimension
• argLocale
• argEndDate
• argStartDate
• argAccountId
• argMetric
• argCurrency
• argSort
• argFilter
• argStartIndex
• argUseTimezoneReporting
• argMaxResults

data AccountsReportsGenerate

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: accountsReportsGenerate smart constructor.

Instances

Eq AccountsReportsGenerate

Data AccountsReportsGenerate

Show AccountsReportsGenerate

Generic AccountsReportsGenerate

GoogleRequest AccountsReportsGenerate

GoogleRequest (MediaDownload AccountsReportsGenerate)

type Rep AccountsReportsGenerate

type Rs AccountsReportsGenerate = AdsenseReportsGenerateResponse

type Rs (MediaDownload AccountsReportsGenerate) = Stream

Request Lenses

argDimension :: Lens' AccountsReportsGenerate [Text]

Dimensions to base the report on.

argLocale :: Lens' AccountsReportsGenerate (Maybe Text)

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

argEndDate :: Lens' AccountsReportsGenerate Text

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

argStartDate :: Lens' AccountsReportsGenerate Text

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

argAccountId :: Lens' AccountsReportsGenerate Text

Account upon which to report.

argMetric :: Lens' AccountsReportsGenerate [Text]

Numeric columns to include in the report.

argCurrency :: Lens' AccountsReportsGenerate (Maybe Text)

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

argSort :: Lens' AccountsReportsGenerate [Text]

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.

argFilter :: Lens' AccountsReportsGenerate [Text]

Filters to be run on the report.

argStartIndex :: Lens' AccountsReportsGenerate (Maybe Int32)

Index of the first row of report data to return.

argUseTimezoneReporting :: Lens' AccountsReportsGenerate (Maybe Bool)

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

argMaxResults :: Lens' AccountsReportsGenerate (Maybe Int32)

The maximum number of rows of report data to return.