GenerateBenchmarksMetricsRequest

Request message for BenchmarksService.GenerateBenchmarksMetrics.

Proto definition

Fields

application_info

AdditionalApplicationInfo

Additional information on the application issuing the request.

benchmarks_source

BenchmarksSource

Required. The source used to generate benchmarks metrics for.

currency_code

string

Optional. The three-character ISO 4217 currency code. If unspecified, the default currency for monetary values is USD.

customer_benchmarks_group

string

The name of the customer being planned for. This is a user-defined value.

customer_id

string

Required. The ID of the customer. Supply a client customer ID to generate metrics for the customer. A manager account customer ID will not return customer metrics since it does not have any associated direct ad campaigns.

date_range

DateRange

The date range to aggregate metrics over. If unset, data will be returned for the most recent quarter for which data is available. Dates can be retrieved using BenchmarksService.ListBenchmarksAvailableDates.

location

LocationInfo

Required. The location to generate benchmarks metrics for.

product_filter

ProductFilter

Required. The products to aggregate metrics over. Product filter settings support a list of product IDs or a list of marketing objectives.