Generates an ad hoc report.

Scopes

You will need authorization for at least one of the following scopes to make a valid call:

  • https://www.googleapis.com/auth/adsense
  • https://www.googleapis.com/auth/adsense.readonly

If unset, the scope for this method defaults to https://www.googleapis.com/auth/adsense.readonly. You can set the scope for this method like this: adsense2 --scope <scope> accounts reports-generate ...

Required Scalar Argument

  • <account> (string)
    • Required. The account which owns the collection of reports. Format: accounts/{account}

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

  • -o out
    • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional Method Properties

You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness.

  • -p currency-code=string

    • The ISO-4217 currency code to use when reporting on monetary metrics. Defaults to the account's currency if not set.

  • -p date-range=string

    • Date range of the report, if unset the range will be considered CUSTOM.

  • -p dimensions=string

    • Dimensions to base the report on.

  • -p end-date-day=integer

    • Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

  • -p end-date-month=integer

    • Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

  • -p end-date-year=integer

    • Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

  • -p filters=string

    • A list of filters to apply to the report. All provided filters must match in order for the data to be included in the report.

  • -p language-code=string

    • The language to use for translating report output. If unspecified, this defaults to English ("en"). If the given language is not supported, report output will be returned in English. The language is specified as an IETF BCP-47 language code.

  • -p limit=integer

    • The maximum number of rows of report data to return. Reports producing more rows than the requested limit will be truncated. If unset, this defaults to 100,000 rows for Reports.GenerateReport and 1,000,000 rows for Reports.GenerateCsvReport, which are also the maximum values permitted here. Report truncation can be identified (for Reports.GenerateReport only) by comparing the number of rows returned to the value returned in total_matched_rows.

  • -p metrics=string

    • Required. Reporting metrics.

  • -p order-by=string

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

  • -p reporting-time-zone=string

  • -p start-date-day=integer

    • Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

  • -p start-date-month=integer

    • Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

  • -p start-date-year=integer

    • Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

  • -p $-xgafv=string

    • V1 error format.

  • -p access-token=string

    • OAuth access token.

  • -p alt=string

    • Data format for response.

  • -p callback=string

    • JSONP

  • -p fields=string

    • Selector specifying which fields to include in a partial response.

  • -p key=string

    • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

  • -p oauth-token=string

    • OAuth 2.0 token for the current user.

  • -p pretty-print=boolean

    • Returns response with indentations and line breaks.

  • -p quota-user=string

    • Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • -p upload-type=string

    • Legacy upload protocol for media (e.g. "media", "multipart").

  • -p upload-protocol=string

    • Upload protocol for media (e.g. "raw", "multipart").