A More...

Properties
Dimension[]	dimensions `[get, set]`
	The list of break-down types being requested in the report. The generated report will contain the dimensions in the same order as requested. This field is required. More...

ReportQueryAdUnitView	adUnitView `[get, set]`
	The ad unit view for the report. Defaults to AdUnitView::TOP_LEVEL. More...

bool	adUnitViewSpecified `[get, set]`

Column[]	columns `[get, set]`
	The list of trafficking statistics and revenue information being requested in the report. The generated report will contain the columns in the same order as requested. This field is required. More...

DimensionAttribute[]	dimensionAttributes `[get, set]`
	The list of break-down attributes being requested in this report. Some DimensionAttribute values can only be used with certain Dimension values that must be included in the #dimensions attribute. The generated report will contain the attributes in the same order as requested. More...

long[]	customFieldIds `[get, set]`
	The list of CustomField::id being requested in this report. To add a CustomField to the report, you must include its corresponding Dimension, determined by the CustomField::entityType, as a dimension. More...

long[]	cmsMetadataKeyIds `[get, set]`
	The list of content CMS metadata key IDs being requested in this report. Each of these IDs must have been defined in the CMS metadata key. This will include dimensions in the form of More...

long[]	customDimensionKeyIds `[get, set]`
	The list of custom dimension custom targeting key IDs being requested in this report. This will include dimensions in the form of More...

Date	startDate `[get, set]`
	The start date from which the reporting information is gathered. The More...

Date	endDate `[get, set]`
	The end date upto which the reporting information is gathered. The More...

DateRangeType	dateRangeType `[get, set]`
	The period of time for which the reporting data is being generated. In order to define custom time periods, set this to DateRangeType::CUSTOM_DATE. If set to DateRangeType::CUSTOM_DATE, then ReportQuery::startDate and ReportQuery::endDate will be used. More...

bool	dateRangeTypeSpecified `[get, set]`

Statement	statement `[get, set]`
	Specifies a filter to use for reporting on data. This filter will be used in conjunction (joined with an AND statement) with the date range selected through #dateRangeType, #startDate, and #endDate. The syntax currently allowed for Statement::query is More...

string	reportCurrency `[get, set]`
	The currency for revenue metrics. Defaults to the network currency if left More...

TimeZoneType	timeZoneType `[get, set]`

bool	timeZoneTypeSpecified `[get, set]`

Detailed Description

A

ReportQuery object allows you to specify the selection criteria for generating a report. Only reports with at least one Column are supported.

Property Documentation

ReportQueryAdUnitView Google.Api.Ads.AdManager.v202311.ReportQuery.adUnitView

getset

The ad unit view for the report. Defaults to AdUnitView::TOP_LEVEL.

bool Google.Api.Ads.AdManager.v202311.ReportQuery.adUnitViewSpecified

getset

true, if a value is specified for adUnitView, false otherwise.

long [] Google.Api.Ads.AdManager.v202311.ReportQuery.cmsMetadataKeyIds

getset

The list of content CMS metadata key IDs being requested in this report. Each of these IDs must have been defined in the CMS metadata key. This will include dimensions in the form of

CMS_METADATA_KEY[id]_ID and where where ID is the ID of the CMS metadata value and is the name.

To add IDs, you must include Dimension::CMS_METADATA in #dimensions, and specify a non-empty list of content CMS metadata key IDs. The order of content CMS metadata columns in the report correspond to the place of Dimension::CMS_METADATA in #dimensions. For example, if #dimensions contains the following dimensions in the order: Dimension::ADVERTISER_NAME, Dimension::CMS_METADATA and Dimension::COUNTRY_NAME, and #cmsMetadataKeyIds contains the following IDs in the order: 1001 and 1002. The order of dimensions in the report will be: Dimension.ADVERTISER_NAME, Dimension.CMS_METADATA_KEY[1001]_VALUE, Dimension.CMS_METADATA_KEY[1002]_VALUE, Dimension.COUNTRY_NAME, Dimension.ADVERTISER_ID, Dimension.CMS_METADATA_KEY[1001]_ID, Dimension.CMS_METADATA_KEY[1002]_ID, Dimension.COUNTRY_CRITERIA_ID

Column [] Google.Api.Ads.AdManager.v202311.ReportQuery.columns

getset

The list of trafficking statistics and revenue information being requested in the report. The generated report will contain the columns in the same order as requested. This field is required.

long [] Google.Api.Ads.AdManager.v202311.ReportQuery.customDimensionKeyIds

getset

The list of custom dimension custom targeting key IDs being requested in this report. This will include dimensions in the form of

and where ID is the ID of the custom targeting value and VALUE is the name.

To add IDs, you must include Dimension::CUSTOM_DIMENSION in #dimensions, and specify a non-empty list of custom targeting key IDs. The order of cusotm dimension columns in the report correspond to the place of Dimension::CUSTOM_DIMENSION in #dimensions. For example, if #dimensions contains the following dimensions in the order: Dimension::ADVERTISER_NAME, Dimension::CUSTOM_DIMENSION and Dimension::COUNTRY_NAME, and #customCriteriaCustomTargetingKeyIds contains the following IDs in the order: 1001 and 1002. The order of dimensions in the report will be: Dimension.ADVERTISER_NAME, Dimension.TOP_LEVEL_DIMENSION_KEY[1001]_VALUE, Dimension.TOP_LEVEL_DIMENSION_KEY[1002]_VALUE, Dimension.COUNTRY_NAME, Dimension.ADVERTISER_ID, Dimension.TOP_LEVEL_DIMENSION_KEY[1001]_ID, Dimension.TOP_LEVEL_DIMENSION_KEY[1002]_ID, Dimension.COUNTRY_CRITERIA_ID.

long [] Google.Api.Ads.AdManager.v202311.ReportQuery.customFieldIds

getset

The list of CustomField::id being requested in this report. To add a CustomField to the report, you must include its corresponding Dimension, determined by the CustomField::entityType, as a dimension.

CustomFieldEntityType::entityType
CustomFieldEntityType::LINE_ITEM	Dimension::LINE_ITEM_NAME
CustomFieldEntityType::ORDER	Dimension::ORDER_NAME
CustomFieldEntityType::CREATIVE	Dimension::CREATIVE_NAME

DateRangeType Google.Api.Ads.AdManager.v202311.ReportQuery.dateRangeType

getset

The period of time for which the reporting data is being generated. In order to define custom time periods, set this to DateRangeType::CUSTOM_DATE. If set to DateRangeType::CUSTOM_DATE, then ReportQuery::startDate and ReportQuery::endDate will be used.

bool Google.Api.Ads.AdManager.v202311.ReportQuery.dateRangeTypeSpecified

getset

true, if a value is specified for dateRangeType, false otherwise.

DimensionAttribute [] Google.Api.Ads.AdManager.v202311.ReportQuery.dimensionAttributes

getset

The list of break-down attributes being requested in this report. Some DimensionAttribute values can only be used with certain Dimension values that must be included in the #dimensions attribute. The generated report will contain the attributes in the same order as requested.

Dimension [] Google.Api.Ads.AdManager.v202311.ReportQuery.dimensions

getset

The list of break-down types being requested in the report. The generated report will contain the dimensions in the same order as requested. This field is required.

Date Google.Api.Ads.AdManager.v202311.ReportQuery.endDate

getset

The end date upto which the reporting information is gathered. The

ReportQuery::dateRangeType field must be set to DateRangeType::CUSTOM_DATE in order to use this.

string Google.Api.Ads.AdManager.v202311.ReportQuery.reportCurrency

getset

The currency for revenue metrics. Defaults to the network currency if left

null. The supported currency codes can be found in this Help Center article.

Date Google.Api.Ads.AdManager.v202311.ReportQuery.startDate

getset

The start date from which the reporting information is gathered. The

ReportQuery::dateRangeType field must be set to DateRangeType::CUSTOM_DATE in order to use this.

Statement Google.Api.Ads.AdManager.v202311.ReportQuery.statement

getset

Specifies a filter to use for reporting on data. This filter will be used in conjunction (joined with an AND statement) with the date range selected through #dateRangeType, #startDate, and #endDate. The syntax currently allowed for Statement::query is

[WHERE <condition> {AND <condition> ...}]

<condition>
#x160;#x160;#x160;#x160; := <property> = <value>
<condition>
#x160;#x160;#x160;#x160; := <property> = <bind variable>
<condition> := <property> IN <list>
<bind variable> := :<name>
where property is the enumeration name of a Dimension that can be filtered.

For example, the statement "WHERE LINE_ITEM_ID IN (34344, 23235)" can be used to generate a report for a specific set of line items

Filtering on IDs is highly recommended over filtering on names, especially for geographical entities. When filtering on names, matching is case sensitive.

TimeZoneType Google.Api.Ads.AdManager.v202311.ReportQuery.timeZoneType

getset

bool Google.Api.Ads.AdManager.v202311.ReportQuery.timeZoneTypeSpecified

getset

true, if a value is specified for timeZoneType, false otherwise.

The documentation for this class was generated from the following file:

dist/github/src/AdManager/v202311/AdManagerApi.cs

Properties

Detailed Description

Property Documentation