Reference documentation and code samples for the Google Ads Ad Manager V1 Client class ReportDefinition.
The definition of how a report should be run.
Generated from protobuf message google.ads.admanager.v1.ReportDefinition
Namespace
Google \ Ads \ AdManager \ V1Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ dimensions |
array
Required. The list of dimensions to report on. If empty, the report will have no dimensions, and any metrics will be totals. |
↳ metrics |
array
Required. The list of metrics to report on. If empty, the report will have no metrics. |
↳ filters |
array<Report\Filter>
Optional. The filters for this report. |
↳ time_zone_source |
int
Optional. Where to get the time zone for this report. Defaults to using the network time zone setting (PUBLISHER). If source is PROVIDED, the time_zone field in the report definition must also be provided with the desired time zone. |
↳ time_zone |
string
Optional. If time_zone_source is PROVIDED, this is the time zone to use for this report. Leave empty for any other time zone source. Time zone in IANA format (e.g. "America/New_York"). |
↳ currency_code |
string
Optional. The ISO 4217 currency code for this report. Defaults to publisher currency code if not specified. |
↳ date_range |
Report\DateRange
Required. The primary date range of this report. |
↳ comparison_date_range |
Report\DateRange
Optional. The comparison date range of this report. If unspecified, the report will not have any comparison metrics. |
↳ custom_dimension_key_ids |
array
Optional. Custom Dimension keys that represent CUSTOM_DIMENSION_* dimensions. The index of this repeated field corresponds to the index on each dimension. For example, custom_dimension_key_ids[0] describes CUSTOM_DIMENSION_0_VALUE_ID and CUSTOM_DIMENSION_0_VALUE. |
↳ line_item_custom_field_ids |
array
Optional. Custom field IDs that represent LINE_ITEM_CUSTOM_FIELD_* dimensions. The index of this repeated field corresponds to the index on each dimension. For example, line_item_custom_field_ids[0] describes LINE_ITEM_CUSTOM_FIELD_0_OPTION_ID and LINE_ITEM_CUSTOM_FIELD_0_VALUE. |
↳ order_custom_field_ids |
array
Optional. Custom field IDs that represent ORDER_CUSTOM_FIELD_* dimensions. The index of this repeated field corresponds to the index on each dimension. For example, order_custom_field_ids[0] describes ORDER_CUSTOM_FIELD_0_OPTION_ID and ORDER_CUSTOM_FIELD_0_VALUE. |
↳ creative_custom_field_ids |
array
Optional. Custom field IDs that represent CREATIVE_CUSTOM_FIELD_* dimensions. The index of this repeated field corresponds to the index on each dimension. For example, creative_custom_field_ids[0] describes CREATIVE_CUSTOM_FIELD_0_OPTION_ID and CREATIVE_CUSTOM_FIELD_0_VALUE. |
↳ report_type |
int
Required. The type of this report. |
↳ time_period_column |
int
Optional. Include a time period column to introduce comparison columns in the report for each generated period. For example, set to "QUARTERS" here to have a column for each quarter present in the primary date range. If "PREVIOUS PERIOD" is specified in comparison_date_range, then each quarter column will also include comparison values for its relative previous quarter. |
↳ flags |
array<Report\Flag>
Optional. List of flags for this report. Used to flag rows in a result set based on a set of defined filters. |
↳ sorts |
array<Report\Sort>
Optional. Default sorts to apply to this report. |
getDimensions
Required. The list of dimensions to report on. If empty, the report will have no dimensions, and any metrics will be totals.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\RepeatedField |
setDimensions
Required. The list of dimensions to report on. If empty, the report will have no dimensions, and any metrics will be totals.
Parameter | |
---|---|
Name | Description |
var |
int[]
|
Returns | |
---|---|
Type | Description |
$this |
getMetrics
Required. The list of metrics to report on. If empty, the report will have no metrics.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\RepeatedField |
setMetrics
Required. The list of metrics to report on. If empty, the report will have no metrics.
Parameter | |
---|---|
Name | Description |
var |
int[]
|
Returns | |
---|---|
Type | Description |
$this |
getFilters
Optional. The filters for this report.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\RepeatedField |
setFilters
Optional. The filters for this report.
Parameter | |
---|---|
Name | Description |
var |
array<Report\Filter>
|
Returns | |
---|---|
Type | Description |
$this |
getTimeZoneSource
Optional. Where to get the time zone for this report. Defaults to using the network time zone setting (PUBLISHER). If source is PROVIDED, the time_zone field in the report definition must also be provided with the desired time zone.
Returns | |
---|---|
Type | Description |
int |
setTimeZoneSource
Optional. Where to get the time zone for this report. Defaults to using the network time zone setting (PUBLISHER). If source is PROVIDED, the time_zone field in the report definition must also be provided with the desired time zone.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |
getTimeZone
Optional. If time_zone_source is PROVIDED, this is the time zone to use for this report. Leave empty for any other time zone source. Time zone in IANA format (e.g. "America/New_York").
Returns | |
---|---|
Type | Description |
string |
setTimeZone
Optional. If time_zone_source is PROVIDED, this is the time zone to use for this report. Leave empty for any other time zone source. Time zone in IANA format (e.g. "America/New_York").
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getCurrencyCode
Optional. The ISO 4217 currency code for this report. Defaults to publisher currency code if not specified.
Returns | |
---|---|
Type | Description |
string |
setCurrencyCode
Optional. The ISO 4217 currency code for this report. Defaults to publisher currency code if not specified.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getDateRange
Required. The primary date range of this report.
Returns | |
---|---|
Type | Description |
Report\DateRange|null |
hasDateRange
clearDateRange
setDateRange
Required. The primary date range of this report.
Parameter | |
---|---|
Name | Description |
var |
Report\DateRange
|
Returns | |
---|---|
Type | Description |
$this |
getComparisonDateRange
Optional. The comparison date range of this report. If unspecified, the report will not have any comparison metrics.
Returns | |
---|---|
Type | Description |
Report\DateRange|null |
hasComparisonDateRange
clearComparisonDateRange
setComparisonDateRange
Optional. The comparison date range of this report. If unspecified, the report will not have any comparison metrics.
Parameter | |
---|---|
Name | Description |
var |
Report\DateRange
|
Returns | |
---|---|
Type | Description |
$this |
getCustomDimensionKeyIds
Optional. Custom Dimension keys that represent CUSTOM_DIMENSION_* dimensions. The index of this repeated field corresponds to the index on each dimension. For example, custom_dimension_key_ids[0] describes CUSTOM_DIMENSION_0_VALUE_ID and CUSTOM_DIMENSION_0_VALUE.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\RepeatedField |
setCustomDimensionKeyIds
Optional. Custom Dimension keys that represent CUSTOM_DIMENSION_* dimensions. The index of this repeated field corresponds to the index on each dimension. For example, custom_dimension_key_ids[0] describes CUSTOM_DIMENSION_0_VALUE_ID and CUSTOM_DIMENSION_0_VALUE.
Parameter | |
---|---|
Name | Description |
var |
int[]|string[]|Google\Protobuf\Internal\RepeatedField
|
Returns | |
---|---|
Type | Description |
$this |
getLineItemCustomFieldIds
Optional. Custom field IDs that represent LINE_ITEM_CUSTOM_FIELD_* dimensions. The index of this repeated field corresponds to the index on each dimension. For example, line_item_custom_field_ids[0] describes LINE_ITEM_CUSTOM_FIELD_0_OPTION_ID and LINE_ITEM_CUSTOM_FIELD_0_VALUE.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\RepeatedField |
setLineItemCustomFieldIds
Optional. Custom field IDs that represent LINE_ITEM_CUSTOM_FIELD_* dimensions. The index of this repeated field corresponds to the index on each dimension. For example, line_item_custom_field_ids[0] describes LINE_ITEM_CUSTOM_FIELD_0_OPTION_ID and LINE_ITEM_CUSTOM_FIELD_0_VALUE.
Parameter | |
---|---|
Name | Description |
var |
int[]|string[]|Google\Protobuf\Internal\RepeatedField
|
Returns | |
---|---|
Type | Description |
$this |
getOrderCustomFieldIds
Optional. Custom field IDs that represent ORDER_CUSTOM_FIELD_* dimensions. The index of this repeated field corresponds to the index on each dimension. For example, order_custom_field_ids[0] describes ORDER_CUSTOM_FIELD_0_OPTION_ID and ORDER_CUSTOM_FIELD_0_VALUE.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\RepeatedField |
setOrderCustomFieldIds
Optional. Custom field IDs that represent ORDER_CUSTOM_FIELD_* dimensions. The index of this repeated field corresponds to the index on each dimension. For example, order_custom_field_ids[0] describes ORDER_CUSTOM_FIELD_0_OPTION_ID and ORDER_CUSTOM_FIELD_0_VALUE.
Parameter | |
---|---|
Name | Description |
var |
int[]|string[]|Google\Protobuf\Internal\RepeatedField
|
Returns | |
---|---|
Type | Description |
$this |
getCreativeCustomFieldIds
Optional. Custom field IDs that represent CREATIVE_CUSTOM_FIELD_* dimensions. The index of this repeated field corresponds to the index on each dimension. For example, creative_custom_field_ids[0] describes CREATIVE_CUSTOM_FIELD_0_OPTION_ID and CREATIVE_CUSTOM_FIELD_0_VALUE.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\RepeatedField |
setCreativeCustomFieldIds
Optional. Custom field IDs that represent CREATIVE_CUSTOM_FIELD_* dimensions. The index of this repeated field corresponds to the index on each dimension. For example, creative_custom_field_ids[0] describes CREATIVE_CUSTOM_FIELD_0_OPTION_ID and CREATIVE_CUSTOM_FIELD_0_VALUE.
Parameter | |
---|---|
Name | Description |
var |
int[]|string[]|Google\Protobuf\Internal\RepeatedField
|
Returns | |
---|---|
Type | Description |
$this |
getReportType
Required. The type of this report.
Returns | |
---|---|
Type | Description |
int |
setReportType
Required. The type of this report.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |
getTimePeriodColumn
Optional. Include a time period column to introduce comparison columns in the report for each generated period. For example, set to "QUARTERS" here to have a column for each quarter present in the primary date range. If "PREVIOUS PERIOD" is specified in comparison_date_range, then each quarter column will also include comparison values for its relative previous quarter.
Returns | |
---|---|
Type | Description |
int |
setTimePeriodColumn
Optional. Include a time period column to introduce comparison columns in the report for each generated period. For example, set to "QUARTERS" here to have a column for each quarter present in the primary date range. If "PREVIOUS PERIOD" is specified in comparison_date_range, then each quarter column will also include comparison values for its relative previous quarter.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |
getFlags
Optional. List of flags for this report. Used to flag rows in a result set based on a set of defined filters.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\RepeatedField |
setFlags
Optional. List of flags for this report. Used to flag rows in a result set based on a set of defined filters.
Parameter | |
---|---|
Name | Description |
var |
array<Report\Flag>
|
Returns | |
---|---|
Type | Description |
$this |
getSorts
Optional. Default sorts to apply to this report.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\RepeatedField |
setSorts
Optional. Default sorts to apply to this report.
Parameter | |
---|---|
Name | Description |
var |
array<Report\Sort>
|
Returns | |
---|---|
Type | Description |
$this |