Web Service: ReportService

Target Namespace:

https://www.google.com/apis/ads/publisher/v202502

Port ReportServiceInterfacePort Port type Source code

Location:

https://ads.google.com/apis/ads/publisher/v202502/ReportService

Protocol:

SOAP

Default style:

document

Transport protocol:

SOAP over HTTP

Operations:

getReportDownloadURLDetail Source code
getReportDownloadUrlWithOptionsDetail Source code
getReportJobStatusDetail Source code
getSavedQueriesByStatementDetail Source code
runReportJobDetail Source code

Operations

Port type ReportServiceInterfaceSource code

getReportDownloadURL
Source code
Description:
Returns the URL at which the report file can be downloaded.
The report will be generated as a gzip archive, containing the report file itself.
Operation type:
Request-response. The endpoint receives a message, and sends a correlated message.
Input:
getReportDownloadURLRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
parameters type getReportDownloadURL
Returns the URL at which the report file can be downloaded.
The report will be generated as a gzip archive, containing the report file itself.
- reportJobId - optional; type long
- exportFormat - optional; type ExportFormat - type string with restriction - enum { 'TSV', 'TSV_EXCEL', 'CSV_DUMP', 'XML', 'XLSX' }
Output:
getReportDownloadURLResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
parameters type getReportDownloadURLResponse
- rval - optional; type string
Fault:
ApiException (wsdlsoap:fault, use = literal)Source code
ApiException type ApiExceptionFault
Exception class for holding a list of service errors.
Base class for exceptions.
- message - optional; type string
  Error message.
- errors - optional, unbounded; type ApiError
  The API error base class that provides details about an error that occurred while processing a service request.
  The OGNL field path is provided for parsers to identify the request data element that may have caused the error.
  - fieldPath - optional; type string
    The OGNL field path to identify cause of error.
  - fieldPathElements - optional, unbounded; type FieldPathElement
    A parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.
    A segment of a field path. Each dot in a field path defines a new segment.
    - field - optional; type string
      The name of a field in lower camelcase. (e.g. "biddingStrategy")
    - index - optional; type int
      For list fields, this is a 0-indexed position in the list. Null for non-list fields.
  - trigger - optional; type string
    The data that caused the error.
  - errorString - optional; type string
    A simple string representation of the error and reason.
  List of errors.
A fault element of type ApiException.
getReportDownloadUrlWithOptions
Source code
Description:
Returns the URL at which the report file can be downloaded, and allows for customization of the downloaded report.
By default, the report will be generated as a gzip archive, containing the report file itself. This can be changed by setting {@link ReportDownloadOptions#useGzipCompression} to false.
Operation type:
Request-response. The endpoint receives a message, and sends a correlated message.
Input:
getReportDownloadUrlWithOptionsRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
parameters type getReportDownloadUrlWithOptions
Returns the URL at which the report file can be downloaded, and allows for customization of the downloaded report.
By default, the report will be generated as a gzip archive, containing the report file itself. This can be changed by setting {@link ReportDownloadOptions#useGzipCompression} to false.
- reportJobId - optional; type long
- reportDownloadOptions - optional; type ReportDownloadOptions
  Represents the options for an API report download request. See {@link ReportService#getReportDownloadUrlWithOptions}.
  - exportFormat - optional; type ExportFormat - type string with restriction - enum { 'TSV', 'TSV_EXCEL', 'CSV_DUMP', 'XML', 'XLSX' }
    The {@link ExportFormat} used to generate the report. Default value is {@link ExportFormat#CSV_DUMP}.
  - includeReportProperties - optional; type boolean
    Whether or not to include the report properties (e.g. network, user, date generated...) in the generated report. Default is false.
  - includeTotalsRow - optional; type boolean
    Whether or not to include the totals row. Default is true for all formats except {@link ExportFormat#CSV_DUMP}.
  - useGzipCompression - optional; type boolean
    Whether or not to compress the report file to a gzip file. Default is true.
    Regardless of value, gzip http compression is available from the URL by normal means.
Output:
getReportDownloadUrlWithOptionsResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
parameters type getReportDownloadUrlWithOptionsResponse
- rval - optional; type string
Fault:
ApiException (wsdlsoap:fault, use = literal)Source code
ApiException type ApiExceptionFault
Exception class for holding a list of service errors.
Base class for exceptions.
- message - optional; type string
  Error message.
- errors - optional, unbounded; type ApiError
  The API error base class that provides details about an error that occurred while processing a service request.
  The OGNL field path is provided for parsers to identify the request data element that may have caused the error.
  - fieldPath - optional; type string
    The OGNL field path to identify cause of error.
  - fieldPathElements - optional, unbounded; type FieldPathElement
    A parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.
    A segment of a field path. Each dot in a field path defines a new segment.
    - field - optional; type string
      The name of a field in lower camelcase. (e.g. "biddingStrategy")
    - index - optional; type int
      For list fields, this is a 0-indexed position in the list. Null for non-list fields.
  - trigger - optional; type string
    The data that caused the error.
  - errorString - optional; type string
    A simple string representation of the error and reason.
  List of errors.
A fault element of type ApiException.
getReportJobStatus
Source code
Description:
Returns the {@link ReportJobStatus} of the report job with the specified ID.
Operation type:
Request-response. The endpoint receives a message, and sends a correlated message.
Input:
getReportJobStatusRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
parameters type getReportJobStatus
Returns the {@link ReportJobStatus} of the report job with the specified ID.
- reportJobId - optional; type long
Output:
getReportJobStatusResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
parameters type getReportJobStatusResponse
- rval - optional; type ReportJobStatus - type string with restriction - enum { 'COMPLETED', 'IN_PROGRESS', 'FAILED' }
Fault:
ApiException (wsdlsoap:fault, use = literal)Source code
ApiException type ApiExceptionFault
Exception class for holding a list of service errors.
Base class for exceptions.
- message - optional; type string
  Error message.
- errors - optional, unbounded; type ApiError
  The API error base class that provides details about an error that occurred while processing a service request.
  The OGNL field path is provided for parsers to identify the request data element that may have caused the error.
  - fieldPath - optional; type string
    The OGNL field path to identify cause of error.
  - fieldPathElements - optional, unbounded; type FieldPathElement
    A parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.
    A segment of a field path. Each dot in a field path defines a new segment.
    - field - optional; type string
      The name of a field in lower camelcase. (e.g. "biddingStrategy")
    - index - optional; type int
      For list fields, this is a 0-indexed position in the list. Null for non-list fields.
  - trigger - optional; type string
    The data that caused the error.
  - errorString - optional; type string
    A simple string representation of the error and reason.
  List of errors.
A fault element of type ApiException.

getSavedQueriesByStatement

Source code

Description:

Retrieves a page of the saved queries either created by or shared with the current user. Each {@link SavedQuery} in the page, if it is compatible with the current API version, will contain a {@link ReportQuery} object which can be optionally modified and used to create a {@link ReportJob}. This can then be passed to {@link ReportService#runReportJob}. The following fields are supported for filtering:

PQL Property	Object Property
{@code id}	{@link SavedQuery#id}
{@code name}	{@link SavedQuery#name}

Operation type:

Request-response. The endpoint receives a message, and sends a correlated message.

Input:

getSavedQueriesByStatementRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code

parameters type getSavedQueriesByStatement

PQL Property	Object Property
{@code id}	{@link SavedQuery#id}
{@code name}	{@link SavedQuery#name}

filterStatement - optional; type Statement
Captures the {@code WHERE}, {@code ORDER BY} and {@code LIMIT} clauses of a PQL query. Statements are typically used to retrieve objects of a predefined domain type, which makes SELECT clause unnecessary.
An example query text might be {@code "WHERE status = 'ACTIVE' ORDER BY id LIMIT 30"}.

Statements support bind variables. These are substitutes for literals and can be thought of as input parameters to a PQL query.

An example of such a query might be {@code "WHERE id = :idValue"}.

Statements also support use of the LIKE keyword. This provides wildcard string matching.

An example of such a query might be {@code "WHERE name LIKE '%searchString%'"}.
The value for the variable idValue must then be set with an object of type {@link Value}, e.g., {@link NumberValue}, {@link TextValue} or {@link BooleanValue}.
- query - optional; type string
 Holds the query in PQL syntax. The syntax is:
 [WHERE {[AND | OR] ...}]
 [ORDER BY [ASC | DESC]]
 [LIMIT {[,] } | { OFFSET }]
 
 := {< | <= | > | >= | = | != }
 
 := {< | <= | > | >= | = | != }
 := IN
 := IS NULL
 := LIKE
 := :
- values - optional, unbounded; type String_ValueMapEntry
 Holds keys and values for bind variables and their values. The key is the name of the bind variable. The value is the literal value of the variable.
 In the example {@code "WHERE status = :bindStatus ORDER BY id LIMIT 30"}, the bind variable, represented by {@code :bindStatus} is named {@code bindStatus}, which would also be the parameter map key. The bind variable's value would be represented by a parameter map value of type {@link TextValue}. The final result, for example, would be an entry of {@code "bindStatus" => StringParam("ACTIVE")}.
 This represents an entry in a map with a key of type String and value of type Value.
 - key - optional; type string
 - value - optional; type Value
 {@code Value} represents a value.

Output:

getSavedQueriesByStatementResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code

parameters type getSavedQueriesByStatementResponse

rval - optional; type SavedQueryPage

A page of {@link SavedQuery} objects.

totalResultSetSize - optional; type int
The size of the total result set to which this page belongs.
startIndex - optional; type int
The absolute index in the total result set on which this page begins.

results - optional, unbounded; type SavedQuery

A saved {@link ReportQuery} representing the selection criteria for running a report.

id - optional; type long
The ID of the saved query.
name - optional; type string
The name of the saved query.

reportQuery - optional; type ReportQuery

A {@code ReportQuery} object allows you to specify the selection criteria for generating a report. Only reports with at least one {@link Column} are supported.

dimensions - optional, unbounded; type Dimension - type string with restriction - enum { 'MONTH_AND_YEAR', 'WEEK', 'DATE', 'DAY', 'HOUR', 'DATE_PT', 'WEEK_PT', 'MONTH_YEAR_PT', 'DAY_OF_WEEK_PT', 'LINE_ITEM_ID', 'LINE_ITEM_NAME', 'LINE_ITEM_TYPE', 'ORDER_ID', 'ORDER_NAME', 'ORDER_DELIVERY_STATUS', 'ADVERTISER_ID', 'ADVERTISER_NAME', 'AD_NETWORK_ID', 'AD_NETWORK_NAME', 'SALESPERSON_ID', 'SALESPERSON_NAME', 'CREATIVE_ID', 'CREATIVE_NAME', 'CREATIVE_TYPE', 'CREATIVE_BILLING_TYPE', 'CUSTOM_EVENT_ID', 'CUSTOM_EVENT_NAME', 'CUSTOM_EVENT_TYPE', 'CREATIVE_SIZE', 'AD_UNIT_ID', 'AD_UNIT_NAME', 'PARENT_AD_UNIT_ID', 'PARENT_AD_UNIT_NAME', 'PLACEMENT_ID', 'PLACEMENT_NAME', 'PLACEMENT_STATUS', 'TARGETING', 'BROWSER_NAME', 'DEVICE_CATEGORY_ID', 'DEVICE_CATEGORY_NAME', 'COUNTRY_CRITERIA_ID', 'COUNTRY_CODE', 'COUNTRY_NAME', 'REGION_CRITERIA_ID', 'REGION_NAME', 'CITY_CRITERIA_ID', 'CITY_NAME', 'METRO_CRITERIA_ID', 'METRO_NAME', 'POSTAL_CODE_CRITERIA_ID', 'POSTAL_CODE', 'CUSTOM_TARGETING_VALUE_ID', 'CUSTOM_CRITERIA', 'CONTENT_ID', 'CONTENT_NAME', 'CONTENT_BUNDLE_ID', 'CONTENT_BUNDLE_NAME', 'CMS_METADATA', 'VIDEO_FALLBACK_POSITION', 'POSITION_OF_POD', 'POSITION_IN_POD', 'CUSTOM_SPOT_ID', 'CUSTOM_SPOT_NAME', 'VIDEO_REDIRECT_THIRD_PARTY', 'VIDEO_BREAK_TYPE', 'VIDEO_BREAK_TYPE_NAME', 'VIDEO_VAST_VERSION', 'VIDEO_AD_REQUEST_DURATION_ID', 'VIDEO_AD_REQUEST_DURATION', 'VIDEO_PLCMT_ID', 'VIDEO_PLCMT_NAME', 'INVENTORY_FORMAT', 'INVENTORY_FORMAT_NAME', 'PARTNER_MANAGEMENT_PARTNER_ID', 'PARTNER_MANAGEMENT_PARTNER_NAME', 'PARTNER_MANAGEMENT_PARTNER_LABEL_ID', 'PARTNER_MANAGEMENT_PARTNER_LABEL_NAME', 'PARTNER_MANAGEMENT_ASSIGNMENT_ID', 'PARTNER_MANAGEMENT_ASSIGNMENT_NAME', 'INVENTORY_SHARE_ASSIGNMENT_ID', 'INVENTORY_SHARE_ASSIGNMENT_NAME', 'INVENTORY_SHARE_OUTCOME', 'GRP_DEMOGRAPHICS', 'AD_REQUEST_AD_UNIT_SIZES', 'AD_REQUEST_CUSTOM_CRITERIA', 'IS_FIRST_LOOK_DEAL', 'IS_ADX_DIRECT', 'YIELD_GROUP_ID', 'YIELD_GROUP_NAME', 'YIELD_PARTNER', 'YIELD_PARTNER_TAG', 'EXCHANGE_BIDDING_DEAL_ID', 'EXCHANGE_BIDDING_DEAL_TYPE', 'CLASSIFIED_ADVERTISER_ID', 'CLASSIFIED_ADVERTISER_NAME', 'CLASSIFIED_BRAND_ID', 'CLASSIFIED_BRAND_NAME', 'MEDIATION_TYPE', 'NATIVE_TEMPLATE_ID', 'NATIVE_TEMPLATE_NAME', 'NATIVE_STYLE_ID', 'NATIVE_STYLE_NAME', 'CHILD_NETWORK_CODE', 'MOBILE_APP_RESOLVED_ID', 'MOBILE_APP_NAME', 'MOBILE_DEVICE_NAME', 'MOBILE_INVENTORY_TYPE', 'OPERATING_SYSTEM_VERSION_ID', 'OPERATING_SYSTEM_VERSION_NAME', 'REQUEST_TYPE', 'AD_UNIT_STATUS', 'MASTER_COMPANION_CREATIVE_ID', 'MASTER_COMPANION_CREATIVE_NAME', 'AUDIENCE_SEGMENT_ID', 'AUDIENCE_SEGMENT_NAME', 'AUDIENCE_SEGMENT_DATA_PROVIDER_NAME', 'WEB_PROPERTY_CODE', 'BUYING_AGENCY_NAME', 'BUYER_NETWORK_ID', 'BUYER_NETWORK_NAME', 'BIDDER_ID', 'BIDDER_NAME', 'ADVERTISER_DOMAIN_NAME', 'AD_EXCHANGE_OPTIMIZATION_TYPE', 'ADVERTISER_VERTICAL_NAME', 'NIELSEN_SEGMENT', 'NIELSEN_DEMOGRAPHICS', 'NIELSEN_RESTATEMENT_DATE', 'NIELSEN_DEVICE_ID', 'NIELSEN_DEVICE_NAME', 'PROGRAMMATIC_BUYER_ID', 'PROGRAMMATIC_BUYER_NAME', 'REQUESTED_AD_SIZES', 'CREATIVE_SIZE_DELIVERED', 'PROGRAMMATIC_CHANNEL_ID', 'PROGRAMMATIC_CHANNEL_NAME', 'CLASSIFIED_YIELD_PARTNER_NAME', 'DP_DATE', 'DP_WEEK', 'DP_MONTH_YEAR', 'DP_COUNTRY_CRITERIA_ID', 'DP_COUNTRY_NAME', 'DP_INVENTORY_TYPE', 'DP_CREATIVE_SIZE', 'DP_BRAND_NAME', 'DP_ADVERTISER_NAME', 'DP_ADX_BUYER_NETWORK_NAME', 'DP_MOBILE_DEVICE_NAME', 'DP_DEVICE_CATEGORY_NAME', 'DP_TAG_ID', 'DP_DEAL_ID', 'DP_APP_ID', 'CUSTOM_DIMENSION', 'DEMAND_CHANNEL_ID', 'DEMAND_CHANNEL_NAME', 'DOMAIN', 'SERVING_RESTRICTION_ID', 'SERVING_RESTRICTION_NAME', 'UNIFIED_PRICING_RULE_ID', 'UNIFIED_PRICING_RULE_NAME', 'FIRST_LOOK_PRICING_RULE_ID', 'FIRST_LOOK_PRICING_RULE_NAME', 'BID_RANGE', 'BID_REJECTION_REASON', 'BID_REJECTION_REASON_NAME', 'AD_TECHNOLOGY_PROVIDER_DOMAIN', 'PROGRAMMATIC_DEAL_ID', 'PROGRAMMATIC_DEAL_NAME', 'AD_TECHNOLOGY_PROVIDER_ID', 'AD_TECHNOLOGY_PROVIDER_NAME', 'TCF_VENDOR_ID', 'TCF_VENDOR_NAME', 'SITE_NAME', 'CHANNEL_NAME', 'URL_ID', 'URL_NAME', 'VIDEO_AD_DURATION', 'VIDEO_AD_TYPE_ID', 'VIDEO_AD_TYPE_NAME', 'AD_EXCHANGE_PRODUCT_CODE', 'AD_EXCHANGE_PRODUCT_NAME', 'DYNAMIC_ALLOCATION_ID', 'DYNAMIC_ALLOCATION_NAME', 'AD_TYPE_ID', 'AD_TYPE_NAME', 'AD_LOCATION_ID', 'AD_LOCATION_NAME', 'TARGETING_TYPE_CODE', 'TARGETING_TYPE_NAME', 'BRANDING_TYPE_CODE', 'BRANDING_TYPE_NAME', 'BANDWIDTH_ID', 'BANDWIDTH_NAME', 'CARRIER_ID', 'CARRIER_NAME' }
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.
adUnitView - optional; type ReportQuery.AdUnitView - type string with restriction - enum { 'TOP_LEVEL', 'FLAT', 'HIERARCHICAL' }
The ad unit view for the report. Defaults to {@link AdUnitView#TOP_LEVEL}.
columns - optional, unbounded; type Column - type string with restriction - enum { 'AD_SERVER_IMPRESSIONS', 'AD_SERVER_BEGIN_TO_RENDER_IMPRESSIONS', 'AD_SERVER_TARGETED_IMPRESSIONS', 'AD_SERVER_CLICKS', 'AD_SERVER_TARGETED_CLICKS', 'AD_SERVER_CTR', 'AD_SERVER_CPM_AND_CPC_REVENUE', 'AD_SERVER_CPM_AND_CPC_REVENUE_GROSS', 'AD_SERVER_CPD_REVENUE', 'AD_SERVER_ALL_REVENUE', 'AD_SERVER_ALL_REVENUE_GROSS', 'AD_SERVER_WITHOUT_CPD_AVERAGE_ECPM', 'AD_SERVER_WITH_CPD_AVERAGE_ECPM', 'AD_SERVER_LINE_ITEM_LEVEL_PERCENT_IMPRESSIONS', 'AD_SERVER_LINE_ITEM_LEVEL_PERCENT_CLICKS', 'AD_SERVER_LINE_ITEM_LEVEL_WITHOUT_CPD_PERCENT_REVENUE', 'AD_SERVER_LINE_ITEM_LEVEL_WITH_CPD_PERCENT_REVENUE', 'AD_SERVER_UNFILTERED_IMPRESSIONS', 'AD_SERVER_UNFILTERED_BEGIN_TO_RENDER_IMPRESSIONS', 'AD_SERVER_UNFILTERED_CLICKS', 'ADSENSE_LINE_ITEM_LEVEL_IMPRESSIONS', 'ADSENSE_LINE_ITEM_LEVEL_TARGETED_IMPRESSIONS', 'ADSENSE_LINE_ITEM_LEVEL_CLICKS', 'ADSENSE_LINE_ITEM_LEVEL_TARGETED_CLICKS', 'ADSENSE_LINE_ITEM_LEVEL_CTR', 'ADSENSE_LINE_ITEM_LEVEL_REVENUE', 'ADSENSE_LINE_ITEM_LEVEL_AVERAGE_ECPM', 'ADSENSE_LINE_ITEM_LEVEL_PERCENT_IMPRESSIONS', 'ADSENSE_LINE_ITEM_LEVEL_PERCENT_CLICKS', 'ADSENSE_LINE_ITEM_LEVEL_WITHOUT_CPD_PERCENT_REVENUE', 'ADSENSE_LINE_ITEM_LEVEL_WITH_CPD_PERCENT_REVENUE', 'AD_EXCHANGE_LINE_ITEM_LEVEL_IMPRESSIONS', 'BID_COUNT', 'BID_AVERAGE_CPM', 'YIELD_GROUP_CALLOUTS', 'YIELD_GROUP_SUCCESSFUL_RESPONSES', 'YIELD_GROUP_BIDS', 'YIELD_GROUP_BIDS_IN_AUCTION', 'YIELD_GROUP_AUCTIONS_WON', 'DEALS_BID_REQUESTS', 'DEALS_BIDS', 'DEALS_BID_RATE', 'DEALS_WINNING_BIDS', 'DEALS_WIN_RATE', 'YIELD_GROUP_IMPRESSIONS', 'YIELD_GROUP_ESTIMATED_REVENUE', 'YIELD_GROUP_ESTIMATED_CPM', 'YIELD_GROUP_MEDIATION_FILL_RATE', 'YIELD_GROUP_MEDIATION_PASSBACKS', 'YIELD_GROUP_MEDIATION_THIRD_PARTY_ECPM', 'YIELD_GROUP_MEDIATION_CHAINS_SERVED', 'MEDIATION_THIRD_PARTY_ECPM', 'AD_EXCHANGE_LINE_ITEM_LEVEL_TARGETED_IMPRESSIONS', 'AD_EXCHANGE_LINE_ITEM_LEVEL_CLICKS', 'AD_EXCHANGE_LINE_ITEM_LEVEL_TARGETED_CLICKS', 'AD_EXCHANGE_LINE_ITEM_LEVEL_CTR', 'AD_EXCHANGE_LINE_ITEM_LEVEL_PERCENT_IMPRESSIONS', 'AD_EXCHANGE_LINE_ITEM_LEVEL_PERCENT_CLICKS', 'AD_EXCHANGE_LINE_ITEM_LEVEL_REVENUE', 'AD_EXCHANGE_LINE_ITEM_LEVEL_WITHOUT_CPD_PERCENT_REVENUE', 'AD_EXCHANGE_LINE_ITEM_LEVEL_WITH_CPD_PERCENT_REVENUE', 'AD_EXCHANGE_LINE_ITEM_LEVEL_AVERAGE_ECPM', 'TOTAL_LINE_ITEM_LEVEL_IMPRESSIONS', 'TOTAL_LINE_ITEM_LEVEL_TARGETED_IMPRESSIONS', 'TOTAL_LINE_ITEM_LEVEL_CLICKS', 'TOTAL_LINE_ITEM_LEVEL_TARGETED_CLICKS', 'TOTAL_LINE_ITEM_LEVEL_CTR', 'TOTAL_LINE_ITEM_LEVEL_CPM_AND_CPC_REVENUE', 'TOTAL_LINE_ITEM_LEVEL_ALL_REVENUE', 'TOTAL_LINE_ITEM_LEVEL_WITHOUT_CPD_AVERAGE_ECPM', 'TOTAL_LINE_ITEM_LEVEL_WITH_CPD_AVERAGE_ECPM', 'TOTAL_CODE_SERVED_COUNT', 'TOTAL_AD_REQUESTS', 'TOTAL_RESPONSES_SERVED', 'TOTAL_UNMATCHED_AD_REQUESTS', 'TOTAL_FILL_RATE', 'AD_SERVER_RESPONSES_SERVED', 'ADSENSE_RESPONSES_SERVED', 'AD_EXCHANGE_RESPONSES_SERVED', 'PROGRAMMATIC_RESPONSES_SERVED', 'PROGRAMMATIC_MATCH_RATE', 'TOTAL_PROGRAMMATIC_ELIGIBLE_AD_REQUESTS', 'TOTAL_VIDEO_OPPORTUNITIES', 'TOTAL_VIDEO_CAPPED_OPPORTUNITIES', 'TOTAL_VIDEO_MATCHED_OPPORTUNITIES', 'TOTAL_VIDEO_MATCHED_DURATION', 'TOTAL_VIDEO_DURATION', 'TOTAL_VIDEO_BREAK_START', 'TOTAL_VIDEO_BREAK_END', 'TOTAL_INVENTORY_LEVEL_UNFILLED_IMPRESSIONS', 'UNIQUE_REACH_FREQUENCY', 'UNIQUE_REACH_IMPRESSIONS', 'UNIQUE_REACH', 'SDK_MEDIATION_CREATIVE_IMPRESSIONS', 'SDK_MEDIATION_CREATIVE_CLICKS', 'SELL_THROUGH_FORECASTED_IMPRESSIONS', 'PARTNER_SALES_PARTNER_IMPRESSIONS', 'PARTNER_SALES_PARTNER_CODE_SERVED', 'PARTNER_SALES_GOOGLE_IMPRESSIONS', 'PARTNER_SALES_GOOGLE_RESERVATION_IMPRESSIONS', 'PARTNER_SALES_GOOGLE_AUCTION_IMPRESSIONS', 'PARTNER_SALES_QUERIES', 'PARTNER_SALES_FILLED_QUERIES', 'PARTNER_SALES_SELL_THROUGH_RATE', 'SELL_THROUGH_AVAILABLE_IMPRESSIONS', 'SELL_THROUGH_RESERVED_IMPRESSIONS', 'SELL_THROUGH_SELL_THROUGH_RATE', 'RICH_MEDIA_BACKUP_IMAGES', 'RICH_MEDIA_DISPLAY_TIME', 'RICH_MEDIA_AVERAGE_DISPLAY_TIME', 'RICH_MEDIA_EXPANSIONS', 'RICH_MEDIA_EXPANDING_TIME', 'RICH_MEDIA_INTERACTION_TIME', 'RICH_MEDIA_INTERACTION_COUNT', 'RICH_MEDIA_INTERACTION_RATE', 'RICH_MEDIA_AVERAGE_INTERACTION_TIME', 'RICH_MEDIA_INTERACTION_IMPRESSIONS', 'RICH_MEDIA_MANUAL_CLOSES', 'RICH_MEDIA_FULL_SCREEN_IMPRESSIONS', 'RICH_MEDIA_VIDEO_INTERACTIONS', 'RICH_MEDIA_VIDEO_INTERACTION_RATE', 'RICH_MEDIA_VIDEO_MUTES', 'RICH_MEDIA_VIDEO_PAUSES', 'RICH_MEDIA_VIDEO_PLAYES', 'RICH_MEDIA_VIDEO_MIDPOINTS', 'RICH_MEDIA_VIDEO_COMPLETES', 'RICH_MEDIA_VIDEO_REPLAYS', 'RICH_MEDIA_VIDEO_STOPS', 'RICH_MEDIA_VIDEO_UNMUTES', 'RICH_MEDIA_VIDEO_VIEW_TIME', 'RICH_MEDIA_VIDEO_VIEW_RATE', 'RICH_MEDIA_CUSTOM_EVENT_TIME', 'RICH_MEDIA_CUSTOM_EVENT_COUNT', 'VIDEO_VIEWERSHIP_START', 'VIDEO_VIEWERSHIP_FIRST_QUARTILE', 'VIDEO_VIEWERSHIP_MIDPOINT', 'VIDEO_VIEWERSHIP_THIRD_QUARTILE', 'VIDEO_VIEWERSHIP_COMPLETE', 'VIDEO_VIEWERSHIP_AVERAGE_VIEW_RATE', 'VIDEO_VIEWERSHIP_AVERAGE_VIEW_TIME', 'VIDEO_VIEWERSHIP_COMPLETION_RATE', 'VIDEO_VIEWERSHIP_TOTAL_ERROR_COUNT', 'VIDEO_VIEWERSHIP_VIDEO_LENGTH', 'VIDEO_VIEWERSHIP_SKIP_BUTTON_SHOWN', 'VIDEO_VIEWERSHIP_ENGAGED_VIEW', 'VIDEO_VIEWERSHIP_VIEW_THROUGH_RATE', 'VIDEO_VIEWERSHIP_AUTO_PLAYS', 'VIDEO_VIEWERSHIP_CLICK_TO_PLAYS', 'VIDEO_VIEWERSHIP_TOTAL_ERROR_RATE', 'DROPOFF_RATE', 'VIDEO_TRUEVIEW_VIEWS', 'VIDEO_TRUEVIEW_SKIP_RATE', 'VIDEO_TRUEVIEW_VTR', 'VIDEO_ERRORS_VAST_ERROR_100_COUNT', 'VIDEO_ERRORS_VAST_ERROR_101_COUNT', 'VIDEO_ERRORS_VAST_ERROR_102_COUNT', 'VIDEO_ERRORS_VAST_ERROR_200_COUNT', 'VIDEO_ERRORS_VAST_ERROR_201_COUNT', 'VIDEO_ERRORS_VAST_ERROR_202_COUNT', 'VIDEO_ERRORS_VAST_ERROR_203_COUNT', 'VIDEO_ERRORS_VAST_ERROR_300_COUNT', 'VIDEO_ERRORS_VAST_ERROR_301_COUNT', 'VIDEO_ERRORS_VAST_ERROR_302_COUNT', 'VIDEO_ERRORS_VAST_ERROR_303_COUNT', 'VIDEO_ERRORS_VAST_ERROR_400_COUNT', 'VIDEO_ERRORS_VAST_ERROR_401_COUNT', 'VIDEO_ERRORS_VAST_ERROR_402_COUNT', 'VIDEO_ERRORS_VAST_ERROR_403_COUNT', 'VIDEO_ERRORS_VAST_ERROR_405_COUNT', 'VIDEO_ERRORS_VAST_ERROR_500_COUNT', 'VIDEO_ERRORS_VAST_ERROR_501_COUNT', 'VIDEO_ERRORS_VAST_ERROR_502_COUNT', 'VIDEO_ERRORS_VAST_ERROR_503_COUNT', 'VIDEO_ERRORS_VAST_ERROR_600_COUNT', 'VIDEO_ERRORS_VAST_ERROR_601_COUNT', 'VIDEO_ERRORS_VAST_ERROR_602_COUNT', 'VIDEO_ERRORS_VAST_ERROR_603_COUNT', 'VIDEO_ERRORS_VAST_ERROR_604_COUNT', 'VIDEO_ERRORS_VAST_ERROR_900_COUNT', 'VIDEO_ERRORS_VAST_ERROR_901_COUNT', 'VIDEO_INTERACTION_PAUSE', 'VIDEO_INTERACTION_RESUME', 'VIDEO_INTERACTION_REWIND', 'VIDEO_INTERACTION_MUTE', 'VIDEO_INTERACTION_UNMUTE', 'VIDEO_INTERACTION_COLLAPSE', 'VIDEO_INTERACTION_EXPAND', 'VIDEO_INTERACTION_FULL_SCREEN', 'VIDEO_INTERACTION_AVERAGE_INTERACTION_RATE', 'VIDEO_INTERACTION_VIDEO_SKIPS', 'VIDEO_OPTIMIZATION_CONTROL_STARTS', 'VIDEO_OPTIMIZATION_OPTIMIZED_STARTS', 'VIDEO_OPTIMIZATION_CONTROL_COMPLETES', 'VIDEO_OPTIMIZATION_OPTIMIZED_COMPLETES', 'VIDEO_OPTIMIZATION_CONTROL_COMPLETION_RATE', 'VIDEO_OPTIMIZATION_OPTIMIZED_COMPLETION_RATE', 'VIDEO_OPTIMIZATION_COMPLETION_RATE_LIFT', 'VIDEO_OPTIMIZATION_CONTROL_SKIP_BUTTON_SHOWN', 'VIDEO_OPTIMIZATION_OPTIMIZED_SKIP_BUTTON_SHOWN', 'VIDEO_OPTIMIZATION_CONTROL_ENGAGED_VIEW', 'VIDEO_OPTIMIZATION_OPTIMIZED_ENGAGED_VIEW', 'VIDEO_OPTIMIZATION_CONTROL_VIEW_THROUGH_RATE', 'VIDEO_OPTIMIZATION_OPTIMIZED_VIEW_THROUGH_RATE', 'VIDEO_OPTIMIZATION_VIEW_THROUGH_RATE_LIFT', 'VIDEO_IMPRESSIONS_REAL_TIME', 'VIDEO_MATCHED_QUERIES_REAL_TIME', 'VIDEO_UNMATCHED_QUERIES_REAL_TIME', 'VIDEO_TOTAL_QUERIES_REAL_TIME', 'VIDEO_CREATIVE_SERVE_REAL_TIME', 'VIDEO_VAST3_ERROR_100_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_101_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_102_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_200_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_201_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_202_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_203_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_300_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_301_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_302_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_303_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_400_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_401_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_402_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_403_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_405_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_500_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_501_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_502_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_503_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_600_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_601_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_602_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_603_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_604_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_900_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_901_COUNT_REAL_TIME', 'VIDEO_VAST4_ERROR_406_COUNT_REAL_TIME', 'VIDEO_VAST4_ERROR_407_COUNT_REAL_TIME', 'VIDEO_VAST4_ERROR_408_COUNT_REAL_TIME', 'VIDEO_VAST4_ERROR_409_COUNT_REAL_TIME', 'VIDEO_VAST4_ERROR_410_COUNT_REAL_TIME', 'VIDEO_VAST_TOTAL_ERROR_COUNT_REAL_TIME', 'TOTAL_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS', 'TOTAL_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS', 'TOTAL_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS_RATE', 'TOTAL_ACTIVE_VIEW_ELIGIBLE_IMPRESSIONS', 'TOTAL_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS_RATE', 'TOTAL_ACTIVE_VIEW_AVERAGE_VIEWABLE_TIME', 'ACTIVE_VIEW_PERCENT_AUDIBLE_START_IMPRESSIONS', 'ACTIVE_VIEW_PERCENT_EVER_AUDIBLE_IMPRESSIONS', 'AD_SERVER_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS', 'AD_SERVER_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS', 'AD_SERVER_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS_RATE', 'AD_SERVER_ACTIVE_VIEW_ELIGIBLE_IMPRESSIONS', 'AD_SERVER_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS_RATE', 'AD_SERVER_ACTIVE_VIEW_REVENUE', 'AD_SERVER_ACTIVE_VIEW_AVERAGE_VIEWABLE_TIME', 'ADSENSE_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS', 'ADSENSE_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS', 'ADSENSE_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS_RATE', 'ADSENSE_ACTIVE_VIEW_ELIGIBLE_IMPRESSIONS', 'ADSENSE_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS_RATE', 'ADSENSE_ACTIVE_VIEW_AVERAGE_VIEWABLE_TIME', 'AD_EXCHANGE_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS', 'AD_EXCHANGE_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS', 'AD_EXCHANGE_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS_RATE', 'AD_EXCHANGE_ACTIVE_VIEW_ELIGIBLE_IMPRESSIONS', 'AD_EXCHANGE_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS_RATE', 'AD_EXCHANGE_ACTIVE_VIEW_AVERAGE_VIEWABLE_TIME', 'AD_EXCHANGE_TOTAL_REQUESTS', 'AD_EXCHANGE_MATCH_RATE', 'AD_EXCHANGE_COST_PER_CLICK', 'AD_EXCHANGE_TOTAL_REQUEST_CTR', 'AD_EXCHANGE_MATCHED_REQUEST_CTR', 'AD_EXCHANGE_TOTAL_REQUEST_ECPM', 'AD_EXCHANGE_MATCHED_REQUEST_ECPM', 'AD_EXCHANGE_LIFT_EARNINGS', 'TOTAL_ACTIVE_VIEW_REVENUE', 'DYNAMIC_ALLOCATION_OPPORTUNITY_IMPRESSIONS_COMPETING_TOTAL', 'DYNAMIC_ALLOCATION_OPPORTUNITY_UNFILLED_IMPRESSIONS_COMPETING', 'DYNAMIC_ALLOCATION_OPPORTUNITY_ELIGIBLE_IMPRESSIONS_TOTAL', 'DYNAMIC_ALLOCATION_OPPORTUNITY_IMPRESSIONS_NOT_COMPETING_TOTAL', 'DYNAMIC_ALLOCATION_OPPORTUNITY_IMPRESSIONS_NOT_COMPETING_PERCENT_TOTAL', 'DYNAMIC_ALLOCATION_OPPORTUNITY_SATURATION_RATE_TOTAL', 'DYNAMIC_ALLOCATION_OPPORTUNITY_MATCH_RATE_TOTAL', 'INVOICED_IMPRESSIONS', 'INVOICED_UNFILLED_IMPRESSIONS', 'NIELSEN_IMPRESSIONS', 'NIELSEN_IN_TARGET_IMPRESSIONS', 'NIELSEN_POPULATION_BASE', 'NIELSEN_IN_TARGET_POPULATION_BASE', 'NIELSEN_UNIQUE_AUDIENCE', 'NIELSEN_IN_TARGET_UNIQUE_AUDIENCE', 'NIELSEN_PERCENT_AUDIENCE_REACH', 'NIELSEN_IN_TARGET_PERCENT_AUDIENCE_REACH', 'NIELSEN_AVERAGE_FREQUENCY', 'NIELSEN_IN_TARGET_AVERAGE_FREQUENCY', 'NIELSEN_GROSS_RATING_POINTS', 'NIELSEN_IN_TARGET_GROSS_RATING_POINTS', 'NIELSEN_PERCENT_IMPRESSIONS_SHARE', 'NIELSEN_IN_TARGET_PERCENT_IMPRESSIONS_SHARE', 'NIELSEN_PERCENT_POPULATION_SHARE', 'NIELSEN_IN_TARGET_PERCENT_POPULATION_SHARE', 'NIELSEN_PERCENT_AUDIENCE_SHARE', 'NIELSEN_IN_TARGET_PERCENT_AUDIENCE_SHARE', 'NIELSEN_AUDIENCE_INDEX', 'NIELSEN_IN_TARGET_AUDIENCE_INDEX', 'NIELSEN_IMPRESSIONS_INDEX', 'NIELSEN_IN_TARGET_IMPRESSIONS_INDEX', 'NIELSEN_IN_TARGET_RATIO', 'DP_IMPRESSIONS', 'DP_CLICKS', 'DP_QUERIES', 'DP_MATCHED_QUERIES', 'DP_COST', 'DP_ECPM', 'DP_ACTIVE_VIEW_ELIGIBLE_IMPRESSIONS', 'DP_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS', 'DP_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS', 'DP_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS_RATE', 'DP_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS_RATE', 'PARTNER_MANAGEMENT_HOST_IMPRESSIONS', 'PARTNER_MANAGEMENT_HOST_CLICKS', 'PARTNER_MANAGEMENT_HOST_CTR', 'PARTNER_MANAGEMENT_UNFILLED_IMPRESSIONS', 'PARTNER_MANAGEMENT_PARTNER_IMPRESSIONS', 'PARTNER_MANAGEMENT_PARTNER_CLICKS', 'PARTNER_MANAGEMENT_PARTNER_CTR', 'PARTNER_MANAGEMENT_GROSS_REVENUE', 'PARTNER_FINANCE_HOST_IMPRESSIONS', 'PARTNER_FINANCE_HOST_REVENUE', 'PARTNER_FINANCE_HOST_ECPM', 'PARTNER_FINANCE_PARTNER_REVENUE', 'PARTNER_FINANCE_PARTNER_ECPM', 'PARTNER_FINANCE_GROSS_REVENUE', 'CREATIVE_LOAD_TIME_0_500_MS_PERCENT', 'CREATIVE_LOAD_TIME_500_1000_MS_PERCENT', 'CREATIVE_LOAD_TIME_1_2_S_PERCENT', 'CREATIVE_LOAD_TIME_2_4_S_PERCENT', 'CREATIVE_LOAD_TIME_4_8_S_PERCENT', 'CREATIVE_LOAD_TIME_GREATER_THAN_8_S_PERCENT', 'UNVIEWED_REASON_SLOT_NEVER_ENTERED_VIEWPORT_PERCENT', 'UNVIEWED_REASON_USER_SCROLLED_BEFORE_AD_FILLED_PERCENT', 'UNVIEWED_REASON_USER_SCROLLED_BEFORE_AD_LOADED_PERCENT', 'UNVIEWED_REASON_USER_SCROLLED_BEFORE_1_S_PERCENT', 'UNVIEWED_REASON_OTHER_PERCENT', 'PAGE_NAVIGATION_TO_TAG_LOADED_TIME_0_500_MS_PERCENT', 'PAGE_NAVIGATION_TO_TAG_LOADED_TIME_500_1000_MS_PERCENT', 'PAGE_NAVIGATION_TO_TAG_LOADED_TIME_1_2_S_PERCENT', 'PAGE_NAVIGATION_TO_TAG_LOADED_TIME_2_4_S_PERCENT', 'PAGE_NAVIGATION_TO_TAG_LOADED_TIME_4_8_S_PERCENT', 'PAGE_NAVIGATION_TO_TAG_LOADED_TIME_GREATER_THAN_8_S_PERCENT', 'PAGE_NAVIGATION_TO_FIRST_AD_REQUEST_TIME_0_500_MS_PERCENT', 'PAGE_NAVIGATION_TO_FIRST_AD_REQUEST_TIME_500_1000_MS_PERCENT', 'PAGE_NAVIGATION_TO_FIRST_AD_REQUEST_TIME_1_2_S_PERCENT', 'PAGE_NAVIGATION_TO_FIRST_AD_REQUEST_TIME_2_4_S_PERCENT', 'PAGE_NAVIGATION_TO_FIRST_AD_REQUEST_TIME_4_8_S_PERCENT', 'PAGE_NAVIGATION_TO_FIRST_AD_REQUEST_TIME_GREATER_THAN_8_S_PERCENT', 'TAG_LOAD_TO_FIRST_AD_REQUEST_TIME_0_500_MS_PERCENT', 'TAG_LOAD_TO_FIRST_AD_REQUEST_TIME_500_1000_MS_PERCENT', 'TAG_LOAD_TO_FIRST_AD_REQUEST_TIME_1_2_S_PERCENT', 'TAG_LOAD_TO_FIRST_AD_REQUEST_TIME_2_4_S_PERCENT', 'TAG_LOAD_TO_FIRST_AD_REQUEST_TIME_4_8_S_PERCENT', 'TAG_LOAD_TO_FIRST_AD_REQUEST_TIME_GREATER_THAN_8_S_PERCENT' }
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.
dimensionAttributes - optional, unbounded; type DimensionAttribute - type string with restriction - enum { 'LINE_ITEM_LABELS', 'LINE_ITEM_LABEL_IDS', 'LINE_ITEM_OPTIMIZABLE', 'LINE_ITEM_DELIVERY_INDICATOR', 'LINE_ITEM_DELIVERY_PACING', 'LINE_ITEM_FREQUENCY_CAP', 'LINE_ITEM_RECONCILIATION_STATUS', 'LINE_ITEM_LAST_RECONCILIATION_DATE_TIME', 'ADVERTISER_EXTERNAL_ID', 'ADVERTISER_TYPE', 'ADVERTISER_CREDIT_STATUS', 'ADVERTISER_PRIMARY_CONTACT', 'ORDER_START_DATE_TIME', 'ORDER_END_DATE_TIME', 'ORDER_EXTERNAL_ID', 'ORDER_PO_NUMBER', 'ORDER_IS_PROGRAMMATIC', 'ORDER_AGENCY', 'ORDER_AGENCY_ID', 'ORDER_LABELS', 'ORDER_LABEL_IDS', 'ORDER_TRAFFICKER', 'ORDER_TRAFFICKER_ID', 'ORDER_SECONDARY_TRAFFICKERS', 'ORDER_SALESPERSON', 'ORDER_SECONDARY_SALESPEOPLE', 'ORDER_LIFETIME_IMPRESSIONS', 'ORDER_LIFETIME_CLICKS', 'ORDER_BOOKED_CPM', 'ORDER_BOOKED_CPC', 'LINE_ITEM_START_DATE_TIME', 'LINE_ITEM_END_DATE_TIME', 'LINE_ITEM_EXTERNAL_ID', 'LINE_ITEM_COST_TYPE', 'LINE_ITEM_COST_PER_UNIT', 'LINE_ITEM_CURRENCY_CODE', 'LINE_ITEM_GOAL_QUANTITY', 'LINE_ITEM_AVERAGE_NUMBER_OF_VIEWERS', 'LINE_ITEM_SPONSORSHIP_GOAL_PERCENTAGE', 'LINE_ITEM_LIFETIME_IMPRESSIONS', 'LINE_ITEM_LIFETIME_CLICKS', 'LINE_ITEM_PRIORITY', 'LINE_ITEM_COMPUTED_STATUS', 'CREATIVE_OR_CREATIVE_SET', 'MASTER_COMPANION_TYPE', 'LINE_ITEM_CONTRACTED_QUANTITY', 'LINE_ITEM_DISCOUNT', 'LINE_ITEM_NON_CPD_BOOKED_REVENUE', 'ADVERTISER_LABELS', 'ADVERTISER_LABEL_IDS', 'CREATIVE_CLICK_THROUGH_URL', 'CREATIVE_SSL_SCAN_RESULT', 'CREATIVE_SSL_COMPLIANCE_OVERRIDE', 'LINE_ITEM_CREATIVE_START_DATE', 'LINE_ITEM_CREATIVE_END_DATE', 'CONTENT_CMS_NAME', 'CONTENT_CMS_VIDEO_ID', 'CHILD_PARTNER_NAME', 'AD_UNIT_CODE' }
The list of break-down attributes being requested in this report. Some {@link DimensionAttribute} values can only be used with certain {@link Dimension} values that must be included in the {@link #dimensions} attribute. The generated report will contain the attributes in the same order as requested.

customFieldIds - optional, unbounded; type long

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

{@link CustomFieldEntityType#entityType}
{@link CustomFieldEntityType#LINE_ITEM}	{@link Dimension#LINE_ITEM_NAME}
{@link CustomFieldEntityType#ORDER}	{@link Dimension#ORDER_NAME}
{@link CustomFieldEntityType#CREATIVE}	{@link Dimension#CREATIVE_NAME}

cmsMetadataKeyIds - optional, unbounded; type long
The list of content CMS metadata key {@link CmsMetadataKey#id IDs} being requested in this report. Each of these IDs must have been defined in the {@link CmsMetadataKey CMS metadata key}. This will include dimensions in the form of {@code CMS_METADATA_KEY[id]_ID} and {@code CMS_METADATA_KEY[id]_VALUE} where where {@code ID} is the ID of the {@link CmsMetadataValue#id CMS metadata value} and {@code VALUE} is the {@link CmsMetadataValue#valueName name}.
To add {@link CmsMetadataKey#id IDs}, you must include {@link Dimension#CMS_METADATA} in {@link #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 {@link Dimension#CMS_METADATA} in {@link #dimensions}. For example, if {@link #dimensions} contains the following dimensions in the order: {@link Dimension#ADVERTISER_NAME}, {@link Dimension#CMS_METADATA} and {@link Dimension#COUNTRY_NAME}, and {@link #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
customDimensionKeyIds - optional, unbounded; type long
The list of custom dimension custom targeting key {@link CustomTargetingKey#id IDs} being requested in this report. This will include dimensions in the form of {@code TOP_LEVEL_DIMENSION_KEY[id]_ID} and {@code TOP_LEVEL_DIMENSION_KEY[id]_VALUE} where {@code ID} is the ID of the {@link CustomTargetingValue#id custom targeting value} and {@code VALUE} is the {@link CustomTargetingValue#name name}.
To add {@link CustomTargetingKey#id IDs}, you must include {@link Dimension#CUSTOM_DIMENSION} in {@link #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 {@link Dimension#CUSTOM_DIMENSION} in {@link #dimensions}. For example, if {@link #dimensions} contains the following dimensions in the order: {@link Dimension#ADVERTISER_NAME}, {@link Dimension#CUSTOM_DIMENSION} and {@link Dimension#COUNTRY_NAME}, and {@link #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.
startDate - optional; type Date
Represents a date.
- year - optional; type int
  Year (e.g., 2009)
- month - optional; type int
  Month (1..12)
- day - optional; type int
  Day (1..31)
The start date from which the reporting information is gathered. The {@code ReportQuery#dateRangeType} field must be set to {@link DateRangeType#CUSTOM_DATE} in order to use this.
endDate - optional; type Date
Represents a date.
- year - optional; type int
  Year (e.g., 2009)
- month - optional; type int
  Month (1..12)
- day - optional; type int
  Day (1..31)
The end date up to which the reporting information is gathered. The {@code ReportQuery#dateRangeType} field must be set to {@link DateRangeType#CUSTOM_DATE} in order to use this.
dateRangeType - optional; type DateRangeType - type string with restriction - enum { 'TODAY', 'YESTERDAY', 'LAST_WEEK', 'LAST_MONTH', 'LAST_3_MONTHS', 'REACH_LIFETIME', 'CUSTOM_DATE', 'NEXT_DAY', 'NEXT_90_DAYS', 'NEXT_WEEK', 'NEXT_MONTH', 'CURRENT_AND_NEXT_MONTH', 'NEXT_QUARTER', 'NEXT_3_MONTHS', 'NEXT_12_MONTHS' }
The period of time for which the reporting data is being generated. In order to define custom time periods, set this to {@link DateRangeType#CUSTOM_DATE}. If set to {@link DateRangeType#CUSTOM_DATE}, then {@link ReportQuery#startDate} and {@link ReportQuery#endDate} will be used.
statement - optional; type Statement
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 {@link #dateRangeType}, {@link #startDate}, and {@link #endDate}. The syntax currently allowed for {@link Statement#query} is
[WHERE {AND ...}]
:= = := = := IN := : where property is the enumeration name of a {@link 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.
Captures the {@code WHERE}, {@code ORDER BY} and {@code LIMIT} clauses of a PQL query. Statements are typically used to retrieve objects of a predefined domain type, which makes SELECT clause unnecessary.
An example query text might be {@code "WHERE status = 'ACTIVE' ORDER BY id LIMIT 30"}.

Statements support bind variables. These are substitutes for literals and can be thought of as input parameters to a PQL query.

An example of such a query might be {@code "WHERE id = :idValue"}.

Statements also support use of the LIKE keyword. This provides wildcard string matching.

An example of such a query might be {@code "WHERE name LIKE '%searchString%'"}.
The value for the variable idValue must then be set with an object of type {@link Value}, e.g., {@link NumberValue}, {@link TextValue} or {@link BooleanValue}.
- query - optional; type string
 Holds the query in PQL syntax. The syntax is:
 [WHERE {[AND | OR] ...}]
 [ORDER BY [ASC | DESC]]
 [LIMIT {[,] } | { OFFSET }]
 
 := {< | <= | > | >= | = | != }
 
 := {< | <= | > | >= | = | != }
 := IN
 := IS NULL
 := LIKE
 := :
- values - optional, unbounded; type String_ValueMapEntry
 Holds keys and values for bind variables and their values. The key is the name of the bind variable. The value is the literal value of the variable.
 In the example {@code "WHERE status = :bindStatus ORDER BY id LIMIT 30"}, the bind variable, represented by {@code :bindStatus} is named {@code bindStatus}, which would also be the parameter map key. The bind variable's value would be represented by a parameter map value of type {@link TextValue}. The final result, for example, would be an entry of {@code "bindStatus" => StringParam("ACTIVE")}.
 This represents an entry in a map with a key of type String and value of type Value.
 - key - optional; type string
 - value - optional; type Value
 {@code Value} represents a value.
- reportCurrency - optional; type string
 The currency for revenue metrics. Defaults to the network currency if left {@code null}. The supported currency codes can be found in this Help Center article.
- timeZoneType - optional; type TimeZoneType - type string with restriction - enum { 'UNKNOWN', 'PUBLISHER', 'PACIFIC' }
The {@link ReportQuery} representing the selection criteria for the saved query. This will be non-null if and only if {@link SavedQuery#isCompatibleWithApiVersion} is {@code true}.
isCompatibleWithApiVersion - optional; type boolean
Whether or not the saved query is compatible with the current API version. This will be {@code true} if and only if {@link SavedQuery#reportQuery} is non-null. A saved query will be incompatible with the API if it uses columns, dimensions, or other reporting features from the UI that are not available in the {@link ReportQuery} entity.

The collection of saved queries contained within this page.

Fault:

ApiException (wsdlsoap:fault, use = literal)Source code

ApiException type ApiExceptionFault

Exception class for holding a list of service errors.

Base class for exceptions.

message - optional; type string
Error message.

errors - optional, unbounded; type ApiError
The API error base class that provides details about an error that occurred while processing a service request.
The OGNL field path is provided for parsers to identify the request data element that may have caused the error.
- fieldPath - optional; type string
  The OGNL field path to identify cause of error.
- fieldPathElements - optional, unbounded; type FieldPathElement
  A parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.
  A segment of a field path. Each dot in a field path defines a new segment.
  - field - optional; type string
    The name of a field in lower camelcase. (e.g. "biddingStrategy")
  - index - optional; type int
    For list fields, this is a 0-indexed position in the list. Null for non-list fields.
- trigger - optional; type string
  The data that caused the error.
- errorString - optional; type string
  A simple string representation of the error and reason.
List of errors.

A fault element of type ApiException.

runReportJob

Source code

Description:

Initiates the execution of a {@link ReportQuery} on the server.

The following fields are required:

{@link ReportJob#reportQuery}

Operation type:

Request-response. The endpoint receives a message, and sends a correlated message.

Input:

runReportJobRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code

parameters type runReportJob

Initiates the execution of a {@link ReportQuery} on the server.

The following fields are required:

{@link ReportJob#reportQuery}

reportJob - optional; type ReportJob

Represents a report job that will be run to retrieve performance and statistics information about ad campaigns, networks, inventory and sales.

id - optional; type long
The unique ID of the {@code ReportJob}. This value is read-only and is assigned by Google.

reportQuery - optional; type ReportQuery

Holds the filtering criteria.

A {@code ReportQuery} object allows you to specify the selection criteria for generating a report. Only reports with at least one {@link Column} are supported.

dimensions - optional, unbounded; type Dimension - type string with restriction - enum { 'MONTH_AND_YEAR', 'WEEK', 'DATE', 'DAY', 'HOUR', 'DATE_PT', 'WEEK_PT', 'MONTH_YEAR_PT', 'DAY_OF_WEEK_PT', 'LINE_ITEM_ID', 'LINE_ITEM_NAME', 'LINE_ITEM_TYPE', 'ORDER_ID', 'ORDER_NAME', 'ORDER_DELIVERY_STATUS', 'ADVERTISER_ID', 'ADVERTISER_NAME', 'AD_NETWORK_ID', 'AD_NETWORK_NAME', 'SALESPERSON_ID', 'SALESPERSON_NAME', 'CREATIVE_ID', 'CREATIVE_NAME', 'CREATIVE_TYPE', 'CREATIVE_BILLING_TYPE', 'CUSTOM_EVENT_ID', 'CUSTOM_EVENT_NAME', 'CUSTOM_EVENT_TYPE', 'CREATIVE_SIZE', 'AD_UNIT_ID', 'AD_UNIT_NAME', 'PARENT_AD_UNIT_ID', 'PARENT_AD_UNIT_NAME', 'PLACEMENT_ID', 'PLACEMENT_NAME', 'PLACEMENT_STATUS', 'TARGETING', 'BROWSER_NAME', 'DEVICE_CATEGORY_ID', 'DEVICE_CATEGORY_NAME', 'COUNTRY_CRITERIA_ID', 'COUNTRY_CODE', 'COUNTRY_NAME', 'REGION_CRITERIA_ID', 'REGION_NAME', 'CITY_CRITERIA_ID', 'CITY_NAME', 'METRO_CRITERIA_ID', 'METRO_NAME', 'POSTAL_CODE_CRITERIA_ID', 'POSTAL_CODE', 'CUSTOM_TARGETING_VALUE_ID', 'CUSTOM_CRITERIA', 'CONTENT_ID', 'CONTENT_NAME', 'CONTENT_BUNDLE_ID', 'CONTENT_BUNDLE_NAME', 'CMS_METADATA', 'VIDEO_FALLBACK_POSITION', 'POSITION_OF_POD', 'POSITION_IN_POD', 'CUSTOM_SPOT_ID', 'CUSTOM_SPOT_NAME', 'VIDEO_REDIRECT_THIRD_PARTY', 'VIDEO_BREAK_TYPE', 'VIDEO_BREAK_TYPE_NAME', 'VIDEO_VAST_VERSION', 'VIDEO_AD_REQUEST_DURATION_ID', 'VIDEO_AD_REQUEST_DURATION', 'VIDEO_PLCMT_ID', 'VIDEO_PLCMT_NAME', 'INVENTORY_FORMAT', 'INVENTORY_FORMAT_NAME', 'PARTNER_MANAGEMENT_PARTNER_ID', 'PARTNER_MANAGEMENT_PARTNER_NAME', 'PARTNER_MANAGEMENT_PARTNER_LABEL_ID', 'PARTNER_MANAGEMENT_PARTNER_LABEL_NAME', 'PARTNER_MANAGEMENT_ASSIGNMENT_ID', 'PARTNER_MANAGEMENT_ASSIGNMENT_NAME', 'INVENTORY_SHARE_ASSIGNMENT_ID', 'INVENTORY_SHARE_ASSIGNMENT_NAME', 'INVENTORY_SHARE_OUTCOME', 'GRP_DEMOGRAPHICS', 'AD_REQUEST_AD_UNIT_SIZES', 'AD_REQUEST_CUSTOM_CRITERIA', 'IS_FIRST_LOOK_DEAL', 'IS_ADX_DIRECT', 'YIELD_GROUP_ID', 'YIELD_GROUP_NAME', 'YIELD_PARTNER', 'YIELD_PARTNER_TAG', 'EXCHANGE_BIDDING_DEAL_ID', 'EXCHANGE_BIDDING_DEAL_TYPE', 'CLASSIFIED_ADVERTISER_ID', 'CLASSIFIED_ADVERTISER_NAME', 'CLASSIFIED_BRAND_ID', 'CLASSIFIED_BRAND_NAME', 'MEDIATION_TYPE', 'NATIVE_TEMPLATE_ID', 'NATIVE_TEMPLATE_NAME', 'NATIVE_STYLE_ID', 'NATIVE_STYLE_NAME', 'CHILD_NETWORK_CODE', 'MOBILE_APP_RESOLVED_ID', 'MOBILE_APP_NAME', 'MOBILE_DEVICE_NAME', 'MOBILE_INVENTORY_TYPE', 'OPERATING_SYSTEM_VERSION_ID', 'OPERATING_SYSTEM_VERSION_NAME', 'REQUEST_TYPE', 'AD_UNIT_STATUS', 'MASTER_COMPANION_CREATIVE_ID', 'MASTER_COMPANION_CREATIVE_NAME', 'AUDIENCE_SEGMENT_ID', 'AUDIENCE_SEGMENT_NAME', 'AUDIENCE_SEGMENT_DATA_PROVIDER_NAME', 'WEB_PROPERTY_CODE', 'BUYING_AGENCY_NAME', 'BUYER_NETWORK_ID', 'BUYER_NETWORK_NAME', 'BIDDER_ID', 'BIDDER_NAME', 'ADVERTISER_DOMAIN_NAME', 'AD_EXCHANGE_OPTIMIZATION_TYPE', 'ADVERTISER_VERTICAL_NAME', 'NIELSEN_SEGMENT', 'NIELSEN_DEMOGRAPHICS', 'NIELSEN_RESTATEMENT_DATE', 'NIELSEN_DEVICE_ID', 'NIELSEN_DEVICE_NAME', 'PROGRAMMATIC_BUYER_ID', 'PROGRAMMATIC_BUYER_NAME', 'REQUESTED_AD_SIZES', 'CREATIVE_SIZE_DELIVERED', 'PROGRAMMATIC_CHANNEL_ID', 'PROGRAMMATIC_CHANNEL_NAME', 'CLASSIFIED_YIELD_PARTNER_NAME', 'DP_DATE', 'DP_WEEK', 'DP_MONTH_YEAR', 'DP_COUNTRY_CRITERIA_ID', 'DP_COUNTRY_NAME', 'DP_INVENTORY_TYPE', 'DP_CREATIVE_SIZE', 'DP_BRAND_NAME', 'DP_ADVERTISER_NAME', 'DP_ADX_BUYER_NETWORK_NAME', 'DP_MOBILE_DEVICE_NAME', 'DP_DEVICE_CATEGORY_NAME', 'DP_TAG_ID', 'DP_DEAL_ID', 'DP_APP_ID', 'CUSTOM_DIMENSION', 'DEMAND_CHANNEL_ID', 'DEMAND_CHANNEL_NAME', 'DOMAIN', 'SERVING_RESTRICTION_ID', 'SERVING_RESTRICTION_NAME', 'UNIFIED_PRICING_RULE_ID', 'UNIFIED_PRICING_RULE_NAME', 'FIRST_LOOK_PRICING_RULE_ID', 'FIRST_LOOK_PRICING_RULE_NAME', 'BID_RANGE', 'BID_REJECTION_REASON', 'BID_REJECTION_REASON_NAME', 'AD_TECHNOLOGY_PROVIDER_DOMAIN', 'PROGRAMMATIC_DEAL_ID', 'PROGRAMMATIC_DEAL_NAME', 'AD_TECHNOLOGY_PROVIDER_ID', 'AD_TECHNOLOGY_PROVIDER_NAME', 'TCF_VENDOR_ID', 'TCF_VENDOR_NAME', 'SITE_NAME', 'CHANNEL_NAME', 'URL_ID', 'URL_NAME', 'VIDEO_AD_DURATION', 'VIDEO_AD_TYPE_ID', 'VIDEO_AD_TYPE_NAME', 'AD_EXCHANGE_PRODUCT_CODE', 'AD_EXCHANGE_PRODUCT_NAME', 'DYNAMIC_ALLOCATION_ID', 'DYNAMIC_ALLOCATION_NAME', 'AD_TYPE_ID', 'AD_TYPE_NAME', 'AD_LOCATION_ID', 'AD_LOCATION_NAME', 'TARGETING_TYPE_CODE', 'TARGETING_TYPE_NAME', 'BRANDING_TYPE_CODE', 'BRANDING_TYPE_NAME', 'BANDWIDTH_ID', 'BANDWIDTH_NAME', 'CARRIER_ID', 'CARRIER_NAME' }
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.
adUnitView - optional; type ReportQuery.AdUnitView - type string with restriction - enum { 'TOP_LEVEL', 'FLAT', 'HIERARCHICAL' }
The ad unit view for the report. Defaults to {@link AdUnitView#TOP_LEVEL}.
columns - optional, unbounded; type Column - type string with restriction - enum { 'AD_SERVER_IMPRESSIONS', 'AD_SERVER_BEGIN_TO_RENDER_IMPRESSIONS', 'AD_SERVER_TARGETED_IMPRESSIONS', 'AD_SERVER_CLICKS', 'AD_SERVER_TARGETED_CLICKS', 'AD_SERVER_CTR', 'AD_SERVER_CPM_AND_CPC_REVENUE', 'AD_SERVER_CPM_AND_CPC_REVENUE_GROSS', 'AD_SERVER_CPD_REVENUE', 'AD_SERVER_ALL_REVENUE', 'AD_SERVER_ALL_REVENUE_GROSS', 'AD_SERVER_WITHOUT_CPD_AVERAGE_ECPM', 'AD_SERVER_WITH_CPD_AVERAGE_ECPM', 'AD_SERVER_LINE_ITEM_LEVEL_PERCENT_IMPRESSIONS', 'AD_SERVER_LINE_ITEM_LEVEL_PERCENT_CLICKS', 'AD_SERVER_LINE_ITEM_LEVEL_WITHOUT_CPD_PERCENT_REVENUE', 'AD_SERVER_LINE_ITEM_LEVEL_WITH_CPD_PERCENT_REVENUE', 'AD_SERVER_UNFILTERED_IMPRESSIONS', 'AD_SERVER_UNFILTERED_BEGIN_TO_RENDER_IMPRESSIONS', 'AD_SERVER_UNFILTERED_CLICKS', 'ADSENSE_LINE_ITEM_LEVEL_IMPRESSIONS', 'ADSENSE_LINE_ITEM_LEVEL_TARGETED_IMPRESSIONS', 'ADSENSE_LINE_ITEM_LEVEL_CLICKS', 'ADSENSE_LINE_ITEM_LEVEL_TARGETED_CLICKS', 'ADSENSE_LINE_ITEM_LEVEL_CTR', 'ADSENSE_LINE_ITEM_LEVEL_REVENUE', 'ADSENSE_LINE_ITEM_LEVEL_AVERAGE_ECPM', 'ADSENSE_LINE_ITEM_LEVEL_PERCENT_IMPRESSIONS', 'ADSENSE_LINE_ITEM_LEVEL_PERCENT_CLICKS', 'ADSENSE_LINE_ITEM_LEVEL_WITHOUT_CPD_PERCENT_REVENUE', 'ADSENSE_LINE_ITEM_LEVEL_WITH_CPD_PERCENT_REVENUE', 'AD_EXCHANGE_LINE_ITEM_LEVEL_IMPRESSIONS', 'BID_COUNT', 'BID_AVERAGE_CPM', 'YIELD_GROUP_CALLOUTS', 'YIELD_GROUP_SUCCESSFUL_RESPONSES', 'YIELD_GROUP_BIDS', 'YIELD_GROUP_BIDS_IN_AUCTION', 'YIELD_GROUP_AUCTIONS_WON', 'DEALS_BID_REQUESTS', 'DEALS_BIDS', 'DEALS_BID_RATE', 'DEALS_WINNING_BIDS', 'DEALS_WIN_RATE', 'YIELD_GROUP_IMPRESSIONS', 'YIELD_GROUP_ESTIMATED_REVENUE', 'YIELD_GROUP_ESTIMATED_CPM', 'YIELD_GROUP_MEDIATION_FILL_RATE', 'YIELD_GROUP_MEDIATION_PASSBACKS', 'YIELD_GROUP_MEDIATION_THIRD_PARTY_ECPM', 'YIELD_GROUP_MEDIATION_CHAINS_SERVED', 'MEDIATION_THIRD_PARTY_ECPM', 'AD_EXCHANGE_LINE_ITEM_LEVEL_TARGETED_IMPRESSIONS', 'AD_EXCHANGE_LINE_ITEM_LEVEL_CLICKS', 'AD_EXCHANGE_LINE_ITEM_LEVEL_TARGETED_CLICKS', 'AD_EXCHANGE_LINE_ITEM_LEVEL_CTR', 'AD_EXCHANGE_LINE_ITEM_LEVEL_PERCENT_IMPRESSIONS', 'AD_EXCHANGE_LINE_ITEM_LEVEL_PERCENT_CLICKS', 'AD_EXCHANGE_LINE_ITEM_LEVEL_REVENUE', 'AD_EXCHANGE_LINE_ITEM_LEVEL_WITHOUT_CPD_PERCENT_REVENUE', 'AD_EXCHANGE_LINE_ITEM_LEVEL_WITH_CPD_PERCENT_REVENUE', 'AD_EXCHANGE_LINE_ITEM_LEVEL_AVERAGE_ECPM', 'TOTAL_LINE_ITEM_LEVEL_IMPRESSIONS', 'TOTAL_LINE_ITEM_LEVEL_TARGETED_IMPRESSIONS', 'TOTAL_LINE_ITEM_LEVEL_CLICKS', 'TOTAL_LINE_ITEM_LEVEL_TARGETED_CLICKS', 'TOTAL_LINE_ITEM_LEVEL_CTR', 'TOTAL_LINE_ITEM_LEVEL_CPM_AND_CPC_REVENUE', 'TOTAL_LINE_ITEM_LEVEL_ALL_REVENUE', 'TOTAL_LINE_ITEM_LEVEL_WITHOUT_CPD_AVERAGE_ECPM', 'TOTAL_LINE_ITEM_LEVEL_WITH_CPD_AVERAGE_ECPM', 'TOTAL_CODE_SERVED_COUNT', 'TOTAL_AD_REQUESTS', 'TOTAL_RESPONSES_SERVED', 'TOTAL_UNMATCHED_AD_REQUESTS', 'TOTAL_FILL_RATE', 'AD_SERVER_RESPONSES_SERVED', 'ADSENSE_RESPONSES_SERVED', 'AD_EXCHANGE_RESPONSES_SERVED', 'PROGRAMMATIC_RESPONSES_SERVED', 'PROGRAMMATIC_MATCH_RATE', 'TOTAL_PROGRAMMATIC_ELIGIBLE_AD_REQUESTS', 'TOTAL_VIDEO_OPPORTUNITIES', 'TOTAL_VIDEO_CAPPED_OPPORTUNITIES', 'TOTAL_VIDEO_MATCHED_OPPORTUNITIES', 'TOTAL_VIDEO_MATCHED_DURATION', 'TOTAL_VIDEO_DURATION', 'TOTAL_VIDEO_BREAK_START', 'TOTAL_VIDEO_BREAK_END', 'TOTAL_INVENTORY_LEVEL_UNFILLED_IMPRESSIONS', 'UNIQUE_REACH_FREQUENCY', 'UNIQUE_REACH_IMPRESSIONS', 'UNIQUE_REACH', 'SDK_MEDIATION_CREATIVE_IMPRESSIONS', 'SDK_MEDIATION_CREATIVE_CLICKS', 'SELL_THROUGH_FORECASTED_IMPRESSIONS', 'PARTNER_SALES_PARTNER_IMPRESSIONS', 'PARTNER_SALES_PARTNER_CODE_SERVED', 'PARTNER_SALES_GOOGLE_IMPRESSIONS', 'PARTNER_SALES_GOOGLE_RESERVATION_IMPRESSIONS', 'PARTNER_SALES_GOOGLE_AUCTION_IMPRESSIONS', 'PARTNER_SALES_QUERIES', 'PARTNER_SALES_FILLED_QUERIES', 'PARTNER_SALES_SELL_THROUGH_RATE', 'SELL_THROUGH_AVAILABLE_IMPRESSIONS', 'SELL_THROUGH_RESERVED_IMPRESSIONS', 'SELL_THROUGH_SELL_THROUGH_RATE', 'RICH_MEDIA_BACKUP_IMAGES', 'RICH_MEDIA_DISPLAY_TIME', 'RICH_MEDIA_AVERAGE_DISPLAY_TIME', 'RICH_MEDIA_EXPANSIONS', 'RICH_MEDIA_EXPANDING_TIME', 'RICH_MEDIA_INTERACTION_TIME', 'RICH_MEDIA_INTERACTION_COUNT', 'RICH_MEDIA_INTERACTION_RATE', 'RICH_MEDIA_AVERAGE_INTERACTION_TIME', 'RICH_MEDIA_INTERACTION_IMPRESSIONS', 'RICH_MEDIA_MANUAL_CLOSES', 'RICH_MEDIA_FULL_SCREEN_IMPRESSIONS', 'RICH_MEDIA_VIDEO_INTERACTIONS', 'RICH_MEDIA_VIDEO_INTERACTION_RATE', 'RICH_MEDIA_VIDEO_MUTES', 'RICH_MEDIA_VIDEO_PAUSES', 'RICH_MEDIA_VIDEO_PLAYES', 'RICH_MEDIA_VIDEO_MIDPOINTS', 'RICH_MEDIA_VIDEO_COMPLETES', 'RICH_MEDIA_VIDEO_REPLAYS', 'RICH_MEDIA_VIDEO_STOPS', 'RICH_MEDIA_VIDEO_UNMUTES', 'RICH_MEDIA_VIDEO_VIEW_TIME', 'RICH_MEDIA_VIDEO_VIEW_RATE', 'RICH_MEDIA_CUSTOM_EVENT_TIME', 'RICH_MEDIA_CUSTOM_EVENT_COUNT', 'VIDEO_VIEWERSHIP_START', 'VIDEO_VIEWERSHIP_FIRST_QUARTILE', 'VIDEO_VIEWERSHIP_MIDPOINT', 'VIDEO_VIEWERSHIP_THIRD_QUARTILE', 'VIDEO_VIEWERSHIP_COMPLETE', 'VIDEO_VIEWERSHIP_AVERAGE_VIEW_RATE', 'VIDEO_VIEWERSHIP_AVERAGE_VIEW_TIME', 'VIDEO_VIEWERSHIP_COMPLETION_RATE', 'VIDEO_VIEWERSHIP_TOTAL_ERROR_COUNT', 'VIDEO_VIEWERSHIP_VIDEO_LENGTH', 'VIDEO_VIEWERSHIP_SKIP_BUTTON_SHOWN', 'VIDEO_VIEWERSHIP_ENGAGED_VIEW', 'VIDEO_VIEWERSHIP_VIEW_THROUGH_RATE', 'VIDEO_VIEWERSHIP_AUTO_PLAYS', 'VIDEO_VIEWERSHIP_CLICK_TO_PLAYS', 'VIDEO_VIEWERSHIP_TOTAL_ERROR_RATE', 'DROPOFF_RATE', 'VIDEO_TRUEVIEW_VIEWS', 'VIDEO_TRUEVIEW_SKIP_RATE', 'VIDEO_TRUEVIEW_VTR', 'VIDEO_ERRORS_VAST_ERROR_100_COUNT', 'VIDEO_ERRORS_VAST_ERROR_101_COUNT', 'VIDEO_ERRORS_VAST_ERROR_102_COUNT', 'VIDEO_ERRORS_VAST_ERROR_200_COUNT', 'VIDEO_ERRORS_VAST_ERROR_201_COUNT', 'VIDEO_ERRORS_VAST_ERROR_202_COUNT', 'VIDEO_ERRORS_VAST_ERROR_203_COUNT', 'VIDEO_ERRORS_VAST_ERROR_300_COUNT', 'VIDEO_ERRORS_VAST_ERROR_301_COUNT', 'VIDEO_ERRORS_VAST_ERROR_302_COUNT', 'VIDEO_ERRORS_VAST_ERROR_303_COUNT', 'VIDEO_ERRORS_VAST_ERROR_400_COUNT', 'VIDEO_ERRORS_VAST_ERROR_401_COUNT', 'VIDEO_ERRORS_VAST_ERROR_402_COUNT', 'VIDEO_ERRORS_VAST_ERROR_403_COUNT', 'VIDEO_ERRORS_VAST_ERROR_405_COUNT', 'VIDEO_ERRORS_VAST_ERROR_500_COUNT', 'VIDEO_ERRORS_VAST_ERROR_501_COUNT', 'VIDEO_ERRORS_VAST_ERROR_502_COUNT', 'VIDEO_ERRORS_VAST_ERROR_503_COUNT', 'VIDEO_ERRORS_VAST_ERROR_600_COUNT', 'VIDEO_ERRORS_VAST_ERROR_601_COUNT', 'VIDEO_ERRORS_VAST_ERROR_602_COUNT', 'VIDEO_ERRORS_VAST_ERROR_603_COUNT', 'VIDEO_ERRORS_VAST_ERROR_604_COUNT', 'VIDEO_ERRORS_VAST_ERROR_900_COUNT', 'VIDEO_ERRORS_VAST_ERROR_901_COUNT', 'VIDEO_INTERACTION_PAUSE', 'VIDEO_INTERACTION_RESUME', 'VIDEO_INTERACTION_REWIND', 'VIDEO_INTERACTION_MUTE', 'VIDEO_INTERACTION_UNMUTE', 'VIDEO_INTERACTION_COLLAPSE', 'VIDEO_INTERACTION_EXPAND', 'VIDEO_INTERACTION_FULL_SCREEN', 'VIDEO_INTERACTION_AVERAGE_INTERACTION_RATE', 'VIDEO_INTERACTION_VIDEO_SKIPS', 'VIDEO_OPTIMIZATION_CONTROL_STARTS', 'VIDEO_OPTIMIZATION_OPTIMIZED_STARTS', 'VIDEO_OPTIMIZATION_CONTROL_COMPLETES', 'VIDEO_OPTIMIZATION_OPTIMIZED_COMPLETES', 'VIDEO_OPTIMIZATION_CONTROL_COMPLETION_RATE', 'VIDEO_OPTIMIZATION_OPTIMIZED_COMPLETION_RATE', 'VIDEO_OPTIMIZATION_COMPLETION_RATE_LIFT', 'VIDEO_OPTIMIZATION_CONTROL_SKIP_BUTTON_SHOWN', 'VIDEO_OPTIMIZATION_OPTIMIZED_SKIP_BUTTON_SHOWN', 'VIDEO_OPTIMIZATION_CONTROL_ENGAGED_VIEW', 'VIDEO_OPTIMIZATION_OPTIMIZED_ENGAGED_VIEW', 'VIDEO_OPTIMIZATION_CONTROL_VIEW_THROUGH_RATE', 'VIDEO_OPTIMIZATION_OPTIMIZED_VIEW_THROUGH_RATE', 'VIDEO_OPTIMIZATION_VIEW_THROUGH_RATE_LIFT', 'VIDEO_IMPRESSIONS_REAL_TIME', 'VIDEO_MATCHED_QUERIES_REAL_TIME', 'VIDEO_UNMATCHED_QUERIES_REAL_TIME', 'VIDEO_TOTAL_QUERIES_REAL_TIME', 'VIDEO_CREATIVE_SERVE_REAL_TIME', 'VIDEO_VAST3_ERROR_100_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_101_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_102_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_200_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_201_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_202_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_203_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_300_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_301_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_302_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_303_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_400_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_401_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_402_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_403_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_405_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_500_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_501_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_502_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_503_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_600_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_601_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_602_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_603_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_604_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_900_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_901_COUNT_REAL_TIME', 'VIDEO_VAST4_ERROR_406_COUNT_REAL_TIME', 'VIDEO_VAST4_ERROR_407_COUNT_REAL_TIME', 'VIDEO_VAST4_ERROR_408_COUNT_REAL_TIME', 'VIDEO_VAST4_ERROR_409_COUNT_REAL_TIME', 'VIDEO_VAST4_ERROR_410_COUNT_REAL_TIME', 'VIDEO_VAST_TOTAL_ERROR_COUNT_REAL_TIME', 'TOTAL_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS', 'TOTAL_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS', 'TOTAL_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS_RATE', 'TOTAL_ACTIVE_VIEW_ELIGIBLE_IMPRESSIONS', 'TOTAL_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS_RATE', 'TOTAL_ACTIVE_VIEW_AVERAGE_VIEWABLE_TIME', 'ACTIVE_VIEW_PERCENT_AUDIBLE_START_IMPRESSIONS', 'ACTIVE_VIEW_PERCENT_EVER_AUDIBLE_IMPRESSIONS', 'AD_SERVER_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS', 'AD_SERVER_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS', 'AD_SERVER_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS_RATE', 'AD_SERVER_ACTIVE_VIEW_ELIGIBLE_IMPRESSIONS', 'AD_SERVER_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS_RATE', 'AD_SERVER_ACTIVE_VIEW_REVENUE', 'AD_SERVER_ACTIVE_VIEW_AVERAGE_VIEWABLE_TIME', 'ADSENSE_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS', 'ADSENSE_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS', 'ADSENSE_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS_RATE', 'ADSENSE_ACTIVE_VIEW_ELIGIBLE_IMPRESSIONS', 'ADSENSE_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS_RATE', 'ADSENSE_ACTIVE_VIEW_AVERAGE_VIEWABLE_TIME', 'AD_EXCHANGE_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS', 'AD_EXCHANGE_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS', 'AD_EXCHANGE_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS_RATE', 'AD_EXCHANGE_ACTIVE_VIEW_ELIGIBLE_IMPRESSIONS', 'AD_EXCHANGE_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS_RATE', 'AD_EXCHANGE_ACTIVE_VIEW_AVERAGE_VIEWABLE_TIME', 'AD_EXCHANGE_TOTAL_REQUESTS', 'AD_EXCHANGE_MATCH_RATE', 'AD_EXCHANGE_COST_PER_CLICK', 'AD_EXCHANGE_TOTAL_REQUEST_CTR', 'AD_EXCHANGE_MATCHED_REQUEST_CTR', 'AD_EXCHANGE_TOTAL_REQUEST_ECPM', 'AD_EXCHANGE_MATCHED_REQUEST_ECPM', 'AD_EXCHANGE_LIFT_EARNINGS', 'TOTAL_ACTIVE_VIEW_REVENUE', 'DYNAMIC_ALLOCATION_OPPORTUNITY_IMPRESSIONS_COMPETING_TOTAL', 'DYNAMIC_ALLOCATION_OPPORTUNITY_UNFILLED_IMPRESSIONS_COMPETING', 'DYNAMIC_ALLOCATION_OPPORTUNITY_ELIGIBLE_IMPRESSIONS_TOTAL', 'DYNAMIC_ALLOCATION_OPPORTUNITY_IMPRESSIONS_NOT_COMPETING_TOTAL', 'DYNAMIC_ALLOCATION_OPPORTUNITY_IMPRESSIONS_NOT_COMPETING_PERCENT_TOTAL', 'DYNAMIC_ALLOCATION_OPPORTUNITY_SATURATION_RATE_TOTAL', 'DYNAMIC_ALLOCATION_OPPORTUNITY_MATCH_RATE_TOTAL', 'INVOICED_IMPRESSIONS', 'INVOICED_UNFILLED_IMPRESSIONS', 'NIELSEN_IMPRESSIONS', 'NIELSEN_IN_TARGET_IMPRESSIONS', 'NIELSEN_POPULATION_BASE', 'NIELSEN_IN_TARGET_POPULATION_BASE', 'NIELSEN_UNIQUE_AUDIENCE', 'NIELSEN_IN_TARGET_UNIQUE_AUDIENCE', 'NIELSEN_PERCENT_AUDIENCE_REACH', 'NIELSEN_IN_TARGET_PERCENT_AUDIENCE_REACH', 'NIELSEN_AVERAGE_FREQUENCY', 'NIELSEN_IN_TARGET_AVERAGE_FREQUENCY', 'NIELSEN_GROSS_RATING_POINTS', 'NIELSEN_IN_TARGET_GROSS_RATING_POINTS', 'NIELSEN_PERCENT_IMPRESSIONS_SHARE', 'NIELSEN_IN_TARGET_PERCENT_IMPRESSIONS_SHARE', 'NIELSEN_PERCENT_POPULATION_SHARE', 'NIELSEN_IN_TARGET_PERCENT_POPULATION_SHARE', 'NIELSEN_PERCENT_AUDIENCE_SHARE', 'NIELSEN_IN_TARGET_PERCENT_AUDIENCE_SHARE', 'NIELSEN_AUDIENCE_INDEX', 'NIELSEN_IN_TARGET_AUDIENCE_INDEX', 'NIELSEN_IMPRESSIONS_INDEX', 'NIELSEN_IN_TARGET_IMPRESSIONS_INDEX', 'NIELSEN_IN_TARGET_RATIO', 'DP_IMPRESSIONS', 'DP_CLICKS', 'DP_QUERIES', 'DP_MATCHED_QUERIES', 'DP_COST', 'DP_ECPM', 'DP_ACTIVE_VIEW_ELIGIBLE_IMPRESSIONS', 'DP_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS', 'DP_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS', 'DP_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS_RATE', 'DP_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS_RATE', 'PARTNER_MANAGEMENT_HOST_IMPRESSIONS', 'PARTNER_MANAGEMENT_HOST_CLICKS', 'PARTNER_MANAGEMENT_HOST_CTR', 'PARTNER_MANAGEMENT_UNFILLED_IMPRESSIONS', 'PARTNER_MANAGEMENT_PARTNER_IMPRESSIONS', 'PARTNER_MANAGEMENT_PARTNER_CLICKS', 'PARTNER_MANAGEMENT_PARTNER_CTR', 'PARTNER_MANAGEMENT_GROSS_REVENUE', 'PARTNER_FINANCE_HOST_IMPRESSIONS', 'PARTNER_FINANCE_HOST_REVENUE', 'PARTNER_FINANCE_HOST_ECPM', 'PARTNER_FINANCE_PARTNER_REVENUE', 'PARTNER_FINANCE_PARTNER_ECPM', 'PARTNER_FINANCE_GROSS_REVENUE', 'CREATIVE_LOAD_TIME_0_500_MS_PERCENT', 'CREATIVE_LOAD_TIME_500_1000_MS_PERCENT', 'CREATIVE_LOAD_TIME_1_2_S_PERCENT', 'CREATIVE_LOAD_TIME_2_4_S_PERCENT', 'CREATIVE_LOAD_TIME_4_8_S_PERCENT', 'CREATIVE_LOAD_TIME_GREATER_THAN_8_S_PERCENT', 'UNVIEWED_REASON_SLOT_NEVER_ENTERED_VIEWPORT_PERCENT', 'UNVIEWED_REASON_USER_SCROLLED_BEFORE_AD_FILLED_PERCENT', 'UNVIEWED_REASON_USER_SCROLLED_BEFORE_AD_LOADED_PERCENT', 'UNVIEWED_REASON_USER_SCROLLED_BEFORE_1_S_PERCENT', 'UNVIEWED_REASON_OTHER_PERCENT', 'PAGE_NAVIGATION_TO_TAG_LOADED_TIME_0_500_MS_PERCENT', 'PAGE_NAVIGATION_TO_TAG_LOADED_TIME_500_1000_MS_PERCENT', 'PAGE_NAVIGATION_TO_TAG_LOADED_TIME_1_2_S_PERCENT', 'PAGE_NAVIGATION_TO_TAG_LOADED_TIME_2_4_S_PERCENT', 'PAGE_NAVIGATION_TO_TAG_LOADED_TIME_4_8_S_PERCENT', 'PAGE_NAVIGATION_TO_TAG_LOADED_TIME_GREATER_THAN_8_S_PERCENT', 'PAGE_NAVIGATION_TO_FIRST_AD_REQUEST_TIME_0_500_MS_PERCENT', 'PAGE_NAVIGATION_TO_FIRST_AD_REQUEST_TIME_500_1000_MS_PERCENT', 'PAGE_NAVIGATION_TO_FIRST_AD_REQUEST_TIME_1_2_S_PERCENT', 'PAGE_NAVIGATION_TO_FIRST_AD_REQUEST_TIME_2_4_S_PERCENT', 'PAGE_NAVIGATION_TO_FIRST_AD_REQUEST_TIME_4_8_S_PERCENT', 'PAGE_NAVIGATION_TO_FIRST_AD_REQUEST_TIME_GREATER_THAN_8_S_PERCENT', 'TAG_LOAD_TO_FIRST_AD_REQUEST_TIME_0_500_MS_PERCENT', 'TAG_LOAD_TO_FIRST_AD_REQUEST_TIME_500_1000_MS_PERCENT', 'TAG_LOAD_TO_FIRST_AD_REQUEST_TIME_1_2_S_PERCENT', 'TAG_LOAD_TO_FIRST_AD_REQUEST_TIME_2_4_S_PERCENT', 'TAG_LOAD_TO_FIRST_AD_REQUEST_TIME_4_8_S_PERCENT', 'TAG_LOAD_TO_FIRST_AD_REQUEST_TIME_GREATER_THAN_8_S_PERCENT' }
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.
dimensionAttributes - optional, unbounded; type DimensionAttribute - type string with restriction - enum { 'LINE_ITEM_LABELS', 'LINE_ITEM_LABEL_IDS', 'LINE_ITEM_OPTIMIZABLE', 'LINE_ITEM_DELIVERY_INDICATOR', 'LINE_ITEM_DELIVERY_PACING', 'LINE_ITEM_FREQUENCY_CAP', 'LINE_ITEM_RECONCILIATION_STATUS', 'LINE_ITEM_LAST_RECONCILIATION_DATE_TIME', 'ADVERTISER_EXTERNAL_ID', 'ADVERTISER_TYPE', 'ADVERTISER_CREDIT_STATUS', 'ADVERTISER_PRIMARY_CONTACT', 'ORDER_START_DATE_TIME', 'ORDER_END_DATE_TIME', 'ORDER_EXTERNAL_ID', 'ORDER_PO_NUMBER', 'ORDER_IS_PROGRAMMATIC', 'ORDER_AGENCY', 'ORDER_AGENCY_ID', 'ORDER_LABELS', 'ORDER_LABEL_IDS', 'ORDER_TRAFFICKER', 'ORDER_TRAFFICKER_ID', 'ORDER_SECONDARY_TRAFFICKERS', 'ORDER_SALESPERSON', 'ORDER_SECONDARY_SALESPEOPLE', 'ORDER_LIFETIME_IMPRESSIONS', 'ORDER_LIFETIME_CLICKS', 'ORDER_BOOKED_CPM', 'ORDER_BOOKED_CPC', 'LINE_ITEM_START_DATE_TIME', 'LINE_ITEM_END_DATE_TIME', 'LINE_ITEM_EXTERNAL_ID', 'LINE_ITEM_COST_TYPE', 'LINE_ITEM_COST_PER_UNIT', 'LINE_ITEM_CURRENCY_CODE', 'LINE_ITEM_GOAL_QUANTITY', 'LINE_ITEM_AVERAGE_NUMBER_OF_VIEWERS', 'LINE_ITEM_SPONSORSHIP_GOAL_PERCENTAGE', 'LINE_ITEM_LIFETIME_IMPRESSIONS', 'LINE_ITEM_LIFETIME_CLICKS', 'LINE_ITEM_PRIORITY', 'LINE_ITEM_COMPUTED_STATUS', 'CREATIVE_OR_CREATIVE_SET', 'MASTER_COMPANION_TYPE', 'LINE_ITEM_CONTRACTED_QUANTITY', 'LINE_ITEM_DISCOUNT', 'LINE_ITEM_NON_CPD_BOOKED_REVENUE', 'ADVERTISER_LABELS', 'ADVERTISER_LABEL_IDS', 'CREATIVE_CLICK_THROUGH_URL', 'CREATIVE_SSL_SCAN_RESULT', 'CREATIVE_SSL_COMPLIANCE_OVERRIDE', 'LINE_ITEM_CREATIVE_START_DATE', 'LINE_ITEM_CREATIVE_END_DATE', 'CONTENT_CMS_NAME', 'CONTENT_CMS_VIDEO_ID', 'CHILD_PARTNER_NAME', 'AD_UNIT_CODE' }
The list of break-down attributes being requested in this report. Some {@link DimensionAttribute} values can only be used with certain {@link Dimension} values that must be included in the {@link #dimensions} attribute. The generated report will contain the attributes in the same order as requested.

customFieldIds - optional, unbounded; type long

{@link CustomFieldEntityType#entityType}
{@link CustomFieldEntityType#LINE_ITEM}	{@link Dimension#LINE_ITEM_NAME}
{@link CustomFieldEntityType#ORDER}	{@link Dimension#ORDER_NAME}
{@link CustomFieldEntityType#CREATIVE}	{@link Dimension#CREATIVE_NAME}

cmsMetadataKeyIds - optional, unbounded; type long
The list of content CMS metadata key {@link CmsMetadataKey#id IDs} being requested in this report. Each of these IDs must have been defined in the {@link CmsMetadataKey CMS metadata key}. This will include dimensions in the form of {@code CMS_METADATA_KEY[id]_ID} and {@code CMS_METADATA_KEY[id]_VALUE} where where {@code ID} is the ID of the {@link CmsMetadataValue#id CMS metadata value} and {@code VALUE} is the {@link CmsMetadataValue#valueName name}.
To add {@link CmsMetadataKey#id IDs}, you must include {@link Dimension#CMS_METADATA} in {@link #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 {@link Dimension#CMS_METADATA} in {@link #dimensions}. For example, if {@link #dimensions} contains the following dimensions in the order: {@link Dimension#ADVERTISER_NAME}, {@link Dimension#CMS_METADATA} and {@link Dimension#COUNTRY_NAME}, and {@link #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
customDimensionKeyIds - optional, unbounded; type long
The list of custom dimension custom targeting key {@link CustomTargetingKey#id IDs} being requested in this report. This will include dimensions in the form of {@code TOP_LEVEL_DIMENSION_KEY[id]_ID} and {@code TOP_LEVEL_DIMENSION_KEY[id]_VALUE} where {@code ID} is the ID of the {@link CustomTargetingValue#id custom targeting value} and {@code VALUE} is the {@link CustomTargetingValue#name name}.
To add {@link CustomTargetingKey#id IDs}, you must include {@link Dimension#CUSTOM_DIMENSION} in {@link #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 {@link Dimension#CUSTOM_DIMENSION} in {@link #dimensions}. For example, if {@link #dimensions} contains the following dimensions in the order: {@link Dimension#ADVERTISER_NAME}, {@link Dimension#CUSTOM_DIMENSION} and {@link Dimension#COUNTRY_NAME}, and {@link #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.
startDate - optional; type Date
Represents a date.
- year - optional; type int
  Year (e.g., 2009)
- month - optional; type int
  Month (1..12)
- day - optional; type int
  Day (1..31)
The start date from which the reporting information is gathered. The {@code ReportQuery#dateRangeType} field must be set to {@link DateRangeType#CUSTOM_DATE} in order to use this.
endDate - optional; type Date
Represents a date.
- year - optional; type int
  Year (e.g., 2009)
- month - optional; type int
  Month (1..12)
- day - optional; type int
  Day (1..31)
The end date up to which the reporting information is gathered. The {@code ReportQuery#dateRangeType} field must be set to {@link DateRangeType#CUSTOM_DATE} in order to use this.
dateRangeType - optional; type DateRangeType - type string with restriction - enum { 'TODAY', 'YESTERDAY', 'LAST_WEEK', 'LAST_MONTH', 'LAST_3_MONTHS', 'REACH_LIFETIME', 'CUSTOM_DATE', 'NEXT_DAY', 'NEXT_90_DAYS', 'NEXT_WEEK', 'NEXT_MONTH', 'CURRENT_AND_NEXT_MONTH', 'NEXT_QUARTER', 'NEXT_3_MONTHS', 'NEXT_12_MONTHS' }
The period of time for which the reporting data is being generated. In order to define custom time periods, set this to {@link DateRangeType#CUSTOM_DATE}. If set to {@link DateRangeType#CUSTOM_DATE}, then {@link ReportQuery#startDate} and {@link ReportQuery#endDate} will be used.
statement - optional; type Statement
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 {@link #dateRangeType}, {@link #startDate}, and {@link #endDate}. The syntax currently allowed for {@link Statement#query} is
[WHERE {AND ...}]
:= = := = := IN := : where property is the enumeration name of a {@link 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.
Captures the {@code WHERE}, {@code ORDER BY} and {@code LIMIT} clauses of a PQL query. Statements are typically used to retrieve objects of a predefined domain type, which makes SELECT clause unnecessary.
An example query text might be {@code "WHERE status = 'ACTIVE' ORDER BY id LIMIT 30"}.

Statements support bind variables. These are substitutes for literals and can be thought of as input parameters to a PQL query.

An example of such a query might be {@code "WHERE id = :idValue"}.

Statements also support use of the LIKE keyword. This provides wildcard string matching.

An example of such a query might be {@code "WHERE name LIKE '%searchString%'"}.
The value for the variable idValue must then be set with an object of type {@link Value}, e.g., {@link NumberValue}, {@link TextValue} or {@link BooleanValue}.
- query - optional; type string
 Holds the query in PQL syntax. The syntax is:
 [WHERE {[AND | OR] ...}]
 [ORDER BY [ASC | DESC]]
 [LIMIT {[,] } | { OFFSET }]
 
 := {< | <= | > | >= | = | != }
 
 := {< | <= | > | >= | = | != }
 := IN
 := IS NULL
 := LIKE
 := :
- values - optional, unbounded; type String_ValueMapEntry
 Holds keys and values for bind variables and their values. The key is the name of the bind variable. The value is the literal value of the variable.
 In the example {@code "WHERE status = :bindStatus ORDER BY id LIMIT 30"}, the bind variable, represented by {@code :bindStatus} is named {@code bindStatus}, which would also be the parameter map key. The bind variable's value would be represented by a parameter map value of type {@link TextValue}. The final result, for example, would be an entry of {@code "bindStatus" => StringParam("ACTIVE")}.
 This represents an entry in a map with a key of type String and value of type Value.
 - key - optional; type string
 - value - optional; type Value
 {@code Value} represents a value.
- reportCurrency - optional; type string
 The currency for revenue metrics. Defaults to the network currency if left {@code null}. The supported currency codes can be found in this Help Center article.
- timeZoneType - optional; type TimeZoneType - type string with restriction - enum { 'UNKNOWN', 'PUBLISHER', 'PACIFIC' }

Output:

runReportJobResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code

parameters type runReportJobResponse

rval - optional; type ReportJob

Represents a report job that will be run to retrieve performance and statistics information about ad campaigns, networks, inventory and sales.

id - optional; type long
The unique ID of the {@code ReportJob}. This value is read-only and is assigned by Google.

reportQuery - optional; type ReportQuery

Holds the filtering criteria.

A {@code ReportQuery} object allows you to specify the selection criteria for generating a report. Only reports with at least one {@link Column} are supported.

dimensions - optional, unbounded; type Dimension - type string with restriction - enum { 'MONTH_AND_YEAR', 'WEEK', 'DATE', 'DAY', 'HOUR', 'DATE_PT', 'WEEK_PT', 'MONTH_YEAR_PT', 'DAY_OF_WEEK_PT', 'LINE_ITEM_ID', 'LINE_ITEM_NAME', 'LINE_ITEM_TYPE', 'ORDER_ID', 'ORDER_NAME', 'ORDER_DELIVERY_STATUS', 'ADVERTISER_ID', 'ADVERTISER_NAME', 'AD_NETWORK_ID', 'AD_NETWORK_NAME', 'SALESPERSON_ID', 'SALESPERSON_NAME', 'CREATIVE_ID', 'CREATIVE_NAME', 'CREATIVE_TYPE', 'CREATIVE_BILLING_TYPE', 'CUSTOM_EVENT_ID', 'CUSTOM_EVENT_NAME', 'CUSTOM_EVENT_TYPE', 'CREATIVE_SIZE', 'AD_UNIT_ID', 'AD_UNIT_NAME', 'PARENT_AD_UNIT_ID', 'PARENT_AD_UNIT_NAME', 'PLACEMENT_ID', 'PLACEMENT_NAME', 'PLACEMENT_STATUS', 'TARGETING', 'BROWSER_NAME', 'DEVICE_CATEGORY_ID', 'DEVICE_CATEGORY_NAME', 'COUNTRY_CRITERIA_ID', 'COUNTRY_CODE', 'COUNTRY_NAME', 'REGION_CRITERIA_ID', 'REGION_NAME', 'CITY_CRITERIA_ID', 'CITY_NAME', 'METRO_CRITERIA_ID', 'METRO_NAME', 'POSTAL_CODE_CRITERIA_ID', 'POSTAL_CODE', 'CUSTOM_TARGETING_VALUE_ID', 'CUSTOM_CRITERIA', 'CONTENT_ID', 'CONTENT_NAME', 'CONTENT_BUNDLE_ID', 'CONTENT_BUNDLE_NAME', 'CMS_METADATA', 'VIDEO_FALLBACK_POSITION', 'POSITION_OF_POD', 'POSITION_IN_POD', 'CUSTOM_SPOT_ID', 'CUSTOM_SPOT_NAME', 'VIDEO_REDIRECT_THIRD_PARTY', 'VIDEO_BREAK_TYPE', 'VIDEO_BREAK_TYPE_NAME', 'VIDEO_VAST_VERSION', 'VIDEO_AD_REQUEST_DURATION_ID', 'VIDEO_AD_REQUEST_DURATION', 'VIDEO_PLCMT_ID', 'VIDEO_PLCMT_NAME', 'INVENTORY_FORMAT', 'INVENTORY_FORMAT_NAME', 'PARTNER_MANAGEMENT_PARTNER_ID', 'PARTNER_MANAGEMENT_PARTNER_NAME', 'PARTNER_MANAGEMENT_PARTNER_LABEL_ID', 'PARTNER_MANAGEMENT_PARTNER_LABEL_NAME', 'PARTNER_MANAGEMENT_ASSIGNMENT_ID', 'PARTNER_MANAGEMENT_ASSIGNMENT_NAME', 'INVENTORY_SHARE_ASSIGNMENT_ID', 'INVENTORY_SHARE_ASSIGNMENT_NAME', 'INVENTORY_SHARE_OUTCOME', 'GRP_DEMOGRAPHICS', 'AD_REQUEST_AD_UNIT_SIZES', 'AD_REQUEST_CUSTOM_CRITERIA', 'IS_FIRST_LOOK_DEAL', 'IS_ADX_DIRECT', 'YIELD_GROUP_ID', 'YIELD_GROUP_NAME', 'YIELD_PARTNER', 'YIELD_PARTNER_TAG', 'EXCHANGE_BIDDING_DEAL_ID', 'EXCHANGE_BIDDING_DEAL_TYPE', 'CLASSIFIED_ADVERTISER_ID', 'CLASSIFIED_ADVERTISER_NAME', 'CLASSIFIED_BRAND_ID', 'CLASSIFIED_BRAND_NAME', 'MEDIATION_TYPE', 'NATIVE_TEMPLATE_ID', 'NATIVE_TEMPLATE_NAME', 'NATIVE_STYLE_ID', 'NATIVE_STYLE_NAME', 'CHILD_NETWORK_CODE', 'MOBILE_APP_RESOLVED_ID', 'MOBILE_APP_NAME', 'MOBILE_DEVICE_NAME', 'MOBILE_INVENTORY_TYPE', 'OPERATING_SYSTEM_VERSION_ID', 'OPERATING_SYSTEM_VERSION_NAME', 'REQUEST_TYPE', 'AD_UNIT_STATUS', 'MASTER_COMPANION_CREATIVE_ID', 'MASTER_COMPANION_CREATIVE_NAME', 'AUDIENCE_SEGMENT_ID', 'AUDIENCE_SEGMENT_NAME', 'AUDIENCE_SEGMENT_DATA_PROVIDER_NAME', 'WEB_PROPERTY_CODE', 'BUYING_AGENCY_NAME', 'BUYER_NETWORK_ID', 'BUYER_NETWORK_NAME', 'BIDDER_ID', 'BIDDER_NAME', 'ADVERTISER_DOMAIN_NAME', 'AD_EXCHANGE_OPTIMIZATION_TYPE', 'ADVERTISER_VERTICAL_NAME', 'NIELSEN_SEGMENT', 'NIELSEN_DEMOGRAPHICS', 'NIELSEN_RESTATEMENT_DATE', 'NIELSEN_DEVICE_ID', 'NIELSEN_DEVICE_NAME', 'PROGRAMMATIC_BUYER_ID', 'PROGRAMMATIC_BUYER_NAME', 'REQUESTED_AD_SIZES', 'CREATIVE_SIZE_DELIVERED', 'PROGRAMMATIC_CHANNEL_ID', 'PROGRAMMATIC_CHANNEL_NAME', 'CLASSIFIED_YIELD_PARTNER_NAME', 'DP_DATE', 'DP_WEEK', 'DP_MONTH_YEAR', 'DP_COUNTRY_CRITERIA_ID', 'DP_COUNTRY_NAME', 'DP_INVENTORY_TYPE', 'DP_CREATIVE_SIZE', 'DP_BRAND_NAME', 'DP_ADVERTISER_NAME', 'DP_ADX_BUYER_NETWORK_NAME', 'DP_MOBILE_DEVICE_NAME', 'DP_DEVICE_CATEGORY_NAME', 'DP_TAG_ID', 'DP_DEAL_ID', 'DP_APP_ID', 'CUSTOM_DIMENSION', 'DEMAND_CHANNEL_ID', 'DEMAND_CHANNEL_NAME', 'DOMAIN', 'SERVING_RESTRICTION_ID', 'SERVING_RESTRICTION_NAME', 'UNIFIED_PRICING_RULE_ID', 'UNIFIED_PRICING_RULE_NAME', 'FIRST_LOOK_PRICING_RULE_ID', 'FIRST_LOOK_PRICING_RULE_NAME', 'BID_RANGE', 'BID_REJECTION_REASON', 'BID_REJECTION_REASON_NAME', 'AD_TECHNOLOGY_PROVIDER_DOMAIN', 'PROGRAMMATIC_DEAL_ID', 'PROGRAMMATIC_DEAL_NAME', 'AD_TECHNOLOGY_PROVIDER_ID', 'AD_TECHNOLOGY_PROVIDER_NAME', 'TCF_VENDOR_ID', 'TCF_VENDOR_NAME', 'SITE_NAME', 'CHANNEL_NAME', 'URL_ID', 'URL_NAME', 'VIDEO_AD_DURATION', 'VIDEO_AD_TYPE_ID', 'VIDEO_AD_TYPE_NAME', 'AD_EXCHANGE_PRODUCT_CODE', 'AD_EXCHANGE_PRODUCT_NAME', 'DYNAMIC_ALLOCATION_ID', 'DYNAMIC_ALLOCATION_NAME', 'AD_TYPE_ID', 'AD_TYPE_NAME', 'AD_LOCATION_ID', 'AD_LOCATION_NAME', 'TARGETING_TYPE_CODE', 'TARGETING_TYPE_NAME', 'BRANDING_TYPE_CODE', 'BRANDING_TYPE_NAME', 'BANDWIDTH_ID', 'BANDWIDTH_NAME', 'CARRIER_ID', 'CARRIER_NAME' }
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.
adUnitView - optional; type ReportQuery.AdUnitView - type string with restriction - enum { 'TOP_LEVEL', 'FLAT', 'HIERARCHICAL' }
The ad unit view for the report. Defaults to {@link AdUnitView#TOP_LEVEL}.
columns - optional, unbounded; type Column - type string with restriction - enum { 'AD_SERVER_IMPRESSIONS', 'AD_SERVER_BEGIN_TO_RENDER_IMPRESSIONS', 'AD_SERVER_TARGETED_IMPRESSIONS', 'AD_SERVER_CLICKS', 'AD_SERVER_TARGETED_CLICKS', 'AD_SERVER_CTR', 'AD_SERVER_CPM_AND_CPC_REVENUE', 'AD_SERVER_CPM_AND_CPC_REVENUE_GROSS', 'AD_SERVER_CPD_REVENUE', 'AD_SERVER_ALL_REVENUE', 'AD_SERVER_ALL_REVENUE_GROSS', 'AD_SERVER_WITHOUT_CPD_AVERAGE_ECPM', 'AD_SERVER_WITH_CPD_AVERAGE_ECPM', 'AD_SERVER_LINE_ITEM_LEVEL_PERCENT_IMPRESSIONS', 'AD_SERVER_LINE_ITEM_LEVEL_PERCENT_CLICKS', 'AD_SERVER_LINE_ITEM_LEVEL_WITHOUT_CPD_PERCENT_REVENUE', 'AD_SERVER_LINE_ITEM_LEVEL_WITH_CPD_PERCENT_REVENUE', 'AD_SERVER_UNFILTERED_IMPRESSIONS', 'AD_SERVER_UNFILTERED_BEGIN_TO_RENDER_IMPRESSIONS', 'AD_SERVER_UNFILTERED_CLICKS', 'ADSENSE_LINE_ITEM_LEVEL_IMPRESSIONS', 'ADSENSE_LINE_ITEM_LEVEL_TARGETED_IMPRESSIONS', 'ADSENSE_LINE_ITEM_LEVEL_CLICKS', 'ADSENSE_LINE_ITEM_LEVEL_TARGETED_CLICKS', 'ADSENSE_LINE_ITEM_LEVEL_CTR', 'ADSENSE_LINE_ITEM_LEVEL_REVENUE', 'ADSENSE_LINE_ITEM_LEVEL_AVERAGE_ECPM', 'ADSENSE_LINE_ITEM_LEVEL_PERCENT_IMPRESSIONS', 'ADSENSE_LINE_ITEM_LEVEL_PERCENT_CLICKS', 'ADSENSE_LINE_ITEM_LEVEL_WITHOUT_CPD_PERCENT_REVENUE', 'ADSENSE_LINE_ITEM_LEVEL_WITH_CPD_PERCENT_REVENUE', 'AD_EXCHANGE_LINE_ITEM_LEVEL_IMPRESSIONS', 'BID_COUNT', 'BID_AVERAGE_CPM', 'YIELD_GROUP_CALLOUTS', 'YIELD_GROUP_SUCCESSFUL_RESPONSES', 'YIELD_GROUP_BIDS', 'YIELD_GROUP_BIDS_IN_AUCTION', 'YIELD_GROUP_AUCTIONS_WON', 'DEALS_BID_REQUESTS', 'DEALS_BIDS', 'DEALS_BID_RATE', 'DEALS_WINNING_BIDS', 'DEALS_WIN_RATE', 'YIELD_GROUP_IMPRESSIONS', 'YIELD_GROUP_ESTIMATED_REVENUE', 'YIELD_GROUP_ESTIMATED_CPM', 'YIELD_GROUP_MEDIATION_FILL_RATE', 'YIELD_GROUP_MEDIATION_PASSBACKS', 'YIELD_GROUP_MEDIATION_THIRD_PARTY_ECPM', 'YIELD_GROUP_MEDIATION_CHAINS_SERVED', 'MEDIATION_THIRD_PARTY_ECPM', 'AD_EXCHANGE_LINE_ITEM_LEVEL_TARGETED_IMPRESSIONS', 'AD_EXCHANGE_LINE_ITEM_LEVEL_CLICKS', 'AD_EXCHANGE_LINE_ITEM_LEVEL_TARGETED_CLICKS', 'AD_EXCHANGE_LINE_ITEM_LEVEL_CTR', 'AD_EXCHANGE_LINE_ITEM_LEVEL_PERCENT_IMPRESSIONS', 'AD_EXCHANGE_LINE_ITEM_LEVEL_PERCENT_CLICKS', 'AD_EXCHANGE_LINE_ITEM_LEVEL_REVENUE', 'AD_EXCHANGE_LINE_ITEM_LEVEL_WITHOUT_CPD_PERCENT_REVENUE', 'AD_EXCHANGE_LINE_ITEM_LEVEL_WITH_CPD_PERCENT_REVENUE', 'AD_EXCHANGE_LINE_ITEM_LEVEL_AVERAGE_ECPM', 'TOTAL_LINE_ITEM_LEVEL_IMPRESSIONS', 'TOTAL_LINE_ITEM_LEVEL_TARGETED_IMPRESSIONS', 'TOTAL_LINE_ITEM_LEVEL_CLICKS', 'TOTAL_LINE_ITEM_LEVEL_TARGETED_CLICKS', 'TOTAL_LINE_ITEM_LEVEL_CTR', 'TOTAL_LINE_ITEM_LEVEL_CPM_AND_CPC_REVENUE', 'TOTAL_LINE_ITEM_LEVEL_ALL_REVENUE', 'TOTAL_LINE_ITEM_LEVEL_WITHOUT_CPD_AVERAGE_ECPM', 'TOTAL_LINE_ITEM_LEVEL_WITH_CPD_AVERAGE_ECPM', 'TOTAL_CODE_SERVED_COUNT', 'TOTAL_AD_REQUESTS', 'TOTAL_RESPONSES_SERVED', 'TOTAL_UNMATCHED_AD_REQUESTS', 'TOTAL_FILL_RATE', 'AD_SERVER_RESPONSES_SERVED', 'ADSENSE_RESPONSES_SERVED', 'AD_EXCHANGE_RESPONSES_SERVED', 'PROGRAMMATIC_RESPONSES_SERVED', 'PROGRAMMATIC_MATCH_RATE', 'TOTAL_PROGRAMMATIC_ELIGIBLE_AD_REQUESTS', 'TOTAL_VIDEO_OPPORTUNITIES', 'TOTAL_VIDEO_CAPPED_OPPORTUNITIES', 'TOTAL_VIDEO_MATCHED_OPPORTUNITIES', 'TOTAL_VIDEO_MATCHED_DURATION', 'TOTAL_VIDEO_DURATION', 'TOTAL_VIDEO_BREAK_START', 'TOTAL_VIDEO_BREAK_END', 'TOTAL_INVENTORY_LEVEL_UNFILLED_IMPRESSIONS', 'UNIQUE_REACH_FREQUENCY', 'UNIQUE_REACH_IMPRESSIONS', 'UNIQUE_REACH', 'SDK_MEDIATION_CREATIVE_IMPRESSIONS', 'SDK_MEDIATION_CREATIVE_CLICKS', 'SELL_THROUGH_FORECASTED_IMPRESSIONS', 'PARTNER_SALES_PARTNER_IMPRESSIONS', 'PARTNER_SALES_PARTNER_CODE_SERVED', 'PARTNER_SALES_GOOGLE_IMPRESSIONS', 'PARTNER_SALES_GOOGLE_RESERVATION_IMPRESSIONS', 'PARTNER_SALES_GOOGLE_AUCTION_IMPRESSIONS', 'PARTNER_SALES_QUERIES', 'PARTNER_SALES_FILLED_QUERIES', 'PARTNER_SALES_SELL_THROUGH_RATE', 'SELL_THROUGH_AVAILABLE_IMPRESSIONS', 'SELL_THROUGH_RESERVED_IMPRESSIONS', 'SELL_THROUGH_SELL_THROUGH_RATE', 'RICH_MEDIA_BACKUP_IMAGES', 'RICH_MEDIA_DISPLAY_TIME', 'RICH_MEDIA_AVERAGE_DISPLAY_TIME', 'RICH_MEDIA_EXPANSIONS', 'RICH_MEDIA_EXPANDING_TIME', 'RICH_MEDIA_INTERACTION_TIME', 'RICH_MEDIA_INTERACTION_COUNT', 'RICH_MEDIA_INTERACTION_RATE', 'RICH_MEDIA_AVERAGE_INTERACTION_TIME', 'RICH_MEDIA_INTERACTION_IMPRESSIONS', 'RICH_MEDIA_MANUAL_CLOSES', 'RICH_MEDIA_FULL_SCREEN_IMPRESSIONS', 'RICH_MEDIA_VIDEO_INTERACTIONS', 'RICH_MEDIA_VIDEO_INTERACTION_RATE', 'RICH_MEDIA_VIDEO_MUTES', 'RICH_MEDIA_VIDEO_PAUSES', 'RICH_MEDIA_VIDEO_PLAYES', 'RICH_MEDIA_VIDEO_MIDPOINTS', 'RICH_MEDIA_VIDEO_COMPLETES', 'RICH_MEDIA_VIDEO_REPLAYS', 'RICH_MEDIA_VIDEO_STOPS', 'RICH_MEDIA_VIDEO_UNMUTES', 'RICH_MEDIA_VIDEO_VIEW_TIME', 'RICH_MEDIA_VIDEO_VIEW_RATE', 'RICH_MEDIA_CUSTOM_EVENT_TIME', 'RICH_MEDIA_CUSTOM_EVENT_COUNT', 'VIDEO_VIEWERSHIP_START', 'VIDEO_VIEWERSHIP_FIRST_QUARTILE', 'VIDEO_VIEWERSHIP_MIDPOINT', 'VIDEO_VIEWERSHIP_THIRD_QUARTILE', 'VIDEO_VIEWERSHIP_COMPLETE', 'VIDEO_VIEWERSHIP_AVERAGE_VIEW_RATE', 'VIDEO_VIEWERSHIP_AVERAGE_VIEW_TIME', 'VIDEO_VIEWERSHIP_COMPLETION_RATE', 'VIDEO_VIEWERSHIP_TOTAL_ERROR_COUNT', 'VIDEO_VIEWERSHIP_VIDEO_LENGTH', 'VIDEO_VIEWERSHIP_SKIP_BUTTON_SHOWN', 'VIDEO_VIEWERSHIP_ENGAGED_VIEW', 'VIDEO_VIEWERSHIP_VIEW_THROUGH_RATE', 'VIDEO_VIEWERSHIP_AUTO_PLAYS', 'VIDEO_VIEWERSHIP_CLICK_TO_PLAYS', 'VIDEO_VIEWERSHIP_TOTAL_ERROR_RATE', 'DROPOFF_RATE', 'VIDEO_TRUEVIEW_VIEWS', 'VIDEO_TRUEVIEW_SKIP_RATE', 'VIDEO_TRUEVIEW_VTR', 'VIDEO_ERRORS_VAST_ERROR_100_COUNT', 'VIDEO_ERRORS_VAST_ERROR_101_COUNT', 'VIDEO_ERRORS_VAST_ERROR_102_COUNT', 'VIDEO_ERRORS_VAST_ERROR_200_COUNT', 'VIDEO_ERRORS_VAST_ERROR_201_COUNT', 'VIDEO_ERRORS_VAST_ERROR_202_COUNT', 'VIDEO_ERRORS_VAST_ERROR_203_COUNT', 'VIDEO_ERRORS_VAST_ERROR_300_COUNT', 'VIDEO_ERRORS_VAST_ERROR_301_COUNT', 'VIDEO_ERRORS_VAST_ERROR_302_COUNT', 'VIDEO_ERRORS_VAST_ERROR_303_COUNT', 'VIDEO_ERRORS_VAST_ERROR_400_COUNT', 'VIDEO_ERRORS_VAST_ERROR_401_COUNT', 'VIDEO_ERRORS_VAST_ERROR_402_COUNT', 'VIDEO_ERRORS_VAST_ERROR_403_COUNT', 'VIDEO_ERRORS_VAST_ERROR_405_COUNT', 'VIDEO_ERRORS_VAST_ERROR_500_COUNT', 'VIDEO_ERRORS_VAST_ERROR_501_COUNT', 'VIDEO_ERRORS_VAST_ERROR_502_COUNT', 'VIDEO_ERRORS_VAST_ERROR_503_COUNT', 'VIDEO_ERRORS_VAST_ERROR_600_COUNT', 'VIDEO_ERRORS_VAST_ERROR_601_COUNT', 'VIDEO_ERRORS_VAST_ERROR_602_COUNT', 'VIDEO_ERRORS_VAST_ERROR_603_COUNT', 'VIDEO_ERRORS_VAST_ERROR_604_COUNT', 'VIDEO_ERRORS_VAST_ERROR_900_COUNT', 'VIDEO_ERRORS_VAST_ERROR_901_COUNT', 'VIDEO_INTERACTION_PAUSE', 'VIDEO_INTERACTION_RESUME', 'VIDEO_INTERACTION_REWIND', 'VIDEO_INTERACTION_MUTE', 'VIDEO_INTERACTION_UNMUTE', 'VIDEO_INTERACTION_COLLAPSE', 'VIDEO_INTERACTION_EXPAND', 'VIDEO_INTERACTION_FULL_SCREEN', 'VIDEO_INTERACTION_AVERAGE_INTERACTION_RATE', 'VIDEO_INTERACTION_VIDEO_SKIPS', 'VIDEO_OPTIMIZATION_CONTROL_STARTS', 'VIDEO_OPTIMIZATION_OPTIMIZED_STARTS', 'VIDEO_OPTIMIZATION_CONTROL_COMPLETES', 'VIDEO_OPTIMIZATION_OPTIMIZED_COMPLETES', 'VIDEO_OPTIMIZATION_CONTROL_COMPLETION_RATE', 'VIDEO_OPTIMIZATION_OPTIMIZED_COMPLETION_RATE', 'VIDEO_OPTIMIZATION_COMPLETION_RATE_LIFT', 'VIDEO_OPTIMIZATION_CONTROL_SKIP_BUTTON_SHOWN', 'VIDEO_OPTIMIZATION_OPTIMIZED_SKIP_BUTTON_SHOWN', 'VIDEO_OPTIMIZATION_CONTROL_ENGAGED_VIEW', 'VIDEO_OPTIMIZATION_OPTIMIZED_ENGAGED_VIEW', 'VIDEO_OPTIMIZATION_CONTROL_VIEW_THROUGH_RATE', 'VIDEO_OPTIMIZATION_OPTIMIZED_VIEW_THROUGH_RATE', 'VIDEO_OPTIMIZATION_VIEW_THROUGH_RATE_LIFT', 'VIDEO_IMPRESSIONS_REAL_TIME', 'VIDEO_MATCHED_QUERIES_REAL_TIME', 'VIDEO_UNMATCHED_QUERIES_REAL_TIME', 'VIDEO_TOTAL_QUERIES_REAL_TIME', 'VIDEO_CREATIVE_SERVE_REAL_TIME', 'VIDEO_VAST3_ERROR_100_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_101_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_102_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_200_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_201_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_202_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_203_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_300_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_301_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_302_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_303_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_400_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_401_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_402_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_403_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_405_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_500_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_501_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_502_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_503_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_600_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_601_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_602_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_603_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_604_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_900_COUNT_REAL_TIME', 'VIDEO_VAST3_ERROR_901_COUNT_REAL_TIME', 'VIDEO_VAST4_ERROR_406_COUNT_REAL_TIME', 'VIDEO_VAST4_ERROR_407_COUNT_REAL_TIME', 'VIDEO_VAST4_ERROR_408_COUNT_REAL_TIME', 'VIDEO_VAST4_ERROR_409_COUNT_REAL_TIME', 'VIDEO_VAST4_ERROR_410_COUNT_REAL_TIME', 'VIDEO_VAST_TOTAL_ERROR_COUNT_REAL_TIME', 'TOTAL_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS', 'TOTAL_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS', 'TOTAL_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS_RATE', 'TOTAL_ACTIVE_VIEW_ELIGIBLE_IMPRESSIONS', 'TOTAL_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS_RATE', 'TOTAL_ACTIVE_VIEW_AVERAGE_VIEWABLE_TIME', 'ACTIVE_VIEW_PERCENT_AUDIBLE_START_IMPRESSIONS', 'ACTIVE_VIEW_PERCENT_EVER_AUDIBLE_IMPRESSIONS', 'AD_SERVER_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS', 'AD_SERVER_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS', 'AD_SERVER_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS_RATE', 'AD_SERVER_ACTIVE_VIEW_ELIGIBLE_IMPRESSIONS', 'AD_SERVER_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS_RATE', 'AD_SERVER_ACTIVE_VIEW_REVENUE', 'AD_SERVER_ACTIVE_VIEW_AVERAGE_VIEWABLE_TIME', 'ADSENSE_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS', 'ADSENSE_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS', 'ADSENSE_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS_RATE', 'ADSENSE_ACTIVE_VIEW_ELIGIBLE_IMPRESSIONS', 'ADSENSE_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS_RATE', 'ADSENSE_ACTIVE_VIEW_AVERAGE_VIEWABLE_TIME', 'AD_EXCHANGE_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS', 'AD_EXCHANGE_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS', 'AD_EXCHANGE_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS_RATE', 'AD_EXCHANGE_ACTIVE_VIEW_ELIGIBLE_IMPRESSIONS', 'AD_EXCHANGE_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS_RATE', 'AD_EXCHANGE_ACTIVE_VIEW_AVERAGE_VIEWABLE_TIME', 'AD_EXCHANGE_TOTAL_REQUESTS', 'AD_EXCHANGE_MATCH_RATE', 'AD_EXCHANGE_COST_PER_CLICK', 'AD_EXCHANGE_TOTAL_REQUEST_CTR', 'AD_EXCHANGE_MATCHED_REQUEST_CTR', 'AD_EXCHANGE_TOTAL_REQUEST_ECPM', 'AD_EXCHANGE_MATCHED_REQUEST_ECPM', 'AD_EXCHANGE_LIFT_EARNINGS', 'TOTAL_ACTIVE_VIEW_REVENUE', 'DYNAMIC_ALLOCATION_OPPORTUNITY_IMPRESSIONS_COMPETING_TOTAL', 'DYNAMIC_ALLOCATION_OPPORTUNITY_UNFILLED_IMPRESSIONS_COMPETING', 'DYNAMIC_ALLOCATION_OPPORTUNITY_ELIGIBLE_IMPRESSIONS_TOTAL', 'DYNAMIC_ALLOCATION_OPPORTUNITY_IMPRESSIONS_NOT_COMPETING_TOTAL', 'DYNAMIC_ALLOCATION_OPPORTUNITY_IMPRESSIONS_NOT_COMPETING_PERCENT_TOTAL', 'DYNAMIC_ALLOCATION_OPPORTUNITY_SATURATION_RATE_TOTAL', 'DYNAMIC_ALLOCATION_OPPORTUNITY_MATCH_RATE_TOTAL', 'INVOICED_IMPRESSIONS', 'INVOICED_UNFILLED_IMPRESSIONS', 'NIELSEN_IMPRESSIONS', 'NIELSEN_IN_TARGET_IMPRESSIONS', 'NIELSEN_POPULATION_BASE', 'NIELSEN_IN_TARGET_POPULATION_BASE', 'NIELSEN_UNIQUE_AUDIENCE', 'NIELSEN_IN_TARGET_UNIQUE_AUDIENCE', 'NIELSEN_PERCENT_AUDIENCE_REACH', 'NIELSEN_IN_TARGET_PERCENT_AUDIENCE_REACH', 'NIELSEN_AVERAGE_FREQUENCY', 'NIELSEN_IN_TARGET_AVERAGE_FREQUENCY', 'NIELSEN_GROSS_RATING_POINTS', 'NIELSEN_IN_TARGET_GROSS_RATING_POINTS', 'NIELSEN_PERCENT_IMPRESSIONS_SHARE', 'NIELSEN_IN_TARGET_PERCENT_IMPRESSIONS_SHARE', 'NIELSEN_PERCENT_POPULATION_SHARE', 'NIELSEN_IN_TARGET_PERCENT_POPULATION_SHARE', 'NIELSEN_PERCENT_AUDIENCE_SHARE', 'NIELSEN_IN_TARGET_PERCENT_AUDIENCE_SHARE', 'NIELSEN_AUDIENCE_INDEX', 'NIELSEN_IN_TARGET_AUDIENCE_INDEX', 'NIELSEN_IMPRESSIONS_INDEX', 'NIELSEN_IN_TARGET_IMPRESSIONS_INDEX', 'NIELSEN_IN_TARGET_RATIO', 'DP_IMPRESSIONS', 'DP_CLICKS', 'DP_QUERIES', 'DP_MATCHED_QUERIES', 'DP_COST', 'DP_ECPM', 'DP_ACTIVE_VIEW_ELIGIBLE_IMPRESSIONS', 'DP_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS', 'DP_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS', 'DP_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS_RATE', 'DP_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS_RATE', 'PARTNER_MANAGEMENT_HOST_IMPRESSIONS', 'PARTNER_MANAGEMENT_HOST_CLICKS', 'PARTNER_MANAGEMENT_HOST_CTR', 'PARTNER_MANAGEMENT_UNFILLED_IMPRESSIONS', 'PARTNER_MANAGEMENT_PARTNER_IMPRESSIONS', 'PARTNER_MANAGEMENT_PARTNER_CLICKS', 'PARTNER_MANAGEMENT_PARTNER_CTR', 'PARTNER_MANAGEMENT_GROSS_REVENUE', 'PARTNER_FINANCE_HOST_IMPRESSIONS', 'PARTNER_FINANCE_HOST_REVENUE', 'PARTNER_FINANCE_HOST_ECPM', 'PARTNER_FINANCE_PARTNER_REVENUE', 'PARTNER_FINANCE_PARTNER_ECPM', 'PARTNER_FINANCE_GROSS_REVENUE', 'CREATIVE_LOAD_TIME_0_500_MS_PERCENT', 'CREATIVE_LOAD_TIME_500_1000_MS_PERCENT', 'CREATIVE_LOAD_TIME_1_2_S_PERCENT', 'CREATIVE_LOAD_TIME_2_4_S_PERCENT', 'CREATIVE_LOAD_TIME_4_8_S_PERCENT', 'CREATIVE_LOAD_TIME_GREATER_THAN_8_S_PERCENT', 'UNVIEWED_REASON_SLOT_NEVER_ENTERED_VIEWPORT_PERCENT', 'UNVIEWED_REASON_USER_SCROLLED_BEFORE_AD_FILLED_PERCENT', 'UNVIEWED_REASON_USER_SCROLLED_BEFORE_AD_LOADED_PERCENT', 'UNVIEWED_REASON_USER_SCROLLED_BEFORE_1_S_PERCENT', 'UNVIEWED_REASON_OTHER_PERCENT', 'PAGE_NAVIGATION_TO_TAG_LOADED_TIME_0_500_MS_PERCENT', 'PAGE_NAVIGATION_TO_TAG_LOADED_TIME_500_1000_MS_PERCENT', 'PAGE_NAVIGATION_TO_TAG_LOADED_TIME_1_2_S_PERCENT', 'PAGE_NAVIGATION_TO_TAG_LOADED_TIME_2_4_S_PERCENT', 'PAGE_NAVIGATION_TO_TAG_LOADED_TIME_4_8_S_PERCENT', 'PAGE_NAVIGATION_TO_TAG_LOADED_TIME_GREATER_THAN_8_S_PERCENT', 'PAGE_NAVIGATION_TO_FIRST_AD_REQUEST_TIME_0_500_MS_PERCENT', 'PAGE_NAVIGATION_TO_FIRST_AD_REQUEST_TIME_500_1000_MS_PERCENT', 'PAGE_NAVIGATION_TO_FIRST_AD_REQUEST_TIME_1_2_S_PERCENT', 'PAGE_NAVIGATION_TO_FIRST_AD_REQUEST_TIME_2_4_S_PERCENT', 'PAGE_NAVIGATION_TO_FIRST_AD_REQUEST_TIME_4_8_S_PERCENT', 'PAGE_NAVIGATION_TO_FIRST_AD_REQUEST_TIME_GREATER_THAN_8_S_PERCENT', 'TAG_LOAD_TO_FIRST_AD_REQUEST_TIME_0_500_MS_PERCENT', 'TAG_LOAD_TO_FIRST_AD_REQUEST_TIME_500_1000_MS_PERCENT', 'TAG_LOAD_TO_FIRST_AD_REQUEST_TIME_1_2_S_PERCENT', 'TAG_LOAD_TO_FIRST_AD_REQUEST_TIME_2_4_S_PERCENT', 'TAG_LOAD_TO_FIRST_AD_REQUEST_TIME_4_8_S_PERCENT', 'TAG_LOAD_TO_FIRST_AD_REQUEST_TIME_GREATER_THAN_8_S_PERCENT' }
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.
dimensionAttributes - optional, unbounded; type DimensionAttribute - type string with restriction - enum { 'LINE_ITEM_LABELS', 'LINE_ITEM_LABEL_IDS', 'LINE_ITEM_OPTIMIZABLE', 'LINE_ITEM_DELIVERY_INDICATOR', 'LINE_ITEM_DELIVERY_PACING', 'LINE_ITEM_FREQUENCY_CAP', 'LINE_ITEM_RECONCILIATION_STATUS', 'LINE_ITEM_LAST_RECONCILIATION_DATE_TIME', 'ADVERTISER_EXTERNAL_ID', 'ADVERTISER_TYPE', 'ADVERTISER_CREDIT_STATUS', 'ADVERTISER_PRIMARY_CONTACT', 'ORDER_START_DATE_TIME', 'ORDER_END_DATE_TIME', 'ORDER_EXTERNAL_ID', 'ORDER_PO_NUMBER', 'ORDER_IS_PROGRAMMATIC', 'ORDER_AGENCY', 'ORDER_AGENCY_ID', 'ORDER_LABELS', 'ORDER_LABEL_IDS', 'ORDER_TRAFFICKER', 'ORDER_TRAFFICKER_ID', 'ORDER_SECONDARY_TRAFFICKERS', 'ORDER_SALESPERSON', 'ORDER_SECONDARY_SALESPEOPLE', 'ORDER_LIFETIME_IMPRESSIONS', 'ORDER_LIFETIME_CLICKS', 'ORDER_BOOKED_CPM', 'ORDER_BOOKED_CPC', 'LINE_ITEM_START_DATE_TIME', 'LINE_ITEM_END_DATE_TIME', 'LINE_ITEM_EXTERNAL_ID', 'LINE_ITEM_COST_TYPE', 'LINE_ITEM_COST_PER_UNIT', 'LINE_ITEM_CURRENCY_CODE', 'LINE_ITEM_GOAL_QUANTITY', 'LINE_ITEM_AVERAGE_NUMBER_OF_VIEWERS', 'LINE_ITEM_SPONSORSHIP_GOAL_PERCENTAGE', 'LINE_ITEM_LIFETIME_IMPRESSIONS', 'LINE_ITEM_LIFETIME_CLICKS', 'LINE_ITEM_PRIORITY', 'LINE_ITEM_COMPUTED_STATUS', 'CREATIVE_OR_CREATIVE_SET', 'MASTER_COMPANION_TYPE', 'LINE_ITEM_CONTRACTED_QUANTITY', 'LINE_ITEM_DISCOUNT', 'LINE_ITEM_NON_CPD_BOOKED_REVENUE', 'ADVERTISER_LABELS', 'ADVERTISER_LABEL_IDS', 'CREATIVE_CLICK_THROUGH_URL', 'CREATIVE_SSL_SCAN_RESULT', 'CREATIVE_SSL_COMPLIANCE_OVERRIDE', 'LINE_ITEM_CREATIVE_START_DATE', 'LINE_ITEM_CREATIVE_END_DATE', 'CONTENT_CMS_NAME', 'CONTENT_CMS_VIDEO_ID', 'CHILD_PARTNER_NAME', 'AD_UNIT_CODE' }
The list of break-down attributes being requested in this report. Some {@link DimensionAttribute} values can only be used with certain {@link Dimension} values that must be included in the {@link #dimensions} attribute. The generated report will contain the attributes in the same order as requested.

customFieldIds - optional, unbounded; type long

{@link CustomFieldEntityType#entityType}
{@link CustomFieldEntityType#LINE_ITEM}	{@link Dimension#LINE_ITEM_NAME}
{@link CustomFieldEntityType#ORDER}	{@link Dimension#ORDER_NAME}
{@link CustomFieldEntityType#CREATIVE}	{@link Dimension#CREATIVE_NAME}

cmsMetadataKeyIds - optional, unbounded; type long
The list of content CMS metadata key {@link CmsMetadataKey#id IDs} being requested in this report. Each of these IDs must have been defined in the {@link CmsMetadataKey CMS metadata key}. This will include dimensions in the form of {@code CMS_METADATA_KEY[id]_ID} and {@code CMS_METADATA_KEY[id]_VALUE} where where {@code ID} is the ID of the {@link CmsMetadataValue#id CMS metadata value} and {@code VALUE} is the {@link CmsMetadataValue#valueName name}.
To add {@link CmsMetadataKey#id IDs}, you must include {@link Dimension#CMS_METADATA} in {@link #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 {@link Dimension#CMS_METADATA} in {@link #dimensions}. For example, if {@link #dimensions} contains the following dimensions in the order: {@link Dimension#ADVERTISER_NAME}, {@link Dimension#CMS_METADATA} and {@link Dimension#COUNTRY_NAME}, and {@link #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
customDimensionKeyIds - optional, unbounded; type long
The list of custom dimension custom targeting key {@link CustomTargetingKey#id IDs} being requested in this report. This will include dimensions in the form of {@code TOP_LEVEL_DIMENSION_KEY[id]_ID} and {@code TOP_LEVEL_DIMENSION_KEY[id]_VALUE} where {@code ID} is the ID of the {@link CustomTargetingValue#id custom targeting value} and {@code VALUE} is the {@link CustomTargetingValue#name name}.
To add {@link CustomTargetingKey#id IDs}, you must include {@link Dimension#CUSTOM_DIMENSION} in {@link #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 {@link Dimension#CUSTOM_DIMENSION} in {@link #dimensions}. For example, if {@link #dimensions} contains the following dimensions in the order: {@link Dimension#ADVERTISER_NAME}, {@link Dimension#CUSTOM_DIMENSION} and {@link Dimension#COUNTRY_NAME}, and {@link #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.
startDate - optional; type Date
Represents a date.
- year - optional; type int
  Year (e.g., 2009)
- month - optional; type int
  Month (1..12)
- day - optional; type int
  Day (1..31)
The start date from which the reporting information is gathered. The {@code ReportQuery#dateRangeType} field must be set to {@link DateRangeType#CUSTOM_DATE} in order to use this.
endDate - optional; type Date
Represents a date.
- year - optional; type int
  Year (e.g., 2009)
- month - optional; type int
  Month (1..12)
- day - optional; type int
  Day (1..31)
The end date up to which the reporting information is gathered. The {@code ReportQuery#dateRangeType} field must be set to {@link DateRangeType#CUSTOM_DATE} in order to use this.
dateRangeType - optional; type DateRangeType - type string with restriction - enum { 'TODAY', 'YESTERDAY', 'LAST_WEEK', 'LAST_MONTH', 'LAST_3_MONTHS', 'REACH_LIFETIME', 'CUSTOM_DATE', 'NEXT_DAY', 'NEXT_90_DAYS', 'NEXT_WEEK', 'NEXT_MONTH', 'CURRENT_AND_NEXT_MONTH', 'NEXT_QUARTER', 'NEXT_3_MONTHS', 'NEXT_12_MONTHS' }
The period of time for which the reporting data is being generated. In order to define custom time periods, set this to {@link DateRangeType#CUSTOM_DATE}. If set to {@link DateRangeType#CUSTOM_DATE}, then {@link ReportQuery#startDate} and {@link ReportQuery#endDate} will be used.
statement - optional; type Statement
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 {@link #dateRangeType}, {@link #startDate}, and {@link #endDate}. The syntax currently allowed for {@link Statement#query} is
[WHERE {AND ...}]
:= = := = := IN := : where property is the enumeration name of a {@link 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.
Captures the {@code WHERE}, {@code ORDER BY} and {@code LIMIT} clauses of a PQL query. Statements are typically used to retrieve objects of a predefined domain type, which makes SELECT clause unnecessary.
An example query text might be {@code "WHERE status = 'ACTIVE' ORDER BY id LIMIT 30"}.

Statements support bind variables. These are substitutes for literals and can be thought of as input parameters to a PQL query.

An example of such a query might be {@code "WHERE id = :idValue"}.

Statements also support use of the LIKE keyword. This provides wildcard string matching.

An example of such a query might be {@code "WHERE name LIKE '%searchString%'"}.
The value for the variable idValue must then be set with an object of type {@link Value}, e.g., {@link NumberValue}, {@link TextValue} or {@link BooleanValue}.
- query - optional; type string
 Holds the query in PQL syntax. The syntax is:
 [WHERE {[AND | OR] ...}]
 [ORDER BY [ASC | DESC]]
 [LIMIT {[,] } | { OFFSET }]
 
 := {< | <= | > | >= | = | != }
 
 := {< | <= | > | >= | = | != }
 := IN
 := IS NULL
 := LIKE
 := :
- values - optional, unbounded; type String_ValueMapEntry
 Holds keys and values for bind variables and their values. The key is the name of the bind variable. The value is the literal value of the variable.
 In the example {@code "WHERE status = :bindStatus ORDER BY id LIMIT 30"}, the bind variable, represented by {@code :bindStatus} is named {@code bindStatus}, which would also be the parameter map key. The bind variable's value would be represented by a parameter map value of type {@link TextValue}. The final result, for example, would be an entry of {@code "bindStatus" => StringParam("ACTIVE")}.
 This represents an entry in a map with a key of type String and value of type Value.
 - key - optional; type string
 - value - optional; type Value
 {@code Value} represents a value.
- reportCurrency - optional; type string
 The currency for revenue metrics. Defaults to the network currency if left {@code null}. The supported currency codes can be found in this Help Center article.
- timeZoneType - optional; type TimeZoneType - type string with restriction - enum { 'UNKNOWN', 'PUBLISHER', 'PACIFIC' }

Fault:

ApiException (wsdlsoap:fault, use = literal)Source code

ApiException type ApiExceptionFault

Exception class for holding a list of service errors.

Base class for exceptions.

message - optional; type string
Error message.

errors - optional, unbounded; type ApiError
The API error base class that provides details about an error that occurred while processing a service request.
The OGNL field path is provided for parsers to identify the request data element that may have caused the error.
- fieldPath - optional; type string
  The OGNL field path to identify cause of error.
- fieldPathElements - optional, unbounded; type FieldPathElement
  A parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.
  A segment of a field path. Each dot in a field path defines a new segment.
  - field - optional; type string
    The name of a field in lower camelcase. (e.g. "biddingStrategy")
  - index - optional; type int
    For list fields, this is a 0-indexed position in the list. Null for non-list fields.
- trigger - optional; type string
  The data that caused the error.
- errorString - optional; type string
  A simple string representation of the error and reason.
List of errors.

A fault element of type ApiException.

WSDL source code

<?xml version="1.0"?>

<wsdl:definitions targetNamespace="https://www.google.com/apis/ads/publisher/v202502"

xmlns:tns="https://www.google.com/apis/ads/publisher/v202502"

xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"

xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:wsdlsoap="http://schemas.xmlsoap.org/wsdl/soap/"

<wsdl:types>

<schema elementFormDefault="qualified" jaxb:version="1.0" targetNamespace="https://www.google.com/apis/ads/publisher/v202502"

xmlns:jaxb="http://java.sun.com/xml/ns/jaxb"

<jaxb:globalBindings typesafeEnumMaxMembers="999999"/>

</appinfo>

</annotation>

<documentation>Contains an object value. This object is experimental! <code>ObjectValue</code> is an experimental, innovative, and rapidly changing new feature for Ad Manager. Unfortunately, being on the bleeding edge means that we may make backwards-incompatible changes to <code>ObjectValue</code>. We will inform the community when this feature is no longer experimental.</documentation>

</annotation>

</extension>

</complexContent>

</complexType>

<documentation>The API error base class that provides details about an error that occurred while processing a service request. The OGNL field path is provided for parsers to identify the request data element that may have caused the error.</documentation>

</annotation>

<documentation>The OGNL field path to identify cause of error.</documentation>

</annotation>

</element>

<documentation>A parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.</documentation>

</annotation>

</element>

<documentation>The data that caused the error.</documentation>

</annotation>

</element>

<documentation>A simple string representation of the error and reason.</documentation>

</annotation>

</element>

</sequence>

</complexType>

<documentation>Exception class for holding a list of service errors.</documentation>

</annotation>

<documentation>List of errors.</documentation>

</annotation>

</element>

</sequence>

</extension>

</complexContent>

</complexType>

<documentation>Errors related to the usage of API versions.</documentation>

</annotation>

</sequence>

</extension>

</complexContent>

</complexType>

<documentation>Base class for exceptions.</documentation>

</annotation>

<documentation>Error message.</documentation>

</annotation>

</element>

</sequence>

</complexType>

<documentation>An error for an exception that occurred when authenticating.</documentation>

</annotation>

</sequence>

</extension>

</complexContent>

</complexType>

<documentation>Contains a boolean value.</documentation>

</annotation>

<documentation>The boolean value.</documentation>

</annotation>

</element>

</sequence>

</extension>

</complexContent>

</complexType>

<documentation>Error for the size of the collection being too large</documentation>

</annotation>

</sequence>

</extension>

</complexContent>

</complexType>

<documentation>A place for common errors that can be used across services.</documentation>

</annotation>

</sequence>

</extension>

</complexContent>

</complexType>

<documentation>Errors related to currency codes.</documentation>

</annotation>

</sequence>

</extension>

</complexContent>

</complexType>

<documentation>Represents a date.</documentation>

</annotation>

</annotation>

</element>

<documentation>Month (1..12)</documentation>

</annotation>

</element>

</annotation>

</element>

</sequence>

</complexType>

<documentation>Represents a date combined with the time of day.</documentation>

</annotation>

</sequence>

</complexType>

<documentation>Contains a date-time value.</documentation>

</annotation>

<documentation>The {@code DateTime} value.</documentation>

</annotation>

</element>

</sequence>

</extension>

</complexContent>

</complexType>

<documentation>Contains a date value.</documentation>

</annotation>

<documentation>The {@code Date} value.</documentation>

</annotation>

</element>

</sequence>

</extension>

</complexContent>

</complexType>

<documentation>Errors related to feature management. If you attempt using a feature that is not available to the current network you'll receive a FeatureError with the missing feature as the trigger.</documentation>

</annotation>

</sequence>

</extension>

</complexContent>

</complexType>

<documentation>A segment of a field path. Each dot in a field path defines a new segment.</documentation>

</annotation>

<documentation>The name of a field in lower camelcase. (e.g. "biddingStrategy")</documentation>

</annotation>

</element>

<documentation>For list fields, this is a 0-indexed position in the list. Null for non-list fields.</documentation>

</annotation>

</element>

</sequence>

</complexType>

<documentation>Indicates that a server-side error has occured. {@code InternalApiError}s are generally not the result of an invalid request or message sent by the client.</documentation>

</annotation>

<documentation>The error reason represented by an enum.</documentation>

</annotation>

</element>

</sequence>

</extension>

</complexContent>

</complexType>

<documentation>Caused by supplying a null value for an attribute that cannot be null.</documentation>

</annotation>

<documentation>The error reason represented by an enum.</documentation>

</annotation>

</element>

</sequence>

</extension>

</complexContent>

</complexType>

<documentation>Contains a numeric value.</documentation>

</annotation>

<documentation>The numeric value represented as a string.</documentation>

</annotation>

</element>

</sequence>

</extension>

</complexContent>

</complexType>

<documentation>Lists errors related to parsing.</documentation>

</annotation>

<documentation>The error reason represented by an enum.</documentation>

</annotation>

</element>

</sequence>

</extension>

</complexContent>

</complexType>

<documentation>Errors related to incorrect permission.</documentation>

</annotation>

</sequence>

</extension>

</complexContent>

</complexType>

<documentation>An error that occurs while executing a PQL query contained in a {@link Statement} object.</documentation>

</annotation>

<documentation>The error reason represented by an enum.</documentation>

</annotation>

</element>

</sequence>

</extension>

</complexContent>

</complexType>

<documentation>An error that occurs while parsing a PQL query contained in a {@link Statement} object.</documentation>

</annotation>

<documentation>The error reason represented by an enum.</documentation>

</annotation>

</element>

</sequence>

</extension>

</complexContent>

</complexType>

<documentation>Describes a client-side error on which a user is attempting to perform an action to which they have no quota remaining.</documentation>

</annotation>

</sequence>

</extension>

</complexContent>

</complexType>

<documentation>Represents the options for an API report download request. See {@link ReportService#getReportDownloadUrlWithOptions}.</documentation>

</annotation>

<documentation>The {@link ExportFormat} used to generate the report. Default value is {@link ExportFormat#CSV_DUMP}.</documentation>

</annotation>

</element>

<documentation>Whether or not to include the report properties (e.g. network, user, date generated...) in the generated report. Default is false.</documentation>

</annotation>

</element>

<documentation>Whether or not to include the totals row. Default is true for all formats except {@link ExportFormat#CSV_DUMP}.</documentation>

</annotation>

</element>

<documentation>Whether or not to compress the report file to a gzip file. Default is true. Regardless of value, gzip http compression is available from the URL by normal means.</documentation>

</annotation>

</element>

</sequence>

</complexType>

<documentation>An error for an exception that occurred while running the report.</documentation>

</annotation>

</sequence>

</extension>

</complexContent>

</complexType>

<documentation>Represents a report job that will be run to retrieve performance and statistics information about ad campaigns, networks, inventory and sales.</documentation>

</annotation>

<documentation>The unique ID of the {@code ReportJob}. This value is read-only and is assigned by Google.</documentation>

</annotation>

</element>

<documentation>Holds the filtering criteria.</documentation>

</annotation>

</element>

</sequence>

</complexType>

<documentation>A {@code ReportQuery} object allows you to specify the selection criteria for generating a report. Only reports with at least one {@link Column} are supported.</documentation>

</annotation>

<documentation>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.</documentation>

</annotation>

</element>

<documentation>The ad unit view for the report. Defaults to {@link AdUnitView#TOP_LEVEL}.</documentation>

</annotation>

</element>

<documentation>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.</documentation>

</annotation>

</element>

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

</annotation>

</element>

<documentation>The list of {@link CustomField#id} being requested in this report. To add a {@link CustomField} to the report, you must include its corresponding {@link Dimension}, determined by the {@link CustomField#entityType}, as a {@link #dimensions dimension}. <table> <tr> <th scope="col" colspan="2">{@link CustomFieldEntityType#entityType}</th> </tr> <tr> <td>{@link CustomFieldEntityType#LINE_ITEM}</td><td>{@link Dimension#LINE_ITEM_NAME}</td> </tr> <tr> <td>{@link CustomFieldEntityType#ORDER}</td><td>{@link Dimension#ORDER_NAME}</td> </tr> <tr> <td>{@link CustomFieldEntityType#CREATIVE}</td><td>{@link Dimension#CREATIVE_NAME}</td> </tr> </table></documentation>

</annotation>

</element>

<documentation>The list of content CMS metadata key {@link CmsMetadataKey#id IDs} being requested in this report. Each of these IDs must have been defined in the {@link CmsMetadataKey CMS metadata key}. This will include dimensions in the form of {@code CMS_METADATA_KEY[id]_ID} and {@code CMS_METADATA_KEY[id]_VALUE} where where {@code ID} is the ID of the {@link CmsMetadataValue#id CMS metadata value} and {@code VALUE} is the {@link CmsMetadataValue#valueName name}. To add {@link CmsMetadataKey#id IDs}, you must include {@link Dimension#CMS_METADATA} in {@link #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 {@link Dimension#CMS_METADATA} in {@link #dimensions}. For example, if {@link #dimensions} contains the following dimensions in the order: {@link Dimension#ADVERTISER_NAME}, {@link Dimension#CMS_METADATA} and {@link Dimension#COUNTRY_NAME}, and {@link #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</documentation>

</annotation>

</element>

<documentation>The list of custom dimension custom targeting key {@link CustomTargetingKey#id IDs} being requested in this report. This will include dimensions in the form of {@code TOP_LEVEL_DIMENSION_KEY[id]_ID} and {@code TOP_LEVEL_DIMENSION_KEY[id]_VALUE} where {@code ID} is the ID of the {@link CustomTargetingValue#id custom targeting value} and {@code VALUE} is the {@link CustomTargetingValue#name name}. To add {@link CustomTargetingKey#id IDs}, you must include {@link Dimension#CUSTOM_DIMENSION} in {@link #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 {@link Dimension#CUSTOM_DIMENSION} in {@link #dimensions}. For example, if {@link #dimensions} contains the following dimensions in the order: {@link Dimension#ADVERTISER_NAME}, {@link Dimension#CUSTOM_DIMENSION} and {@link Dimension#COUNTRY_NAME}, and {@link #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.</documentation>

</annotation>

</element>

<documentation>The start date from which the reporting information is gathered. The {@code ReportQuery#dateRangeType} field must be set to {@link DateRangeType#CUSTOM_DATE} in order to use this.</documentation>

</annotation>

</element>

<documentation>The end date up to which the reporting information is gathered. The {@code ReportQuery#dateRangeType} field must be set to {@link DateRangeType#CUSTOM_DATE} in order to use this.</documentation>

</annotation>

</element>

<documentation>The period of time for which the reporting data is being generated. In order to define custom time periods, set this to {@link DateRangeType#CUSTOM_DATE}. If set to {@link DateRangeType#CUSTOM_DATE}, then {@link ReportQuery#startDate} and {@link ReportQuery#endDate} will be used.</documentation>

</annotation>

</element>

<documentation>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 {@link #dateRangeType}, {@link #startDate}, and {@link #endDate}. The syntax currently allowed for {@link Statement#query} is <code> [WHERE <condition> {AND <condition> ...}]<code> <condition></code>      <code>:= <property> = <value></code> <code><condition></code>      <code>:= <property> = <bind variable></code> <code><condition> := <property> IN <list></code> <code><bind variable> := :<name></code> </code> where property is the enumeration name of a {@link 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.</documentation>

</annotation>

</element>

<documentation>The currency for revenue metrics. Defaults to the network currency if left {@code null}. The supported currency codes can be found in <a href="https://support.google.com/adxseller/answer/6019533">this Help Center article.</a></documentation>

</annotation>

</element>

</sequence>

</complexType>

<documentation>A list of all errors to be used for validating sizes of collections.</documentation>

</annotation>

</sequence>

</extension>

</complexContent>

</complexType>

<documentation>Errors due to missing required field.</documentation>

</annotation>

<documentation>The error reason represented by an enum.</documentation>

</annotation>

</element>

</sequence>

</extension>

</complexContent>

</complexType>

<documentation>A saved {@link ReportQuery} representing the selection criteria for running a report.</documentation>

</annotation>

<documentation>The ID of the saved query.</documentation>

</annotation>

</element>

<documentation>The name of the saved query.</documentation>

</annotation>

</element>

<documentation>The {@link ReportQuery} representing the selection criteria for the saved query. This will be non-null if and only if {@link SavedQuery#isCompatibleWithApiVersion} is {@code true}.</documentation>

</annotation>

</element>

<documentation>Whether or not the saved query is compatible with the current API version. This will be {@code true} if and only if {@link SavedQuery#reportQuery} is non-null. A saved query will be incompatible with the API if it uses columns, dimensions, or other reporting features from the UI that are not available in the {@link ReportQuery} entity.</documentation>

</annotation>

</element>

</sequence>

</complexType>

<documentation>A page of {@link SavedQuery} objects.</documentation>

</annotation>

<documentation>The size of the total result set to which this page belongs.</documentation>

</annotation>

</element>

<documentation>The absolute index in the total result set on which this page begins.</documentation>

</annotation>

</element>

<documentation>The collection of saved queries contained within this page.</documentation>

</annotation>

</element>

</sequence>

</complexType>

<documentation>Errors related to the server.</documentation>

</annotation>

</sequence>

</extension>

</complexContent>

</complexType>

<documentation>Contains a set of {@link Value Values}. May not contain duplicates.</documentation>

</annotation>

<documentation>The values. They must all be the same type of {@code Value} and not contain duplicates.</documentation>

</annotation>

</element>

</sequence>

</extension>

</complexContent>

</complexType>

<documentation>Represents the SOAP request header used by API requests.</documentation>

</annotation>

<documentation>The network code to use in the context of a request.</documentation>

</annotation>

</element>

<documentation>The name of client library application.</documentation>

</annotation>

</element>

</sequence>

</complexType>

<documentation>Represents the SOAP request header used by API responses.</documentation>

</annotation>

</sequence>

</complexType>

<documentation>Captures the {@code WHERE}, {@code ORDER BY} and {@code LIMIT} clauses of a PQL query. Statements are typically used to retrieve objects of a predefined domain type, which makes SELECT clause unnecessary. An example query text might be {@code "WHERE status = 'ACTIVE' ORDER BY id LIMIT 30"}. Statements support bind variables. These are substitutes for literals and can be thought of as input parameters to a PQL query. An example of such a query might be {@code "WHERE id = :idValue"}. Statements also support use of the LIKE keyword. This provides wildcard string matching. An example of such a query might be {@code "WHERE name LIKE '%searchString%'"}. The value for the variable idValue must then be set with an object of type {@link Value}, e.g., {@link NumberValue}, {@link TextValue} or {@link BooleanValue}.</documentation>

</annotation>

<documentation>Holds the query in PQL syntax. The syntax is: <code>[WHERE <condition> {[AND | OR] <condition> ...}]</code> <code>[ORDER BY <property> [ASC | DESC]]</code> <code>[LIMIT {[<offset>,] <count>} | {<count> OFFSET <offset>}]</code> <code><condition></code>      <code>:= <property> {< | <= | > | >= | = | != } <value></code> <code><condition></code>      <code>:= <property> {< | <= | > | >= | = | != } <bind variable></code> <code><condition> := <property> IN <list></code> <code><condition> := <property> IS NULL</code> <code><condition> := <property> LIKE <wildcard%match></code> <code><bind variable> := :<name></code> </documentation>

</annotation>

</element>

<documentation>Holds keys and values for bind variables and their values. The key is the name of the bind variable. The value is the literal value of the variable. In the example {@code "WHERE status = :bindStatus ORDER BY id LIMIT 30"}, the bind variable, represented by {@code :bindStatus} is named {@code bindStatus}, which would also be the parameter map key. The bind variable's value would be represented by a parameter map value of type {@link TextValue}. The final result, for example, would be an entry of {@code "bindStatus" => StringParam("ACTIVE")}. </documentation>

</annotation>

</element>

</sequence>

</complexType>

<documentation>An error that occurs while parsing {@link Statement} objects.</documentation>

</annotation>

<documentation>The error reason represented by an enum.</documentation>

</annotation>

</element>

</sequence>

</extension>

</complexContent>

</complexType>

<documentation>A list of error code for reporting invalid content of input strings.</documentation>

</annotation>

</sequence>

</extension>

</complexContent>

</complexType>

<documentation>Errors for Strings which do not meet given length constraints.</documentation>

</annotation>

</sequence>

</extension>

</complexContent>

</complexType>

<documentation>This represents an entry in a map with a key of type String and value of type Value.</documentation>

</annotation>

</sequence>

</complexType>

<documentation>Contains a string value.</documentation>

</annotation>

<documentation>The string value.</documentation>

</annotation>

</element>

</sequence>

</extension>

</complexContent>

</complexType>

<documentation>{@code Value} represents a value.</documentation>

</annotation>

</complexType>

<documentation>A view for an ad unit report.</documentation>

</annotation>

<documentation>Only the top level ad units. Metrics include events for their descendants that are not filtered out.</documentation>

</annotation>

</enumeration>

<documentation>All the ad units. Metrics do not include events for the descendants.</documentation>

</annotation>

</enumeration>

<documentation>Use the ad unit hierarchy. There will be as many ad unit columns as levels of ad units in the generated report: <ul> <li> The column {@link Dimension#AD_UNIT_NAME} is replaced with columns "Ad unit 1", "Ad unit 2", ... "Ad unit n". If level is not applicable to a row, "N/A" is returned as the value. </li> <li> The column {@link Dimension#AD_UNIT_ID} is replaced with columns "Ad unit ID 1", "Ad unit ID 2", ... "Ad unit ID n". If level is not applicable to a row, "N/A" is returned as the value. </li> </ul> Metrics do not include events for the descendants.</documentation>

</annotation>

</enumeration>

</restriction>

</simpleType>

<documentation>Indicates that the operation is not allowed in the version the request was made in.</documentation>

</annotation>

</enumeration>

<documentation>The value returned if the actual value is not exposed by the requested API version.</documentation>

</annotation>

</enumeration>

</restriction>

</simpleType>

<documentation>The SOAP message contains a request header with an ambiguous definition of the authentication header fields. This means either the {@code authToken} and {@code oAuthToken} fields were both null or both were specified. Exactly one value should be specified with each request.</documentation>

</annotation>

</enumeration>

<documentation>The login provided is invalid.</documentation>

</annotation>

</enumeration>

<documentation>Tried to authenticate with provided information, but failed.</documentation>

</annotation>

</enumeration>

<documentation>The OAuth provided is invalid.</documentation>

</annotation>

</enumeration>

<documentation>The specified service to use was not recognized.</documentation>

</annotation>

</enumeration>

<documentation>The SOAP message is missing a request header with an {@code authToken} and optional {@code networkCode}.</documentation>

</annotation>

</enumeration>

<documentation>The HTTP request is missing a request header with an {@code authToken}</documentation>

</annotation>

</enumeration>

<documentation>The request is missing an {@code authToken}</documentation>

</annotation>

</enumeration>

<documentation>The network does not have API access enabled.</documentation>

</annotation>

</enumeration>

<documentation>The user is not associated with any network.</documentation>

</annotation>

</enumeration>

<documentation>No network for the given {@code networkCode} was found.</documentation>

</annotation>

</enumeration>

<documentation>The user has access to more than one network, but did not provide a {@code networkCode}.</documentation>

</annotation>

</enumeration>

<documentation>An error happened on the server side during connection to authentication service.</documentation>

</annotation>

</enumeration>

<documentation>The user tried to create a test network using an account that already is associated with a network.</documentation>

</annotation>

</enumeration>

<documentation>The account is blocked and under investigation by the collections team. Please contact Google for more information.</documentation>

</annotation>

</enumeration>

<documentation>The value returned if the actual value is not exposed by the requested API version.</documentation>

</annotation>

</enumeration>

</restriction>

</simpleType>

<documentation>The value returned if the actual value is not exposed by the requested API version.</documentation>

</annotation>

</enumeration>

</restriction>

</simpleType>

<documentation>{@code Column} provides all the trafficking statistics and revenue information available for the chosen {@link Dimension} objects. Columns with {@code INVENTORY_LEVEL} should not be used with dimensions relating to line items, orders, companies and creatives, such as {@link Dimension#LINE_ITEM_NAME}. Columns with {@code LINE_ITEM_LEVEL} can only be used if you have line item-level dynamic allocation enabled on your network.</documentation>

</annotation>

<documentation>The number of impressions delivered by the ad server. Corresponds to "Ad server impressions" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The number of begin-to-render impressions delivered by the ad server. Corresponds to "Ad server begin to render impressions" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The number of impressions delivered by the ad server by explicit custom criteria targeting. Corresponds to "Ad server targeted impressions" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The number of clicks delivered by the ad server. Corresponds to "Ad server clicks" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The number of clicks delivered by the ad server by explicit custom criteria targeting. Corresponds to "Ad server targeted clicks" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The CTR for an ad delivered by the ad server. Corresponds to "Ad server CTR" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The CPM and CPC revenue earned, calculated in publisher currency, for the ads delivered by the ad server. Corresponds to "Ad server CPM and CPC revenue" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The CPM and CPC revenue earned, calculated in publisher currency, for the ads delivered by the ad server. This includes pre-rev-share revenue for Programmatic traffic. This is a temporary metric to help with the transition from gross to net revenue reporting. Corresponds to "Ad server CPM and CPC revenue (gross)" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The CPD revenue earned, calculated in publisher currency, for the ads delivered by the ad server. Corresponds to "Ad server CPD revenue" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The CPM, CPC and CPD revenue earned, calculated in publisher currency, for the ads delivered by the ad server. Corresponds to "Ad server CPM, CPC, CPD, and vCPM revenue" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The CPM, CPC and CPD gross revenue earned, calculated in publisher currency, for the ads delivered by the ad server. This includes pre-rev-share revenue for Programmatic traffic. This is a temporary metric to help with the transition from gross to net revenue reporting. Corresponds to "Ad server CPM, CPC, CPD, and vCPM revenue (gross)" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The average estimated cost-per-thousand-impressions earned from the CPM and CPC ads delivered by the ad server. Corresponds to "Ad server average eCPM" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The average estimated cost-per-thousand-impressions earned from the CPM, CPC and CPD ads delivered by the ad server.</documentation>

</annotation>

</enumeration>

<documentation>The ratio of the number of impressions delivered to the total impressions delivered by the ad server for line item-level dynamic allocation. Represented as a percentage. Corresponds to "Ad server impressions (%)" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The ratio of the number of clicks delivered to the total clicks delivered by the ad server for line item-level dynamic allocation. Represented as a percentage. Corresponds to "Ad server clicks (%)" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The ratio of revenue generated by ad server to the total CPM and CPC revenue earned by the ads delivered for line item-level dynamic allocation. Represented as a percentage. Corresponds to "Ad server revenue (%)" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The ratio of revenue generated by ad server to the total CPM, CPC and CPD revenue earned by the ads delivered for line item-level dynamic allocation. Represented as a percentage.</documentation>

</annotation>

</enumeration>

<documentation>The number of downloaded impressions delivered by the ad server including impressions recognized as spam. Corresponds to "Ad server unfiltered downloaded impressions" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The number of begin to render impressions delivered by the ad server including impressions recognized as spam. Corresponds to "Ad server unfiltered begin to render impressions" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The number of clicks delivered by the ad server including clicks recognized as spam. Corresponds to "Ad server unfiltered clicks" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The number of impressions an AdSense ad delivered for line item-level dynamic allocation. Corresponds to "AdSense impressions" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The number of impressions an AdSense ad delivered for line item-level dynamic allocation by explicit custom criteria targeting. Corresponds to "AdSense targeted impressions" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The number of clicks an AdSense ad delivered for line item-level dynamic allocation. Corresponds to "AdSense clicks" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The number of clicks an AdSense ad delivered for line item-level dynamic allocation by explicit custom criteria targeting. Corresponds to "AdSense targeted clicks" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The ratio of clicks an AdSense reservation ad delivered to the number of impressions it delivered, including line item-level dynamic allocation. Corresponds to "AdSense CTR" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Revenue generated from AdSense ads delivered for line item-level dynamic allocation. Corresponds to "AdSense revenue" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The average estimated cost-per-thousand-impressions earned from the ads delivered by AdSense for line item-level dynamic allocation. Corresponds to "AdSense average eCPM" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The ratio of the number of impressions delivered by AdSense reservation ads to the total impressions delivered for line item-level dynamic allocation. Represented as a percentage. Corresponds to "AdSense impressions (%)" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The ratio of the number of clicks delivered by AdSense reservation ads to the total clicks delivered for line item-level dynamic allocation. Represented as a percentage. Corresponds to "AdSense clicks (%)" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The ratio of revenue to the total revenue earned from the CPM and CPC ads delivered by AdSense for line item-level dynamic allocation. Represented as a percentage. Corresponds to "AdSense revenue (%)" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The ratio of revenue to the total revenue earned from the CPM, CPC and CPD ads delivered by AdSense for line item-level dynamic allocation. Represented as a percentage.</documentation>

</annotation>

</enumeration>

<documentation>The number of impressions an Ad Exchange ad delivered for line item-level dynamic allocation. Corresponds to "Ad Exchange impressions" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The number of bids associated with the selected dimensions. Corresponds to "Bids" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The average CPM associated with these bids. Corresponds to "Average bid CPM" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of times a yield partner is asked to return bid to fill a yield group request. Only applies to Open Bidding; not Mediation. This data is available for 45 days after the event. Corresponds to "Yield group callouts" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of times a yield group buyer successfully returned a bid in response to a yield group callout, even if that response is "no bids." Only applies to Open Bidding; not Mediation. This data is available for 45 days after the event. Corresponds to "Yield group successful responses" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of bids received from Open Bidding buyers, regardless of whether the returned bid competes in an auction. This number might be greater than Yield group callouts because a buyer can return multiple bids. Only applies to Open Bidding; not Mediation. This data is available for 45 days after the event. Corresponds to "Yield group bids" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of bids received from Open Bidding buyers that competed in the auction. Some bids may be filtered out before the auction runs if the bidder's response omits required fields or contains a creative that violates Google's policies. Learn more about policies and enforcement. Only applies to Open Bidding; not Mediation. This data is available for 45 days after the event. Corresponds to "Yield group bids in auction" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of winning bids received from Open Bidding buyers, even when the winning bid is placed at the end of a mediation for mobile apps chain. Only applies to Open Bidding; not Mediation. This data is available for 45 days after the event. Corresponds to "Yield group auctions won" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of bid requests sent for each deal. Must be broken down by {@code PROGRAMMATIC_DEAL_ID} or {@code PROGRAMMATIC_DEAL_NAME}. Not tracked for Programmatic Guaranteed deals (will show zero on those rows). Corresponds to "Deals bid requests" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of bids placed on each deal. Not tracked for Programmatic Guaranteed deals (will show zero on those rows). Corresponds to "Deals bids" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Bid rate for each deal. Must be broken down by {@code PROGRAMMATIC_DEAL_ID} or {@code PROGRAMMATIC_DEAL_NAME}. Not tracked for Programmatic Guaranteed deals (will show N/A on those rows). Corresponds to "Deals bid rate" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of winning bids for each deal. Not tracked for Programmatic Guaranteed deals (will show zero on those rows). Corresponds to "Deals winning bids" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Win rate for each deal. Not tracked for Programmatic Guaranteed deals (will show N/A on those rows). Corresponds to "Deals win rate" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of matched yield group requests where a yield partner delivered their ad to publisher inventory. Corresponds to "Yield group impressions" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Total net revenue earned by a yield group, based upon the yield group estimated CPM and yield group impressions recorded. This revenue already excludes Google revenue share. Corresponds to "Yield group estimated revenue" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The estimated net rate for yield groups or individual yield group partners. Corresponds to "Yield group estimated CPM" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Yield group Mediation fill rate indicating how often a network fills an ad request. Corresponds to "Mediation fill rate" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Passbacks are counted when an ad network is given a chance to serve but does not deliver an impression, and Ad Manager Mediation moves on to the next ad network in the mediation chain. Passbacks are not currently counted for the "Ad server" demand channel. Corresponds to "Mediation passbacks" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Revenue per thousand impressions based on data collected by Ad Manager from third-party ad network reports. Displays zero if data collection is not enabled. Corresponds to "Mediation third-party eCPM" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Total requests where a Mediation chain was served, even if none of the ad networks delivered an impression. Corresponds to "Mediation chains served" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Mediation third-party average cost-per-thousand-impressions. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The number of impressions an Ad Exchange ad delivered for line item-level dynamic allocation by explicit custom criteria targeting. Corresponds to "Ad Exchange targeted impressions" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The number of clicks an Ad Exchange ad delivered for line item-level dynamic allocation. Corresponds to "Ad Exchange clicks" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The number of clicks an Ad Exchange ad delivered for line item-level dynamic allocation by explicit custom criteria targeting. Corresponds to "Ad Exchange targeted clicks" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The ratio of clicks an Ad Exchange ad delivered to the number of impressions it delivered for line item-level dynamic allocation. Corresponds to "Ad Exchange CTR" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The ratio of the number of impressions delivered to the total impressions delivered by Ad Exchange for line item-level dynamic allocation. Represented as a percentage. Corresponds to "Ad Exchange impressions (%)" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The ratio of the number of clicks delivered to the total clicks delivered by Ad Exchange for line item-level dynamic allocation. Represented as a percentage. Corresponds to "Ad Exchange clicks (%)" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Revenue generated from Ad Exchange ads delivered for line item-level dynamic allocation. Represented in publisher currency and time zone. Corresponds to "Ad Exchange revenue" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The ratio of revenue generated by Ad Exchange to the total revenue earned by CPM and CPC ads delivered for line item-level dynamic allocation. Represented as a percentage. Corresponds to "Ad Exchange revenue (%)" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The ratio of revenue generated by Ad Exchange to the total revenue earned by CPM, CPC and CPD ads delivered for line item-level dynamic allocation. Represented as a percentage.</documentation>

</annotation>

</enumeration>

<documentation>The average estimated cost-per-thousand-impressions earned from the delivery of Ad Exchange ads for line item-level dynamic allocation. Corresponds to "Ad Exchange average eCPM" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The total number of impressions delivered including line item-level dynamic allocation. Corresponds to "Total impressions" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The total number of impressions delivered including line item-level dynamic allocation by explicit custom criteria targeting. Corresponds to "Total targeted impressions" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The total number of clicks delivered including line item-level dynamic allocation. Corresponds to "Total clicks" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The total number of clicks delivered including line item-level dynamic allocation by explicit custom criteria targeting Corresponds to "Total targeted clicks" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The ratio of total clicks on ads delivered by the ad servers to the total number of impressions delivered for an ad including line item-level dynamic allocation. Corresponds to "Total CTR" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The total CPM and CPC revenue generated by the ad servers including line item-level dynamic allocation. Corresponds to "Total CPM and CPC revenue" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The total CPM, CPC and CPD revenue generated by the ad servers including line item-level dynamic allocation. Corresponds to "Total CPM, CPC, CPD, and vCPM revenue" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Estimated cost-per-thousand-impressions (eCPM) of CPM and CPC ads delivered by the ad servers including line item-level dynamic allocation. Corresponds to "Total average eCPM" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Estimated cost-per-thousand-impressions (eCPM) of CPM, CPC and CPD ads delivered by the ad servers including line item-level dynamic allocation.</documentation>

</annotation>

</enumeration>

<documentation>The total number of times that the code for an ad is served by the ad server including inventory-level dynamic allocation. Corresponds to "Total code served count" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The total number of times that an ad request is sent to the ad server including dynamic allocation. Corresponds to "Total ad requests" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The total number of times that an ad is served by the ad server including dynamic allocation. Corresponds to "Total responses served" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The total number of times that an ad is not returned by the ad server. Corresponds to "Total unmatched ad requests" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The fill rate indicating how often an ad request is filled by the ad server including dynamic allocation. Corresponds to "Total fill rate" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The total number of times that an ad is served by the ad server. Corresponds to "Ad server responses served" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The total number of times that an AdSense ad is delivered. Corresponds to "AdSense responses served" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The total number of times that an Ad Exchange ad is delivered. Corresponds to "Ad Exchange responses served" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Total number of ad responses served from programmatic demand sources. Includes Ad Exchange, Open Bidding, and Preferred Deals. Differs from Ad Exchange responses served, which doesn't include Open Bidding matched ad requests. Corresponds to "Programmatic responses served" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The number of programmatic responses served divided by the number of requests eligible for programmatic. Includes Ad Exchange, Open Bidding, and Preferred Deals. Corresponds to "Programmatic match rate" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The total number of ad requests eligible for programmatic inventory, including Programmatic Guaranteed, Preferred Deals, backfill, and open auction. For optimized pods, this metric will count a single opportunity when the pod doesn't fill with programmatic demand. When it does fill, it will count each matched query. Corresponds to "Programmatic eligible ad requests" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The total number of video opportunities. Corresponds to "True opportunities" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The total number of video capped opportunities. Corresponds to "Capped opportunities" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The total number of video matched opportunities. Corresponds to "Matched opportunities" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The total filled duration in ad breaks. Corresponds to "Matched duration (seconds)" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The total duration in ad breaks. Corresponds to "Total duration (seconds)" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The total number of break starts. Corresponds to "Break start" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The total number of break ends. Corresponds to "Break end" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The total number of missed impressions due to the ad servers' inability to find ads to serve, including inventory-level dynamic allocation. Corresponds to "Unfilled impressions" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Corresponds to "Average impressions/unique visitor" in the Ad Manager UI. Compatible with the "Reach" report type.</documentation>

</annotation>

</enumeration>

<documentation>Corresponds to "Total reach impressions" in the Ad Manager UI. Compatible with the "Reach" report type.</documentation>

</annotation>

</enumeration>

<documentation>Corresponds to "Total unique visitors" in the Ad Manager UI. Compatible with the "Reach" report type.</documentation>

</annotation>

</enumeration>

<documentation>The number of impressions for a particular SDK mediation creative. Corresponds to "SDK mediation creative impressions" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The number of clicks for a particular SDK mediation creative. Corresponds to "SDK mediation creative clicks" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The number of forecasted impressions for future sell-through reports. This metric is available for the next 90 days with a daily break down and for the next 12 months with a monthly break down. Corresponds to "Forecasted impressions" in the Ad Manager UI. Compatible with the "Future sell-through" report type.</documentation>

</annotation>

</enumeration>

<documentation>The number of partner-sold impressions served to the YouTube partner ad inventory. Corresponds to "Partner-sold impressions" in the Ad Manager UI. Compatible with the "YouTube consolidated" report type.</documentation>

</annotation>

</enumeration>

<documentation>The number of times the ad server responded to a request for the YouTube partner ad inventory. Corresponds to "Partner-sold code served count" in the Ad Manager UI. Compatible with the "YouTube consolidated" report type.</documentation>

</annotation>

</enumeration>

<documentation>The number of Google-sold impressions served to the YouTube partner ad inventory. Corresponds to "Google-sold impressions" in the Ad Manager UI. Compatible with the "YouTube consolidated" report type.</documentation>

</annotation>

</enumeration>

<documentation>The number of Google-sold reservation impressions served to the YouTube partner ad inventory. Corresponds to "Google-sold reservation impressions" in the Ad Manager UI. Compatible with the "YouTube consolidated" report type.</documentation>

</annotation>

</enumeration>

<documentation>The number of Google-sold auction impressions served to the YouTube partner ad inventory. Corresponds to "Google-sold auction impressions" in the Ad Manager UI. Compatible with the "YouTube consolidated" report type.</documentation>

</annotation>

</enumeration>

<documentation>The total number of ad requests that were eligible to serve to the YouTube partner ad inventory. Corresponds to "Total ad requests" in the Ad Manager UI. Compatible with the "YouTube consolidated" report type.</documentation>

</annotation>

</enumeration>

<documentation>The number of ad requests for the YouTube partner ad inventory that were filled with at least 1 ad. This includes both partner-sold and Google-sold requests. Google-sold can fill at most 2 ads, while partner-sold can fill at most 1 ad. Corresponds to "Filled ad requests" in the Ad Manager UI. Compatible with the "YouTube consolidated" report type.</documentation>

</annotation>

</enumeration>

<documentation>The fill rate percentage of filled requests to total ad requests. Corresponds to "Fill rate" in the Ad Manager UI. Compatible with the "YouTube consolidated" report type.</documentation>

</annotation>

</enumeration>

<documentation>The number of available impressions for future sell-through reports. This metric is available for the next 90 days with a daily break down and for the next 12 months with a monthly break down. Corresponds to "Available impressions" in the Ad Manager UI. Compatible with the "Future sell-through" report type.</documentation>

</annotation>

</enumeration>

<documentation>The number of reserved impressions for future sell-through reports. This metric is available for the next 90 days with a daily break down and for the next 12 months with a monthly break down. Corresponds to "Reserved impressions" in the Ad Manager UI. Compatible with the "Future sell-through" report type.</documentation>

</annotation>

</enumeration>

<documentation>The sell-through rate for impressions for future sell-through reports. This metric is available for the next 90 days with a daily break down and for the next 12 months with a monthly break down. Corresponds to "Sell-through rate" in the Ad Manager UI. Compatible with the "Future sell-through" report type.</documentation>

</annotation>

</enumeration>

<documentation>The total number of times a backup image is served in place of a rich media ad. Corresponds to "Backup image impressions" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The amount of time(seconds) that each rich media ad is displayed to users. Corresponds to "Total display time" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The average amount of time(seconds) that each rich media ad is displayed to users. Corresponds to "Average display time" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The number of times an expanding ad was expanded. Corresponds to "Total expansions" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The average amount of time(seconds) that an expanding ad is viewed in an expanded state. Corresponds to "Average expanding time" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The average amount of time(seconds) that a user interacts with a rich media ad. Corresponds to "Interaction time" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The number of times that a user interacts with a rich media ad. Corresponds to "Total interactions" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The ratio of rich media ad interactions to the number of times the ad was displayed. Represented as a percentage. Corresponds to "Interaction rate" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The average amount of time(seconds) that a user interacts with a rich media ad. Corresponds to "Average interaction time" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The number of impressions where a user interacted with a rich media ad. Corresponds to "Interactive impressions" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The number of times that a user manually closes a floating, expanding, in-page with overlay, or in-page with floating ad. Corresponds to "Manual closes" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>A metric that measures an impression only once when a user opens an ad in full screen mode. Corresponds to "Full-screen impressions" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The number of times a user clicked on the graphical controls of a video player. Corresponds to "Total video interactions" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The ratio of video interactions to video plays. Represented as a percentage. Corresponds to "Video interaction rate" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The number of times a rich media video was muted. Corresponds to "Mute" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The number of times a rich media video was paused. Corresponds to "Pause" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The number of times a rich media video was played. Corresponds to "Plays" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The number of times a rich media video was played up to midpoint. Corresponds to "Midpoint" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The number of times a rich media video was fully played. Corresponds to "Complete" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The number of times a rich media video was restarted. Corresponds to "Replays" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The number of times a rich media video was stopped. Corresponds to "Stops" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The number of times a rich media video was unmuted. Corresponds to "Unmute" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The average amount of time(seconds) that a rich media video was viewed per view. Corresponds to "Average view time" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The percentage of a video watched by a user. Corresponds to "View rate" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The amount of time (seconds) that a user interacts with a rich media ad. Corresponds to "Custom event - time" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The number of times a user views and interacts with a specified part of a rich media ad. Corresponds to "Custom event - count" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The number of impressions where the video was played. Corresponds to "Start" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The number of times the video played to 25% of its length. Corresponds to "First quartile" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The number of times the video reached its midpoint during play. Corresponds to "Midpoint" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The number of times the video played to 75% of its length. Corresponds to "Third quartile" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The number of times the video played to completion. Corresponds to "Complete" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Average percentage of the video watched by users. Corresponds to "Average view rate" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Average time(seconds) users watched the video. Corresponds to "Average view time" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Percentage of times the video played to the end. Corresponds to "Completion rate" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The number of times an error occurred, such as a VAST redirect error, a video playback error, or an invalid response error. Corresponds to "Total error count" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Duration of the video creative. Corresponds to "Video length" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The number of times a skip button is shown in video. Corresponds to "Skip button shown" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The number of engaged views i.e. ad is viewed to completion or for 30s, whichever comes first. Corresponds to "Engaged view" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>View-through rate represented as a percentage. Corresponds to "View-through rate" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of times that the publisher specified a video ad played automatically. Corresponds to "Auto-plays" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of times that the publisher specified a video ad was clicked to play. Corresponds to "Click-to-plays" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Error rate is the percentage of video error count from (error count + total impressions). Corresponds to "Total error rate" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The drop-off rate. Corresponds to "Drop-off rate" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of times a video ad has been viewed to completion or watched to 30 seconds, whichever happens first. Corresponds to "TrueView views" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Percentage of times a user clicked Skip. Corresponds to "TrueView skip rate" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>TrueView views divided by TrueView impressions. Corresponds to "TrueView VTR" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of VAST video errors of type 100. Corresponds to "VAST error 100 count" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of VAST video errors of type 101. Corresponds to "VAST error 101 count" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of VAST video errors of type 102. Corresponds to "VAST error 102 count" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of VAST video errors of type 200. Corresponds to "VAST error 200 count" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of VAST video errors of type 201. Corresponds to "VAST error 201 count" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of VAST video errors of type 202. Corresponds to "VAST error 202 count" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of VAST video errors of type 203. Corresponds to "VAST error 203 count" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of VAST video errors of type 300. Corresponds to "VAST error 300 count" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of VAST video errors of type 301. Corresponds to "VAST error 301 count" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of VAST video errors of type 302. Corresponds to "VAST error 302 count" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of VAST video errors of type 303. Corresponds to "VAST error 303 count" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of VAST video errors of type 400. Corresponds to "VAST error 400 count" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of VAST video errors of type 401. Corresponds to "VAST error 401 count" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of VAST video errors of type 402. Corresponds to "VAST error 402 count" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of VAST video errors of type 403. Corresponds to "VAST error 403 count" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of VAST video errors of type 405. Corresponds to "VAST error 405 count" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of VAST video errors of type 500. Corresponds to "VAST error 500 count" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of VAST video errors of type 501. Corresponds to "VAST error 501 count" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of VAST video errors of type 502. Corresponds to "VAST error 502 count" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of VAST video errors of type 503. Corresponds to "VAST error 503 count" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of VAST video errors of type 600. Corresponds to "VAST error 600 count" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of VAST video errors of type 601. Corresponds to "VAST error 601 count" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of VAST video errors of type 602. Corresponds to "VAST error 602 count" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of VAST video errors of type 603. Corresponds to "VAST error 603 count" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of VAST video errors of type 604. Corresponds to "VAST error 604 count" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of VAST video errors of type 900. Corresponds to "VAST error 900 count" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of VAST video errors of type 901. Corresponds to "VAST error 901 count" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Video interaction event: The number of times user paused ad clip. Corresponds to "Pause" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Video interaction event: The number of times the user unpaused the video. Corresponds to "Resume" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Video interaction event: The number of times a user rewinds the video. Corresponds to "Rewind" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Video interaction event: The number of times video player was in mute state during play of ad clip. Corresponds to "Mute" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Video interaction event: The number of times a user unmutes the video. Corresponds to "Unmute" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Video interaction event: The number of times a user collapses a video, either to its original size or to a different size. Corresponds to "Collapse" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Video interaction event: The number of times a user expands a video. Corresponds to "Expand" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Video interaction event: The number of times ad clip played in full screen mode. Corresponds to "Full screen" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Video interaction event: The number of user interactions with a video, on average, such as pause, full screen, mute, etc. Corresponds to "Average interaction rate" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Video interaction event: The number of times a skippable video is skipped. Corresponds to "Video skipped" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The number of control starts. Corresponds to "Control starts" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The number of optimized starts. Corresponds to "Optimized starts" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The number of control completes. Corresponds to "Control completes" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The number of optimized completes. Corresponds to "Optimized completes" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The rate of control completions. Corresponds to "Control completion rate" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The rate of optimized completions. Corresponds to "Optimized completion rate" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The percentage by which optimized completion rate is greater than the unoptimized completion rate. This is calculated as (( {@link Column#VIDEO_OPTIMIZATION_OPTIMIZED_COMPLETION_RATE}/ {@link Column#VIDEO_OPTIMIZATION_CONTROL_COMPLETION_RATE}) - 1) * 100 for an ad for which the optimization feature has been enabled. Corresponds to "Completion rate lift" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The number of control skip buttons shown. Corresponds to "Control skip button shown" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The number of optimized skip buttons shown. Corresponds to "Optimized skip button shown" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The number of control engaged views. Corresponds to "Control engaged view" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The number of optimized engaged views. Corresponds to "Optimized engaged view" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The control view-through rate. Corresponds to "Control view-through rate" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The optimized view-through rate. Corresponds to "Optimized view-through rate" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The percentage by which optimized view-through rate is greater than the unoptimized view-through rate. This is calculated as (( {@link Column#VIDEO_OPTIMIZATION_OPTIMIZED_VIEW_THROUGH_RATE}/ {@link Column#VIDEO_OPTIMIZATION_CONTROL_VIEW_THROUGH_RATE}) - 1) * 100 for an ad for which the optimization feature has been enabled. Corresponds to "View-through rate lift" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Total impressions from the Google Ad Manager server, AdSense, Ad Exchange, and yield group partners. Corresponds to "Total impressions" in the Ad Manager UI. Compatible with the "Real-time video" report type.</documentation>

</annotation>

</enumeration>

<documentation>Total number of matched queries. Corresponds to "Total responses served" in the Ad Manager UI. Compatible with the "Real-time video" report type.</documentation>

</annotation>

</enumeration>

<documentation>Total number of unmatched queries. Corresponds to "Total unmatched ad requests" in the Ad Manager UI. Compatible with the "Real-time video" report type.</documentation>

</annotation>

</enumeration>

<documentation>Total number of ad requests. Corresponds to "Total ad requests" in the Ad Manager UI. Compatible with the "Real-time video" report type.</documentation>

</annotation>

</enumeration>

<documentation>Total number of creatives served. Corresponds to "Total creative serves" in the Ad Manager UI. Compatible with the "Real-time video" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of VAST video errors of type 100. Corresponds to "VAST error 100 count" in the Ad Manager UI. Compatible with the "Real-time video" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of VAST video errors of type 101. Corresponds to "VAST error 101 count" in the Ad Manager UI. Compatible with the "Real-time video" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of VAST video errors of type 102. Corresponds to "VAST error 102 count" in the Ad Manager UI. Compatible with the "Real-time video" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of VAST video errors of type 200. Corresponds to "VAST error 200 count" in the Ad Manager UI. Compatible with the "Real-time video" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of VAST video errors of type 201. Corresponds to "VAST error 201 count" in the Ad Manager UI. Compatible with the "Real-time video" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of VAST video errors of type 202. Corresponds to "VAST error 202 count" in the Ad Manager UI. Compatible with the "Real-time video" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of VAST video errors of type 203. Corresponds to "VAST error 203 count" in the Ad Manager UI. Compatible with the "Real-time video" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of VAST video errors of type 300. Corresponds to "VAST error 300 count" in the Ad Manager UI. Compatible with the "Real-time video" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of VAST video errors of type 301. Corresponds to "VAST error 301 count" in the Ad Manager UI. Compatible with the "Real-time video" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of VAST video errors of type 302. Corresponds to "VAST error 302 count" in the Ad Manager UI. Compatible with the "Real-time video" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of VAST video errors of type 303. Corresponds to "VAST error 303 count" in the Ad Manager UI. Compatible with the "Real-time video" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of VAST video errors of type 400. Corresponds to "VAST error 400 count" in the Ad Manager UI. Compatible with the "Real-time video" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of VAST video errors of type 401. Corresponds to "VAST error 401 count" in the Ad Manager UI. Compatible with the "Real-time video" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of VAST video errors of type 402. Corresponds to "VAST error 402 count" in the Ad Manager UI. Compatible with the "Real-time video" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of VAST video errors of type 403. Corresponds to "VAST error 403 count" in the Ad Manager UI. Compatible with the "Real-time video" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of VAST video errors of type 405. Corresponds to "VAST error 405 count" in the Ad Manager UI. Compatible with the "Real-time video" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of VAST video errors of type 500. Corresponds to "VAST error 500 count" in the Ad Manager UI. Compatible with the "Real-time video" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of VAST video errors of type 501. Corresponds to "VAST error 501 count" in the Ad Manager UI. Compatible with the "Real-time video" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of VAST video errors of type 502. Corresponds to "VAST error 502 count" in the Ad Manager UI. Compatible with the "Real-time video" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of VAST video errors of type 503. Corresponds to "VAST error 503 count" in the Ad Manager UI. Compatible with the "Real-time video" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of VAST video errors of type 600. Corresponds to "VAST error 600 count" in the Ad Manager UI. Compatible with the "Real-time video" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of VAST video errors of type 601. Corresponds to "VAST error 601 count" in the Ad Manager UI. Compatible with the "Real-time video" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of VAST video errors of type 602. Corresponds to "VAST error 602 count" in the Ad Manager UI. Compatible with the "Real-time video" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of VAST video errors of type 603. Corresponds to "VAST error 603 count" in the Ad Manager UI. Compatible with the "Real-time video" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of VAST video errors of type 604. Corresponds to "VAST error 604 count" in the Ad Manager UI. Compatible with the "Real-time video" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of VAST video errors of type 900. Corresponds to "VAST error 900 count" in the Ad Manager UI. Compatible with the "Real-time video" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of VAST video errors of type 901. Corresponds to "VAST error 901 count" in the Ad Manager UI. Compatible with the "Real-time video" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of VAST video errors of type 406. Corresponds to "VAST error 406 count" in the Ad Manager UI. Compatible with the "Real-time video" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of VAST video errors of type 407. Corresponds to "VAST error 407 count" in the Ad Manager UI. Compatible with the "Real-time video" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of VAST video errors of type 408. Corresponds to "VAST error 408 count" in the Ad Manager UI. Compatible with the "Real-time video" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of VAST video errors of type 409. Corresponds to "VAST error 409 count" in the Ad Manager UI. Compatible with the "Real-time video" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of VAST video errors of type 410. Corresponds to "VAST error 410 count" in the Ad Manager UI. Compatible with the "Real-time video" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of total VAST video errors. Corresponds to "Total error count" in the Ad Manager UI. Compatible with the "Real-time video" report type.</documentation>

</annotation>

</enumeration>

<documentation>The total number of impressions viewed on the user's screen. Corresponds to "Total Active View viewable impressions" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The total number of impressions that were sampled and measured by active view. Corresponds to "Total Active View measurable impressions" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The percentage of total impressions viewed on the user's screen (out of the total impressions measurable by active view).</documentation>

</annotation>

</enumeration>

<documentation>Total number of impressions that were eligible to measure viewability. Corresponds to "Total Active View eligible impressions" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The percentage of total impressions that were measurable by active view (out of all the total impressions sampled for active view). Corresponds to "Total Active View % measurable impressions" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Active View total average time in seconds that specific impressions are reported as being viewable. Corresponds to "Total Active View average viewable time (seconds)" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The percentage of total impressions from video creatives with audible playback at start, from all total measurable impressions for Active View. Corresponds to "Active View % audible at start" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The percentage of total impressions from video creatives where volume > 0 at any point, from all total impressions measurable for Active View. Corresponds to "Active View % ever audible" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The number of impressions delivered by the ad server viewed on the user's screen. Corresponds to "Ad server Active View viewable impressions" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The number of impressions delivered by the ad server that were sampled, and measurable by active view. Corresponds to "Ad server Active View measurable impressions" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The percentage of impressions delivered by the ad server viewed on the user's screen (out of the ad server impressions measurable by active view). Corresponds to "Ad server Active View % viewable impressions" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Total number of impressions delivered by the ad server that were eligible to measure viewability. Corresponds to "Ad server Active View eligible impressions" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The percentage of impressions delivered by the ad server that were measurable by active view ( out of all the ad server impressions sampled for active view). Corresponds to "Ad server Active View % measurable impressions" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Active View ad server revenue. Corresponds to "Ad server Active View revenue" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Active View ad server average time in seconds that specific impressions are reported as being viewable. Corresponds to "Ad server Active View average viewable time (seconds)" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The number of impressions delivered by AdSense viewed on the user's screen, Corresponds to "AdSense Active View viewable impressions" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The number of impressions delivered by AdSense that were sampled, and measurable by active view. Corresponds to "AdSense Active View measurable impressions" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The percentage of impressions delivered by AdSense viewed on the user's screen (out of AdSense impressions measurable by active view). Corresponds to "AdSense Active View % viewable impressions" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Total number of impressions delivered by AdSense that were eligible to measure viewability. Corresponds to "AdSense Active View eligible impressions" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The percentage of impressions delivered by AdSense that were measurable by active view ( out of all AdSense impressions sampled for active view). Corresponds to "AdSense Active View % measurable impressions" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Active View AdSense average time in seconds that specific impressions are reported as being viewable. Corresponds to "AdSense Active View average viewable time (seconds)" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The number of impressions delivered by Ad Exchange viewed on the user's screen, Corresponds to "Ad Exchange Active View viewable impressions" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The number of impressions delivered by Ad Exchange that were sampled, and measurable by active view. Corresponds to "Ad Exchange Active View measurable impressions" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The percentage of impressions delivered by Ad Exchange viewed on the user's screen (out of Ad Exchange impressions measurable by active view). Corresponds to "Ad Exchange Active View % viewable impressions" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Total number of impressions delivered by Ad Exchange that were eligible to measure viewability. Corresponds to "Ad Exchange Active View eligible impressions" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The percentage of impressions delivered by Ad Exchange that were measurable by active view ( out of all Ad Exchange impressions sampled for active view). Corresponds to "Ad Exchange Active View % measurable impressions" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Active View AdExchange average time in seconds that specific impressions are reported as being viewable. Corresponds to "Ad Exchange Active View average viewable time (seconds)" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The total number of queries sent to Ad Exchange. Corresponds to "Ad Exchange ad requests" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The fraction of Ad Exchange queries that result in a matched query. Also known as "Coverage". Corresponds to "Ad Exchange match rate" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The amount earned per click on Ad Exchange. Corresponds to "Ad Exchange CPC" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The fraction of Ad Exchange requests that result in a click. Corresponds to "Ad Exchange ad request CTR" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The fraction of Ad Exchange matched requests that result in a click. Corresponds to "Ad Exchange matched request CTR" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The amount earned per thousand Ad Exchange requests. Corresponds to "Ad Exchange ad request eCPM" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The amount earned per thousand Ad Exchange matched requests. Corresponds to "Ad Exchange matched request eCPM" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The increase in Ad Exchange revenue gained for won impressions over the applicable minimum CPM or the best price specified during dynamic allocation. Corresponds to "Ad Exchange lift" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Active View total revenue. Corresponds to "Total Active View revenue" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The number of impressions sent to Ad Exchange / AdSense, regardless of whether they won or lost (total number of dynamic allocation impressions). Corresponds to "Impressions competing" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The number of unfilled queries that attempted dynamic allocation by Ad Exchange / AdSense. Corresponds to "Unfilled competing impressions" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The number of Ad Exchange / AdSense and Ad Manager impressions. Corresponds to "Eligible impressions" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The difference between eligible impressions and competing impressions in dynamic allocation.</documentation>

</annotation>

</enumeration>

<documentation>The percentage of eligible impressions that are not competing in dynamic allocation. Corresponds to "Impressions not competing (%)" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The percent of eligible impressions participating in dynamic allocation.</documentation>

</annotation>

</enumeration>

<documentation>The percent of total dynamic allocation queries that won. Corresponds to "Dynamic allocation match rate" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The number of invoiced impressions. Corresponds to "Invoiced impressions" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The number of invoiced unfilled impressions. Corresponds to "Invoiced unfilled impressions" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The total number of impressions tracked for Nielsen Digital Ad Ratings measurement. Corresponds to "Impressions" in the Ad Manager UI. Compatible with the "Reach" report type.</documentation>

</annotation>

</enumeration>

<documentation>The total number of impressions for in-target demographic tracked for Nielsen Digital Ad Ratings measurement. Corresponds to "In-target impressions" in the Ad Manager UI. Compatible with the "Reach" report type.</documentation>

</annotation>

</enumeration>

<documentation>The population in the demographic. Corresponds to "Population base" in the Ad Manager UI. Compatible with the "Reach" report type.</documentation>

</annotation>

</enumeration>

<documentation>The total population for all in-target demographics. Compatible with the "Reach" report type.</documentation>

</annotation>

</enumeration>

<documentation>The total number of different people within the selected demographic who were reached. Corresponds to "Unique audience" in the Ad Manager UI. Compatible with the "Reach" report type.</documentation>

</annotation>

</enumeration>

<documentation>The total number of different people within all in-target demographics who were reached. Compatible with the "Reach" report type.</documentation>

</annotation>

</enumeration>

<documentation>The unique audience reached as a percentage of the population base. Corresponds to "% audience reach" in the Ad Manager UI. Compatible with the "Reach" report type.</documentation>

</annotation>

</enumeration>

<documentation>The unique audience reached as a percentage of the population base for all in-target demographics. Compatible with the "Reach" report type.</documentation>

</annotation>

</enumeration>

<documentation>The average number of times that a person within the target audience sees an advertisement. Corresponds to "Average frequency" in the Ad Manager UI. Compatible with the "Reach" report type.</documentation>

</annotation>

</enumeration>

<documentation>The average number of times that a person within the target audience sees an advertisement for all in-target demographics. Compatible with the "Reach" report type.</documentation>

</annotation>

</enumeration>

<documentation>The unit of audience volume, which is based on the percentage of the reached target audience population multiplied by the average frequency. Corresponds to "Gross rating points" in the Ad Manager UI. Compatible with the "Reach" report type.</documentation>

</annotation>

</enumeration>

<documentation>The unit of audience volume, which is based on the percentage of the reached target audience population multiplied by the average frequency, for all in-target demographics. Compatible with the "Reach" report type.</documentation>

</annotation>

</enumeration>

<documentation>The share of impressions that reached the target demographic. Corresponds to "% impression share" in the Ad Manager UI. Compatible with the "Reach" report type.</documentation>

</annotation>

</enumeration>

<documentation>The share of impressions that reached all in-target demographics. Corresponds to "In-target % impression share" in the Ad Manager UI. Compatible with the "Reach" report type.</documentation>

</annotation>

</enumeration>

<documentation>The share of the total population represented by the population base. Corresponds to "% population share" in the Ad Manager UI. Compatible with the "Reach" report type.</documentation>

</annotation>

</enumeration>

<documentation>The share of the total population for all in-target demographics represented by the population base. Compatible with the "Reach" report type.</documentation>

</annotation>

</enumeration>

<documentation>The share of the unique audience in the demographic. Corresponds to "% audience share" in the Ad Manager UI. Compatible with the "Reach" report type.</documentation>

</annotation>

</enumeration>

<documentation>The share of the unique audience for all in-target demographics. Compatible with the "Reach" report type.</documentation>

</annotation>

</enumeration>

<documentation>The relative unique audience in the demographic compared with its share of the overall population. Corresponds to "Audience index" in the Ad Manager UI. Compatible with the "Reach" report type.</documentation>

</annotation>

</enumeration>

<documentation>The relative unique audience for all in-target demographics compared with its share of the overall population. Compatible with the "Reach" report type.</documentation>

</annotation>

</enumeration>

<documentation>The relative impressions per person in the demographic compared with the impressions per person for the overall population. Corresponds to "Impressions index" in the Ad Manager UI. Compatible with the "Reach" report type.</documentation>

</annotation>

</enumeration>

<documentation>The relative impressions per person for all in-target demographics compared with the impressions per person for the overall population. Compatible with the "Reach" report type.</documentation>

</annotation>

</enumeration>

<documentation>The adjusted in-target impression share used for pacing and billing, based on the GRP pacing preferences indicated in your line item settings. Corresponds to "Processed Nielsen in-target rate" in the Ad Manager UI. Compatible with the "Reach" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of impressions delivered. Corresponds to "Impressions" in the Ad Manager UI. Compatible with the "Ad Connector" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of clicks delivered Corresponds to "Clicks" in the Ad Manager UI. Compatible with the "Ad Connector" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of requests. Corresponds to "Queries" in the Ad Manager UI. Compatible with the "Ad Connector" report type.</documentation>

</annotation>

</enumeration>

<documentation>Number of requests where a buyer was matched with the Ad request. Corresponds to "Matched queries" in the Ad Manager UI. Compatible with the "Ad Connector" report type.</documentation>

</annotation>

</enumeration>

<documentation>The revenue earned, calculated in publisher currency, for the ads delivered. Corresponds to "Cost" in the Ad Manager UI. Compatible with the "Ad Connector" report type.</documentation>

</annotation>

</enumeration>

<documentation>The average estimated cost-per-thousand-impressions earned from ads delivered. Corresponds to "Total Average eCPM" in the Ad Manager UI. Compatible with the "Ad Connector" report type.</documentation>

</annotation>

</enumeration>

<documentation>Total number of impressions delivered by the ad server that were eligible to measure viewability. Corresponds to "Total Active View eligible impressions" in the Ad Manager UI. Compatible with the "Ad Connector" report type.</documentation>

</annotation>

</enumeration>

<documentation>The number of impressions delivered that were sampled and measurable by active view. Corresponds to "Total Active View measurable impressions" in the Ad Manager UI. Compatible with the "Ad Connector" report type.</documentation>

</annotation>

</enumeration>

<documentation>The number of impressions delivered that were viewed on the user's screen. Corresponds to "Total Active View viewable impressions" in the Ad Manager UI. Compatible with the "Ad Connector" report type.</documentation>

</annotation>

</enumeration>

<documentation>The percentage of impressions delivered that were measurable by active view (out of all the impressions sampled for active view). Corresponds to "Total Active View % measurable impressions" in the Ad Manager UI. Compatible with the "Ad Connector" report type.</documentation>

</annotation>

</enumeration>

<documentation>The percentage of impressions delivered thar were viewed on the user's screen (out of the impressions measurable by active view). Corresponds to "Total Active View % viewable impressions" in the Ad Manager UI. Compatible with the "Ad Connector" report type.</documentation>

</annotation>

</enumeration>

<documentation>The host impressions in the partner management. Corresponds to "Host impressions" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The host clicks in the partner management. Corresponds to "Host clicks" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The host CTR in the partner management. Corresponds to "Host CTR" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The unfilled impressions in the partner management. Corresponds to "Unfilled impressions" in the Ad Manager UI. Compatible with any of the following report types: Historical, Partner finance.</documentation>

</annotation>

</enumeration>

<documentation>The partner impressions in the partner management. Corresponds to "Partner impressions" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The partner clicks in the partner management. Corresponds to "Partner clicks" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The partner CTR in the partner management. Corresponds to "Partner CTR" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The gross revenue in the partner management. Corresponds to "Gross revenue" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Monthly host impressions for partner finance reports. Corresponds to "Host impressions" in the Ad Manager UI. Compatible with the "Partner finance" report type.</documentation>

</annotation>

</enumeration>

<documentation>Monthly host revenue for partner finance reports. Corresponds to "Host revenue" in the Ad Manager UI. Compatible with the "Partner finance" report type.</documentation>

</annotation>

</enumeration>

<documentation>Monthly host eCPM for partner finance reports. Corresponds to "Host eCPM" in the Ad Manager UI. Compatible with the "Partner finance" report type.</documentation>

</annotation>

</enumeration>

<documentation>Monthly partner revenue for partner finance reports. Corresponds to "Partner revenue" in the Ad Manager UI. Compatible with the "Partner finance" report type.</documentation>

</annotation>

</enumeration>

<documentation>Monthly partner eCPM for partner finance reports. Corresponds to "Partner eCPM" in the Ad Manager UI. Compatible with the "Partner finance" report type.</documentation>

</annotation>

</enumeration>

<documentation>Monthly gross revenue for partner finance reports. Corresponds to "Gross revenue" in the Ad Manager UI. Compatible with the "Partner finance" report type.</documentation>

</annotation>

</enumeration>

<documentation>The ratio of the number of impressions for which the creative load time is between 0 and 500 ms to the total number of impressions that have ad latency data, represented as a percentage. Corresponds to "Creative load time 0 - 500ms (%)" in the Ad Manager UI. Compatible with the "Ad speed" report type.</documentation>

</annotation>

</enumeration>

<documentation>The ratio of the number of impressions for which the creative load time is between 500 milliseconds and 1 second to the total number of impressions that have ad latency data, represented as a percentage. Corresponds to "Creative load time 500ms - 1s (%)" in the Ad Manager UI. Compatible with the "Ad speed" report type.</documentation>

</annotation>

</enumeration>

<documentation>The ratio of the number of impressions for which the creative load time is between 1 second and 2 seconds to the total number of impressions that have ad latency data, represented as a percentage. Corresponds to "Creative load time 1s - 2s (%)" in the Ad Manager UI. Compatible with the "Ad speed" report type.</documentation>

</annotation>

</enumeration>

<documentation>The ratio of the number of impressions for which the creative load time is between 2 seconds and 4 seconds to the total number of impressions that have ad latency data, represented as a percentage. Corresponds to "Creative load time 2s - 4s (%)" in the Ad Manager UI. Compatible with the "Ad speed" report type.</documentation>

</annotation>

</enumeration>

<documentation>The ratio of the number of impressions for which the creative load time is between 4 seconds and 8 seconds to the total number of impressions that have ad latency data, represented as a percentage. Corresponds to "Creative load time 4s - 8s (%)" in the Ad Manager UI. Compatible with the "Ad speed" report type.</documentation>

</annotation>

</enumeration>

<documentation>The ratio of the number of impressions for which the creative load time is greater than 8 seconds to the total number of impressions that have ad latency data, represented as a percentage. Corresponds to "Creative load time >8s (%)" in the Ad Manager UI. Compatible with the "Ad speed" report type.</documentation>

</annotation>

</enumeration>

<documentation>The ratio of the number of impressions which are unviewed because the ad slot never entered the viewport to the total number of impressions that have ad latency data, represented as a percentage. Corresponds to "Slot never entered viewport (%)" in the Ad Manager UI. Compatible with the "Ad speed" report type.</documentation>

</annotation>

</enumeration>

<documentation>The ratio of the number of impressions which are unviewed because the user scrolled before the ad filled to the total number of impressions that have ad latency data, represented as a percentage. Corresponds to "User scrolled before ad filled (%)" in the Ad Manager UI. Compatible with the "Ad speed" report type.</documentation>

</annotation>

</enumeration>

<documentation>The ratio of the number of impressions which are unviewed because the user scrolled or navigated before the ad loaded to the total number of impressions that have ad latency data, represented as a percentage. Corresponds to "User scrolled/navigated before ad loaded (%)" in the Ad Manager UI. Compatible with the "Ad speed" report type.</documentation>

</annotation>

</enumeration>

<documentation>The ratio of the number of impressions which are unviewed because the user scrolled or navigated before one second to the total number of impressions that have ad latency data, represented as a percentage. Corresponds to "User scrolled/navigated before 1 second (%)" in the Ad Manager UI. Compatible with the "Ad speed" report type.</documentation>

</annotation>

</enumeration>

<documentation>The ratio of the number of impressions which are unviewed because the of another non-viewable-impression reason to the total number of impressions that have ad latency data, represented as a percentage. Corresponds to "Other non-viewable impression reasons (%)" in the Ad Manager UI. Compatible with the "Ad speed" report type.</documentation>

</annotation>

</enumeration>

<documentation>The ratio of the number of impressions for which the DOM load to tag log time is between 0 and 500 milliseconds to the total number of impressions that have ad latency data, represented as a percentage. Corresponds to "Page navigation to tag loaded time 0 - 500ms (%)" in the Ad Manager UI. Compatible with the "Ad speed" report type.</documentation>

</annotation>

</enumeration>

<documentation>The ratio of the number of impressions for which the DOM load to tag log time is between 500 milliseconds and 1 second to the total number of impressions that have ad latency data, represented as a percentage. Corresponds to "Page navigation to tag loaded time 500ms - 1s (%)" in the Ad Manager UI. Compatible with the "Ad speed" report type.</documentation>

</annotation>

</enumeration>

<documentation>The ratio of the number of impressions for which the DOM load to tag log time is between 1 second and 2 seconds to the total number of impressions that have ad latency data, represented as a percentage. Corresponds to "Page navigation to tag loaded time 1s - 2s (%)" in the Ad Manager UI. Compatible with the "Ad speed" report type.</documentation>

</annotation>

</enumeration>

<documentation>The ratio of the number of impressions for which the DOM load to tag log time is between 2 seconds and 4 seconds to the total number of impressions that have ad latency data, represented as a percentage. Corresponds to "Page navigation to tag loaded time 2s - 4s (%)" in the Ad Manager UI. Compatible with the "Ad speed" report type.</documentation>

</annotation>

</enumeration>

<documentation>The ratio of the number of impressions for which the DOM load to tag log time is between 4 seconds and 8 seconds to the total number of impressions that have ad latency data, represented as a percentage. Corresponds to "Page navigation to tag loaded time 4s - 8s (%)" in the Ad Manager UI. Compatible with the "Ad speed" report type.</documentation>

</annotation>

</enumeration>

<documentation>The ratio of the number of impressions for which the DOM load to tag log time is greater than 8 seconds to the total number of impressions that have ad latency data, represented as a percentage. Corresponds to "Page navigation to tag loaded time >8s (%)" in the Ad Manager UI. Compatible with the "Ad speed" report type.</documentation>

</annotation>

</enumeration>

<documentation>The ratio of the number of impressions for which the DOM load to first ad request time is between 0 and 500 milliseconds to the total number of impressions that have ad latency data, represented as a percentage. Corresponds to "Page navigation to first ad request time 0 - 500ms (%)" in the Ad Manager UI. Compatible with the "Ad speed" report type.</documentation>

</annotation>

</enumeration>

<documentation>The ratio of the number of impressions for which the DOM load to first ad request time is between 500 milliseconds and 1 second to the total number of impressions that have ad latency data, represented as a percentage. Corresponds to "Page navigation to first ad request time 500ms - 1s (%)" in the Ad Manager UI. Compatible with the "Ad speed" report type.</documentation>

</annotation>

</enumeration>

<documentation>The ratio of the number of impressions for which the DOM load to first ad request time is between 1 second and 2 seconds to the total number of impressions that have ad latency data, represented as a percentage. Corresponds to "Page navigation to first ad request time 1s - 2s (%)" in the Ad Manager UI. Compatible with the "Ad speed" report type.</documentation>

</annotation>

</enumeration>

<documentation>The ratio of the number of impressions for which the DOM load to first ad request time is between 2 seconds and 4 seconds to the total number of impressions that have ad latency data, represented as a percentage. Corresponds to "Page navigation to first ad request time 2s - 4s (%)" in the Ad Manager UI. Compatible with the "Ad speed" report type.</documentation>

</annotation>

</enumeration>

<documentation>The ratio of the number of impressions for which the DOM load to first ad request time is between 4 seconds and 8 seconds to the total number of impressions that have ad latency data, represented as a percentage. Corresponds to "Page navigation to first ad request time 4s - 8s (%)" in the Ad Manager UI. Compatible with the "Ad speed" report type.</documentation>

</annotation>

</enumeration>

<documentation>The ratio of the number of impressions for which the DOM load to first ad request time is greater than 8 seconds to the total number of impressions that have ad latency data, represented as a percentage. Corresponds to "Page navigation to first ad request time >8s (%)" in the Ad Manager UI. Compatible with the "Ad speed" report type.</documentation>

</annotation>

</enumeration>

<documentation>The ratio of the number of impressions for which the tag load to first ad request time is between 0 and 500 milliseconds to the total number of impressions that have ad latency data, represented as a percentage. Corresponds to "Tag loaded to first ad request time 0 - 500ms (%)" in the Ad Manager UI. Compatible with the "Ad speed" report type.</documentation>

</annotation>

</enumeration>

<documentation>The ratio of the number of impressions for which the tag load to first ad request time is between 500 milliseconds and 1 second to the total number of impressions that have ad latency data, represented as a percentage. Corresponds to "Tag loaded to first ad request time 500ms - 1s (%)" in the Ad Manager UI. Compatible with the "Ad speed" report type.</documentation>

</annotation>

</enumeration>

<documentation>The ratio of the number of impressions for which the tag load to first ad request time is between 1 second and 2 seconds to the total number of impressions that have ad latency data, represented as a percentage. Corresponds to "Tag loaded to first ad request time 1s - 2s (%)" in the Ad Manager UI. Compatible with the "Ad speed" report type.</documentation>

</annotation>

</enumeration>

<documentation>The ratio of the number of impressions for which the tag load to first ad request time is between 2 seconds and 4 seconds to the total number of impressions that have ad latency data, represented as a percentage. Corresponds to "Tag loaded to first ad request time 2s - 4s (%)" in the Ad Manager UI. Compatible with the "Ad speed" report type.</documentation>

</annotation>

</enumeration>

<documentation>The ratio of the number of impressions for which the tag load to first ad request time is between 4 seconds and 8 seconds to the total number of impressions that have ad latency data, represented as a percentage. Corresponds to "Tag loaded to first ad request time 4s - 8s (%)" in the Ad Manager UI. Compatible with the "Ad speed" report type.</documentation>

</annotation>

</enumeration>

<documentation>The ratio of the number of impressions for which the tag load to first ad request time is greater than 8 seconds to the total number of impressions that have ad latency data, represented as a percentage. Corresponds to "Tag loaded to first ad request time >8s (%)" in the Ad Manager UI. Compatible with the "Ad speed" report type.</documentation>

</annotation>

</enumeration>

</restriction>

</simpleType>

<documentation>Describes reasons for common errors</documentation>

</annotation>

<documentation>Indicates that an attempt was made to retrieve an entity that does not exist.</documentation>

</annotation>

</enumeration>

<documentation>Indicates that an attempt was made to create an entity that already exists.</documentation>

</annotation>

</enumeration>

<documentation>Indicates that a value is not applicable for given use case.</documentation>

</annotation>

</enumeration>

<documentation>Indicates that two elements in the collection were identical.</documentation>

</annotation>

</enumeration>

<documentation>Indicates that an attempt was made to change an immutable field.</documentation>

</annotation>

</enumeration>

<documentation>Indicates that the requested operation is not supported.</documentation>

</annotation>

</enumeration>

<documentation>Indicates that another request attempted to update the same data in the same network at about the same time. Please wait and try the request again.</documentation>

</annotation>

</enumeration>

<documentation>The value returned if the actual value is not exposed by the requested API version.</documentation>

</annotation>

</enumeration>

</restriction>

</simpleType>

<documentation>The reason behind the currency code error.</documentation>

</annotation>

<documentation>The currency code is invalid and does not follow ISO 4217.</documentation>

</annotation>

</enumeration>

<documentation>The currency code is valid, but is not supported.</documentation>

</annotation>

</enumeration>

<documentation>The currency has been used for entity creation after its deprecation</documentation>

</annotation>

</enumeration>

</restriction>

</simpleType>

<documentation>Represents a period of time.</documentation>

</annotation>

<documentation>The current day.</documentation>

</annotation>

</enumeration>

<documentation>The previous day.</documentation>

</annotation>

</enumeration>

<documentation>The last week, from monday to sunday.</documentation>

</annotation>

</enumeration>

<documentation>The previous month.</documentation>

</annotation>

</enumeration>

<documentation>The last 3 full months. For example, if today is May 5, 2017, then LAST_3_MONTHS would go from February 1 to April 30.</documentation>

</annotation>

</enumeration>

<documentation>This will report on the last 93 days for the following columns: {@link Column#UNIQUE_REACH_IMPRESSIONS}, {@link Column#UNIQUE_REACH_FREQUENCY}, and {@link Column#UNIQUE_REACH}.</documentation>

</annotation>

</enumeration>

<documentation>Specifying this value will enable the user to specify {@link ReportQuery#startDate} and {@link ReportQuery#endDate}.</documentation>

</annotation>

</enumeration>

</annotation>

</enumeration>

<documentation>The next ninety days.</documentation>

</annotation>

</enumeration>

<documentation>The next week, from monday to sunday.</documentation>

</annotation>

</enumeration>

<documentation>The next month.</documentation>

</annotation>

</enumeration>

<documentation>Beginning of the next day until the end of the next month.</documentation>

</annotation>

</enumeration>

<documentation>The next quarter.</documentation>

</annotation>

</enumeration>

<documentation>The next three months.</documentation>

</annotation>

</enumeration>

<documentation>The next twelve months.</documentation>

</annotation>

</enumeration>

</restriction>

</simpleType>

<documentation>{@code Dimension} provides the break-down and filterable types available for running a {@link ReportJob}. Aggregate and percentage columns will be calculated based on these groupings.</documentation>

</annotation>

<documentation>Breaks down reporting data by month and year in the network time zone. Can be used to filter on month using ISO 4601 format 'YYYY-MM'. Corresponds to "Month and year" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach, Partner finance, YouTube consolidated.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by week of the year in the network time zone. Cannot be used for filtering. Corresponds to "Week" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach, YouTube consolidated.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by date in the network time zone. Can be used to filter by date using ISO 8601's format 'YYYY-MM-DD'". Corresponds to "Date" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed, Real-time video, YouTube consolidated.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by day of the week in the network time zone. Can be used to filter by day of the week using the index of the day (from 1 for Monday is 1 to 7 for Sunday). Corresponds to "Day of week" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach, YouTube consolidated.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by hour of the day in the network time zone. Can be used to filter by hour of the day (from 0 to 23). Corresponds to "Hour" in the Ad Manager UI. Compatible with any of the following report types: Historical, Real-time video.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by date in the PT time zone. Can be used to filter by date using ISO 8601's format 'YYYY-MM-DD'". Can only be used when time zone type is PACIFIC. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by week of the year in the PT time zone. Cannot be used for filtering. Can only be used when time zone type is PACIFIC. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by month and year in the PT time zone. Can be used to filter on month using ISO 4601 format 'YYYY-MM'. Can only be used when time zone type is PACIFIC. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by day of the week in the PT time zone. Can be used to filter by day of the week using the index of the day (from 1 for Monday is 1 to 7 for Sunday). Can only be used when time zone type is PACIFIC. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by {@link LineItem#id}. Can be used to filter by {@link LineItem#id}. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed, Real-time video.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by line item. {@link LineItem#name} and {@link LineItem#id} are automatically included as columns in the report. Can be used to filter by {@link LineItem#name}. Corresponds to "Line item" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed, Real-time video.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by {@link LineItem#lineItemType}. Can be used to filter by line item type using {@link LineItemType} enumeration names. Corresponds to "Line item type" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed, Real-time video.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by {@link Order#id}. Can be used to filter by {@link Order#id}. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by order. {@link Order#name} and {@link Order#id} are automatically included as columns in the report. Can be used to filter by {@link Order#name}. Corresponds to "Order" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed.</documentation>

</annotation>

</enumeration>

<documentation>Delivery status of the order. Not available as a dimension to report on, but exists as a dimension in order to filter on it using PQL. Valid values are 'STARTED', 'NOT_STARTED' and 'COMPLETED'. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by advertising company {@link Company#id}. Can be used to filter by {@link Company#id}. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by advertising company. {@link Company#name} and {@link Company#id} are automatically included as columns in the report. Can be used to filter by {@link Company#name}. Corresponds to "Advertiser" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed.</documentation>

</annotation>

</enumeration>

<documentation>The network that provided the ad for SDK ad mediation. If selected for a report, that report will include only SDK mediation ads and will not contain non-SDK mediation ads. SDK mediation ads are ads for mobile devices. They have a list of ad networks which can provide ads to serve. Not every ad network will have an ad to serve so the device will try each network one-by-one until it finds an ad network with an ad to serve. The ad network that ends up serving the ad will appear here. Note that this id does not correlate to anything in the companies table and is not the same id as is served by {@link #ADVERTISER_ID}. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The name of the network defined in {@link #AD_NETWORK_ID}. Corresponds to "Ad network name" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by salesperson {@link User#id}. Can be used to filter by {@link User#id}. Compatible with any of the following report types: Historical, Future sell-through, Reach.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by salesperson. {@link User#name} and {@link User#id} of the salesperson are automatically included as columns in the report. Can be used to filter by {@link User#name}. Corresponds to "Salesperson" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by {@link Creative#id} or creative set id (master's {@link Creative#id}) if the creative is part of a creative set. Can be used to filter by {@link Creative#id}. Compatible with any of the following report types: Historical, Ad speed, Real-time video.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by creative. {@link Creative#name} and {@link Creative#id} are automatically included as columns in the report. Can be used to filter by {@link Creative#name}. Corresponds to "Creative" in the Ad Manager UI. Compatible with any of the following report types: Historical, Ad speed, Real-time video.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by creative type. Corresponds to "Creative type" in the Ad Manager UI. Compatible with any of the following report types: Historical, Ad speed.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by creative billing type. Corresponds to "Creative billing type" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by custom event ID. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by custom event name. Corresponds to "Custom event" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by custom event type (timer/exit/counter). Corresponds to "Custom event type" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by {@link Creative#size}. Cannot be used for filtering. Corresponds to "Creative size" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by {@link AdUnit#id}. Can be used to filter by {@link AdUnit#id}. {@link #AD_UNIT_NAME}, i.e. {@link AdUnit#name}, is automatically included as a dimension in the report. Compatible with any of the following report types: Historical, Future sell-through, Ad speed, Real-time video.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by ad unit. {@link AdUnit#name} and {@link AdUnit#id} are automatically included as columns in the report. Can be used to filter by {@link AdUnit#name}. Corresponds to "Ad unit" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Ad speed, Real-time video.</documentation>

</annotation>

</enumeration>

<documentation>Used to filter on all the descendants of an ad unit by {@link AdUnit#id}. Not available as a dimension to report on. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed, Real-time video.</documentation>

</annotation>

</enumeration>

<documentation>Used to filter on all the descendants of an ad unit by {@link AdUnit#name}. Not available as a dimension to report on. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed, Real-time video.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by {@link Placement#id}. Can be used to filter by {@link Placement#id}. Compatible with any of the following report types: Historical, Future sell-through, Reach.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by placement. {@link Placement#name} and {@link Placement#id} are automatically included as columns in the report. Can be used to filter by {@link Placement#name}. Corresponds to "Placement" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach.</documentation>

</annotation>

</enumeration>

<documentation>Status of the placement. Not available as a dimension to report on, but exists as a dimension in order to filter on it using PQL. Can be used to filter on {@link Placement#status} by using {@link InventoryStatus} enumeration names. Compatible with any of the following report types: Historical, Future sell-through.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by criteria predefined by Ad Manager like the operating system, browser etc. Cannot be used for filtering. Corresponds to "Targeting" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by browser criteria predefined by Ad Manager. Corresponds to "Browser" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The ID of the device category to which an ad is being targeted. Can be used to filter by device category ID. Compatible with any of the following report types: Historical, Ad speed, Real-time video.</documentation>

</annotation>

</enumeration>

<documentation>The category of device (smartphone, feature phone, tablet, or desktop) to which an ad is being targeted. Can be used to filter by device category name. Corresponds to "Device category" in the Ad Manager UI. Compatible with any of the following report types: Historical, Ad speed, Real-time video.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by country criteria ID. Can be used to filter by country criteria ID. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed, YouTube consolidated.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by country code. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by country name. The country name and the country criteria ID are automatically included as columns in the report. Can be used to filter by country name using the US English name. Corresponds to "Country" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed, YouTube consolidated.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by region criteria ID. Can be used to filter by region criteria ID. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by region name. The region name and the region criteria ID are automatically included as columns in the report. Can be used to filter by region name using the US English name. Corresponds to "Region" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by city criteria ID. Can be used to filter by city criteria ID. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by city name. The city name and the city criteria ID are automatically included as columns in the report. Can be used to filter by city name using the US English name. Corresponds to "City" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by metro criteria ID. Can be used to filter by metro criteria ID. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by metro name. The metro name and the metro criteria ID are automatically included as columns in the report. Can be used to filter by metro name using the US English name. Corresponds to "Metro" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by postal code criteria ID. Can be used to filter by postal code criteria ID. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by postal code. The postal code and the postal code criteria ID are automatically included as columns in the report. Can be used to filter by postal code. Corresponds to "Postal code" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by {@link CustomTargetingValue#id}. Can be used to filter by {@link CustomTargetingValue#id}. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by custom criteria. The {@link CustomTargetingValue} is displayed in the form: <ul> <li> car=honda when value match type is {@link CustomTargetingValue.MatchType#EXACT} </li> <li> car~honda when value match type is {@link CustomTargetingValue.MatchType#BROAD} </li> <li> car=*honda when value match type is {@link CustomTargetingValue.MatchType#PREFIX} </li> <li> car~*honda when value match type is {@link CustomTargetingValue.MatchType#BROAD_PREFIX} </li> </ul> {@link #CUSTOM_TARGETING_VALUE_ID}, i.e. {@link CustomTargetingValue#id} is automatically included as a column in the report. Cannot be used for filtering; use {@link #CUSTOM_TARGETING_VALUE_ID} instead. When using this {@code Dimension}, metrics for freeform key values are only reported on when they are registered with {@code CustomTargetingService}. Corresponds to "Key-values" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by {@link Content#id}. Can be used to filter by {@link Content#id}. Compatible with any of the following report types: Historical, Future sell-through, YouTube consolidated.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by content. {@link Content#name} and {@link Content#id} are automatically included as columns in the report. Can be used to filter by {@link Content#name}. Corresponds to "Content" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, YouTube consolidated.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by {@link ContentBundle#id}. Can be used to filter by {@link ContentBundle#id}. Compatible with any of the following report types: Historical, Future sell-through, YouTube consolidated.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by content bundle. {@link ContentBundle#name} and {@link ContentBundle#id} are automatically included as columns in the report. Can be used to filter by {@link ContentBundle#name}. Corresponds to "Content bundle" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, YouTube consolidated.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by CMS metadata. To use this dimension in API, a list of cms metadata key IDs must be specified in {@link ReportQuery#cmsMetadataKeyIds}. This dimension can be used as a filter in the {@link Statement} in PQL syntax: CMS_METADATA_KEY[keyId]_ID = {@link CmsMetadataValue#cmsMetadataValueId CMS metadata value ID} For example: WHERE CMS_METADATA_KEY[4242]_ID = 53423</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by the fallback position of the video ad, i.e., {@code NON_FALLBACK}, {@code FALLBACK_POSITION_1}, {@code FALLBACK_POSITION_2}, etc. Can be used for filtering. Corresponds to "Fallback position" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by the position of the video ad within the video stream, i.e., {@code UNKNOWN_POSITION}, {@code PREROLL}, {@code POSTROLL}, {@code UNKNOWN_MIDROLL}, {@code MIDROLL_1}, {@code MIDROLL_2}, etc. {@code UNKNOWN_MIDROLL} represents a midroll, but which specific midroll is unknown. Can be used for filtering. Corresponds to "Position of pod" in the Ad Manager UI. Compatible with any of the following report types: Historical, Real-time video.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by the position of the video ad within the pod, i.e., {@code UNKNOWN_POSITION}, {@code POSITION_1}, {@code POSITION_2}, etc. Can be used for filtering. Corresponds to "Position in pod" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by {@link AdSpot#id}. Can be used to filter by {@link AdSpot#id}. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by content. {@link AdSpot#name} and {@link AdSpot#id} are automatically included as columns in the report. Can be used to filter by {@link AdSpot#name}. Corresponds to "Custom spot" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by video redirect vendor. Corresponds to "Video redirect third party" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The filter to break down reporting data by video break type. Not available as a dimension to report on. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The filter to break down reporting data by video break type. Can only be used with the following string values: "Unknown", "Single ad video request", "Optimized pod video request". Not available as a dimension to report on. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by vast version type name. Corresponds to "VAST version" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by video request duration bucket. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by video request duration bucket name. Corresponds to "Video ad request duration" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by the ID of the type of video placement as defined by the updated IAB definition. The values of "in-stream" and "accompanying content" are declared via publisher inputted URL parameters. The values of "interstitial" and "no content" are populated automatically based on the declared inventory type. The video placement dimension only applies to backfill traffic.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by the name of the type of video placement as defined by the updated IAB definition. The values of "in-stream" and "accompanying content" are declared via publisher inputted URL parameters. The values of "interstitial" and "no content" are populated automatically based on the declared inventory type. The video placement dimension only applies to backfill traffic. Corresponds to "Video placement (new)" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down impressions by inventory format id. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down impressions by inventory format name. Corresponds to "Inventory format" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by partner {@link Company#id}. Compatible with any of the following report types: Historical, Partner finance.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by partner {@link Company#name} and {@link Company#id} are automatically included as columns in the report. Corresponds to "Partner" in the Ad Manager UI. Compatible with any of the following report types: Historical, Partner finance.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by partner label {@link Label#id}. Compatible with any of the following report types: Historical, Partner finance.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by partner label. {@link Label#name} and {@link Label#id} are automatically included as columns in the report. Corresponds to "Partner label" in the Ad Manager UI. Compatible with any of the following report types: Historical, Partner finance.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by partner assignment id. Compatible with any of the following report types: Historical, Partner finance.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by partner assignment name. PartnerAssignment name and id are automatically included as columns in the report. Corresponds to "Assignment" in the Ad Manager UI. Compatible with any of the following report types: Historical, Partner finance.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by inventory sharing assignment ID. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by inventory sharing assignment name. Corresponds to "Inventory share assignment" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by inventory sharing outcome. Corresponds to "Inventory share outcome" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by gender and age group, i.e., MALE_13_TO_17, MALE_18_TO_24, MALE_25_TO_34, MALE_35_TO_44, MALE_45_TO_54, MALE_55_TO_64, MALE_65_PLUS, FEMALE_13_TO_17, FEMALE_18_TO_24, FEMALE_25_TO_34, FEMALE_35_TO_44, FEMALE_45_TO_54, FEMALE_55_TO_64, FEMALE_65_PLUS, UNKNOWN_0_TO_17 and UNKNOWN. Whenever this dimension is selected, {@link #COUNTRY_NAME} must be selected. This dimension is supported only for GRP columns. Can correspond to any of the following in the Ad Manager UI: Demographics, comScore vCE demographics. Compatible with the "Reach" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by the ad unit sizes specified in ad requests. Formatted as comma separated values, e.g. "300x250,300x250v,300x60". This dimension is supported only for sell-through columns. Corresponds to "Ad request sizes" in the Ad Manager UI. Compatible with the "Future sell-through" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by the custom criteria specified in ad requests. Formatted as comma separated {@link CustomTargetingKey key}-{@link CustomTargetingValue values}, where a key-value is formatted as {@code key1=value_1|...|value_n,key2=value_1|...|value_n,...}. This dimension is supported only for sell-through columns. Corresponds to "Key-values" in the Ad Manager UI. Compatible with the "Future sell-through" report type.</documentation>

</annotation>

</enumeration>

<documentation>Break down the report by a boolean indicator. It's TRUE for Ad Exchange traffic fulfilled by First Look Deals. It can be used both as a dimension or dimension filter. As a filter, it can only be used with the string values "true" and "false". Corresponds to "Is First Look" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Break down the report by a boolean indicator. It's TRUE for AdX Direct traffic. It can be used both as a dimension or dimension filter. As a filter, it can only be used with the string values "true" and "false". Corresponds to "Is AdX Direct" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by yield group ID. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by yield group name. Corresponds to "Yield group" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by yield partner. Corresponds to "Yield partner" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by the tag of a yield partner in a yield group. Corresponds to "Yield partner tag" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The ID of an exchange bidding deal. Corresponds to "Exchange bidding deal id" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The type of an exchange bidding deal. Corresponds to "Exchange bidding deal type" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The ID of a classified advertiser. Compatible with the "Ad speed" report type.</documentation>

</annotation>

</enumeration>

<documentation>The name of a classified advertiser. Corresponds to "Advertiser (classified)" in the Ad Manager UI. Compatible with any of the following report types: Historical, Ad speed.</documentation>

</annotation>

</enumeration>

<documentation>The ID of a classified brand. Compatible with the "Ad speed" report type.</documentation>

</annotation>

</enumeration>

<documentation>The name of a classified brand. Corresponds to "Brand (classified)" in the Ad Manager UI. Compatible with any of the following report types: Historical, Ad speed.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by mediation type. A mediation type can be web, mobile app or video. Corresponds to "Mediation type" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by native template (also known as creative template) ID. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by native template (also known as creative template) name. Corresponds to "Native ad format name" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by native style ID. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by native style name. Corresponds to "Native style name" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by child network code in MCM "Manage Inventory". This dimension only works for MCM "Manage Inventory" parent publishers. Corresponds to "Child network code" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by mobile app ID received in the ad request (which may be made up). If app ID is not available, '(Not applicable)' will be returned. Special values like 'null' and 'unidentified' will be reported as '(Not applicable)'. Can be used for filtering. Corresponds to "App ID" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by mobile app name. Can be used for filtering. Corresponds to "App names" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by device name. Can be used for filtering. Can correspond to any of the following in the Ad Manager UI: Mobile OS, Devices. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by inventory type. Can be used for filtering. Corresponds to "Inventory types" in the Ad Manager UI. Compatible with any of the following report types: Historical, Ad speed.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by OS version id. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by OS version name. Corresponds to "Operating system" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by request type. Can be used for filtering. Corresponds to "Request type" in the Ad Manager UI. Compatible with any of the following report types: Historical, Ad speed.</documentation>

</annotation>

</enumeration>

<documentation>Status of the ad unit. Not available as a dimension to report on, but exists as a dimension in order to filter on it using PQL. Valid values correspond to {@link InventoryStatus}. Compatible with any of the following report types: Historical, Future sell-through, Ad speed, Real-time video.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by {@link Creative#id}. This includes regular creatives, and master and companions in case of creative sets. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by creative. This includes regular creatives, and master and companions in case of creative sets. Corresponds to "Master and Companion creative" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by billable audience segment ID. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by billable audience segment name. Corresponds to "Audience segment (billable)" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by audience segment data provider name. Corresponds to "Data partner" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down data by web property code. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by agency. Corresponds to "Buying agency" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by buyer network Id. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by buyer network name. Corresponds to "Buyer network" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by Bidder ID. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by Bidder name. Corresponds to "Bidder" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by advertiser domain. Corresponds to "Advertiser domain" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by optimization type. Corresponds to "Optimization type" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by advertiser vertical. Corresponds to "Advertiser vertical" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Campaign date segment of Nielsen Digital Ad Ratings reporting. Corresponds to "Nielsen Digital Ad Ratings segment" in the Ad Manager UI. Compatible with the "Reach" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by gender and age group, i.e., MALE_18_TO_20, MALE_21_TO_24, MALE_25_TO_29, MALE_30_TO_35, MALE_35_TO_39, MALE_40_TO_44, MALE_45_TO_49, MALE_50_TO_54, MALE_55_TO_64, MALE_65_PLUS, FEMALE_18_TO_20, FEMALE_21_TO_24, FEMALE_25_TO_29, FEMALE_30_TO_34, FEMALE_35_TO_39, FEMALE_40_TO_44, FEMALE_45_TO_49, FEMALE_50_TO_54, FEMALE_55_TO_64, FEMALE_65_PLUS, and OTHER.</documentation>

</annotation>

</enumeration>

<documentation>Data restatement date of Nielsen Digital Ad Ratings data. Corresponds to "Nielsen Digital Ad Ratings restatement date" in the Ad Manager UI. Compatible with the "Reach" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by device type, i.e., Computer, Mobile and other types. This dimension is supported only for Nielsen columns. Compatible with the "Reach" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by device type, i.e., Computer, Mobile and other types. This dimension is supported only for Nielsen columns. Corresponds to "Nielsen Digital Ad Ratings device" in the Ad Manager UI. Compatible with the "Reach" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by {@link ProposalMarketplaceInfo#buyerAccountId}. Compatible with any of the following report types: Historical, Reach.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by programmatic buyer name. Corresponds to "Programmatic buyer" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by requested ad size(s). This can be a chain of sizes or a single size. Corresponds to "Requested ad sizes" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by the creative size the ad was delivered to. Corresponds to "Creative size (delivered)" in the Ad Manager UI. Compatible with any of the following report types: Historical, Ad speed.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by the type of transaction that occurred in Ad Exchange. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by the type of transaction that occurred in Ad Exchange. Corresponds to "Programmatic channel" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down data by detected yield partner name. Corresponds to "Yield partner (classified)" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down Demand reporting data by date in the network time zone. Can be used to filter by date using ISO 8601's format 'YYYY-MM-DD'". Corresponds to "Date" in the Ad Manager UI. Compatible with the "Ad Connector" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down Demand reporting data by week of the year in the network time zone. Cannot be used for filtering. Corresponds to "Week" in the Ad Manager UI. Compatible with the "Ad Connector" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down Demand reporting data by month and year in the network time zone. Cannot be used to filter. Corresponds to "Month and year" in the Ad Manager UI. Compatible with the "Ad Connector" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down Demand reporting data by country criteria ID. Can be used to filter by country criteria ID. Compatible with the "Ad Connector" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down Demand reporting data by country name. The country name and the country criteria ID are automatically included as columns in the report. Can be used to filter by country name using the US English name. Corresponds to "Country" in the Ad Manager UI. Compatible with the "Ad Connector" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down Demand reporting data by inventory type. Corresponds to "Inventory type" in the Ad Manager UI. Compatible with the "Ad Connector" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down Demand reporting data by the creative size the ad was delivered to. Corresponds to "Creative size" in the Ad Manager UI. Compatible with the "Ad Connector" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down Demand reporting data by the brand name that bids on ads. Corresponds to "Brand" in the Ad Manager UI. Compatible with the "Ad Connector" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down Demand reporting data by the advertiser name that bid on ads. Corresponds to "Advertiser" in the Ad Manager UI. Compatible with the "Ad Connector" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down Demand reporting data by Ad Exchange ad network name. Example: Google Adwords. Corresponds to "Buyer network" in the Ad Manager UI. Compatible with the "Ad Connector" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by device name. Corresponds to "Device" in the Ad Manager UI. Compatible with the "Ad Connector" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by the category of device (smartphone, feature phone, tablet, or desktop). Corresponds to "Device category" in the Ad Manager UI. Compatible with the "Ad Connector" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by the tag id provided by the publisher in the ad request. Corresponds to "Tag ID" in the Ad Manager UI. Compatible with the "Ad Connector" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by the deal id provided by the publisher in the ad request. Corresponds to "Deal IDs" in the Ad Manager UI. Compatible with the "Ad Connector" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by mobile app ID. Corresponds to "App ID" in the Ad Manager UI. Compatible with the "Ad Connector" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by the {@link CustomTargetingKey}s marked as dimensions in inventory key-values setup. To use this dimension, a list of custom targeting key IDs must be specified in {@link ReportQuery#customDimensionKeyIds}.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by demand channels. Compatible with any of the following report types: Historical, Reach, Ad speed.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by demand channel name. Corresponds to "Demand channel" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach, Ad speed.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by top private domain. Corresponds to "Domain" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by serving restriction id. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by serving restriction name. Corresponds to "Serving restriction" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by unified pricing rule id. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by unified pricing rule name. Corresponds to "Unified pricing rule" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by first price pricing rule id. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by first price pricing rule name. Corresponds to "First look pricing rule" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by the range within which the bid falls, divided into $0.10 buckets. Corresponds to "Bid range" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by the ID of the reason the bid lost or did not participate in the auction. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by the reason the bid lost or did not participate in the auction. Corresponds to "Bid rejection reason" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by the domain of the ad technology provider (ATP) associated with the bid. Corresponds to "Ad technology provider domain" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by programmatic deal ID. Corresponds to "Programmatic deal ID" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by programmatic deal name. Corresponds to "Programmatic deal name" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by the ID of the ad technology provider (ATP) associated with the bid. Corresponds to "Ad technology provider ID" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by the ad technology provider (ATP) associated with the bid. Corresponds to "Ad technology provider" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by the ID of the ad technology provider as it appears on the Global Vendor List (GVL). Corresponds to "TCF vendor ID" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by the name of the ad technology provider as it appears on the Global Vendor List (GVL). Corresponds to "TCF vendor" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by site. Corresponds to "Site" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by channels. Corresponds to "Channel" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by URL ID. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by URL name. Corresponds to "URL" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by video ad duration. Corresponds to "Video ad duration" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by video ad type Id. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by video ad type. Corresponds to "Video ad type" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by Ad Exchange product code. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by Ad Exchange product. Corresponds to "Ad Exchange product" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by Dynamic allocation ID. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by Dynamic allocation. Corresponds to "Dynamic allocation" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by Ad type ID. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by Ad type. Corresponds to "Ad type" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by Ad location ID. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by Ad location. Corresponds to "Ad location" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by Targeting type code. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by Targeting type. Corresponds to "Targeting type" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by Branding type code. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by Branding type. Corresponds to "Branding type" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by Bandwidth Id. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by Bandwidth name. Corresponds to "Bandwidth" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by Carrier Id. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by Carrier name. Corresponds to "Carrier" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

</restriction>

</simpleType>

<documentation>{@code DimensionAttribute} provides additional fields associated with a {@link Dimension}. It can only be selected with its corresponding {@link Dimension}. For example, {@link DimensionAttribute#ORDER_PO_NUMBER} can only be used if the {@link ReportQuery#dimensions} contains {@link Dimension#ORDER_NAME}.</documentation>

</annotation>

<documentation>Represents {@link LineItem#effectiveAppliedLabels} as a comma separated list of {@link Label#name} for {@link Dimension#LINE_ITEM_NAME}. Corresponds to "Line item labels" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach.</documentation>

</annotation>

</enumeration>

<documentation>Represents {@link LineItem#effectiveAppliedLabels} as a comma separated list of {@link Label#id} for {@link Dimension#LINE_ITEM_NAME}. Compatible with any of the following report types: Historical, Reach.</documentation>

</annotation>

</enumeration>

<documentation>Generated as {@code true} for {@link Dimension#LINE_ITEM_NAME} which is eligible for optimization, {@code false} otherwise. Can be used for filtering. Corresponds to "Optimizable" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach.</documentation>

</annotation>

</enumeration>

<documentation>Indicates the progress made for the delivery of the {@link Dimension#LINE_ITEM_NAME}. <table> <tr> <th scope="col">Progress</th> <th scope="col">Definition</th> </tr> <tr> <td>100%</td> <td>The {@link LineItem} is on track to deliver in full as per {@link LineItem#unitsBought}.</td> </tr> <tr> <td>> 100%</td> <td>The {@link LineItem} is on track to overdeliver.</td> </tr> <tr> <td>< 100%</td> <td>The {@link LineItem} is on track to underdeliver.</td> </tr> <tr> <td>N/A</td> <td>The {@link LineItem} does not have any quantity goals, or there is insufficient information about the {@link LineItem}.</td> </tr> </table> Corresponds to "Delivery Indicator" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach, Real-time video.</documentation>

</annotation>

</enumeration>

<documentation>Represents {@link LineItem#deliveryRateType} for {@link Dimension#LINE_ITEM_NAME}. Corresponds to "Delivery pacing" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed, Real-time video.</documentation>

</annotation>

</enumeration>

<documentation>Represents {@link LineItem#frequencyCaps} as a comma separated list of "{@link FrequencyCap#maxImpressions} impressions per/every {@link FrequencyCap#numTimeUnits} {@link FrequencyCap#timeUnit}" (e.g. "10 impressions every day,500 impressions per lifetime") for {@link Dimension#LINE_ITEM_NAME}. Corresponds to "Frequency cap" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach.</documentation>

</annotation>

</enumeration>

<documentation>Represents the monthly reconciliation status of the line item for {@link Dimension#LINE_ITEM_NAME} and {@link Dimension#MONTH_YEAR}. Corresponds to "Line item reconciliation status" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach.</documentation>

</annotation>

</enumeration>

<documentation>Represents the monthly last reconciliation date time of the line item for {@link Dimension#LINE_ITEM_NAME} and {@link Dimension#MONTH_YEAR}. Corresponds to "Line item last reconciliation time" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach.</documentation>

</annotation>

</enumeration>

<documentation>Represents {@link Company#externalId} for {@link Dimension#ADVERTISER_NAME}. Corresponds to "External advertiser ID" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach.</documentation>

</annotation>

</enumeration>

<documentation>Represents {@link Company#type} for {@link Dimension#ADVERTISER_NAME}. Can be used for filtering. Corresponds to "Advertiser type" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed.</documentation>

</annotation>

</enumeration>

<documentation>Represents {@link Company#creditStatus} for {@link Dimension#ADVERTISER_NAME}. Can be used for filtering. Corresponds to "Advertiser credit status" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed.</documentation>

</annotation>

</enumeration>

<documentation>Represents name and email address in the form of name(email) of primary contact for {@link Dimension#ADVERTISER_NAME}. Corresponds to "Advertiser primary contact" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach.</documentation>

</annotation>

</enumeration>

<documentation>Represents the start date (in YYYY-MM-DD format) for {@link Dimension#ORDER_NAME}. Can be used for filtering. Corresponds to "Order start date" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed.</documentation>

</annotation>

</enumeration>

<documentation>Represents the end date (in YYYY-MM-DD format) for {@link Dimension#ORDER_NAME}. Can be used for filtering. Corresponds to "Order end date" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed.</documentation>

</annotation>

</enumeration>

<documentation>Represents {@link Order#externalOrderId} for {@link Dimension#ORDER_NAME}. Corresponds to "External order ID" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach.</documentation>

</annotation>

</enumeration>

<documentation>Represents {@link Order#poNumber} for {@link Dimension#ORDER_NAME}. Can be used for filtering. Corresponds to "Order PO number" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed.</documentation>

</annotation>

</enumeration>

<documentation>Represents {@link Order#orderIsProgrammatic} for {@link Dimension#ORDER_NAME}. Can be used for filtering. Corresponds to "Programmatic order" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach.</documentation>

</annotation>

</enumeration>

<documentation>Represents the name of {@link Order#agencyId} for {@link Dimension#ORDER_NAME}. Corresponds to "Agency" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach.</documentation>

</annotation>

</enumeration>

<documentation>Represents {@link Order#agencyId} for {@link Dimension#ORDER_NAME}. Can be used for filtering. Corresponds to "Agency ID" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach.</documentation>

</annotation>

</enumeration>

<documentation>Represents {@link Order#effectiveAppliedLabels} as a comma separated list of {@link Label#name} for {@link Dimension#ORDER_NAME}. Corresponds to "Order labels" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach.</documentation>

</annotation>

</enumeration>

<documentation>Represents {@link Order#effectiveAppliedLabels} as a comma separated list of {@link Label#id} for {@link Dimension#ORDER_NAME}. Compatible with any of the following report types: Historical, Reach.</documentation>

</annotation>

</enumeration>

<documentation>The name and email address in the form of name(email) of the trafficker for {@link Dimension#ORDER_NAME} Corresponds to "Trafficker" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach.</documentation>

</annotation>

</enumeration>

<documentation>Represents {@link Order#traffickerId} for {@link Dimension#ORDER_NAME}. Can be used for filtering. Compatible with any of the following report types: Historical, Reach.</documentation>

</annotation>

</enumeration>

<documentation>The names and email addresses as a comma separated list of name(email) of the {@link Order#secondaryTraffickerIds} for {@link Dimension#ORDER_NAME}. Corresponds to "Secondary traffickers" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach.</documentation>

</annotation>

</enumeration>

<documentation>The name and email address in the form of name(email) of the {@link Order#salespersonId} for {@link Dimension#ORDER_NAME}. Corresponds to "Salesperson" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach.</documentation>

</annotation>

</enumeration>

<documentation>The names and email addresses as a comma separated list of name(email) of the {@link Order#secondarySalespersonIds} for {@link Dimension#ORDER_NAME}. Corresponds to "Secondary salespeople" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach.</documentation>

</annotation>

</enumeration>

<documentation>The total number of impressions delivered over the lifetime of an {@link Dimension#ORDER_NAME}. Corresponds to "Order lifetime impressions" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed.</documentation>

</annotation>

</enumeration>

<documentation>The total number of clicks delivered over the lifetime of an {@link Dimension#ORDER_NAME}. Corresponds to "Order lifetime clicks" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed.</documentation>

</annotation>

</enumeration>

<documentation>The cost of booking all the CPM ads for {@link Dimension#ORDER_NAME}. Corresponds to "Booked CPM" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach.</documentation>

</annotation>

</enumeration>

<documentation>The cost of booking all the CPC ads for {@link Dimension#ORDER_NAME}. Corresponds to "Booked CPC" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach.</documentation>

</annotation>

</enumeration>

<documentation>Represents the start date (in YYYY-MM-DD format) for {@link Dimension#LINE_ITEM_NAME}. Can be used for filtering. Corresponds to "Line item start date" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed, Real-time video.</documentation>

</annotation>

</enumeration>

<documentation>Represents the end date (in YYYY-MM-DD format) for {@link Dimension#LINE_ITEM_NAME}. Can be used for filtering. Corresponds to "Line item end date" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed, Real-time video.</documentation>

</annotation>

</enumeration>

<documentation>Represents {@link LineItem#externalId} for {@link Dimension#LINE_ITEM_NAME}. Can be used for filtering. Corresponds to "External Line Item ID" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach.</documentation>

</annotation>

</enumeration>

<documentation>Represents {@link LineItem#costType} for {@link Dimension#LINE_ITEM_NAME}. Can be used for filtering. Corresponds to "Cost type" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed, Real-time video.</documentation>

</annotation>

</enumeration>

<documentation>Represents {@link LineItem#costPerUnit} for {@link Dimension#LINE_ITEM_NAME}. Corresponds to "Rate" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed, Real-time video.</documentation>

</annotation>

</enumeration>

<documentation>Represents the 3 letter currency code for {@link Dimension#LINE_ITEM_NAME}. Corresponds to "Currency code" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed, Real-time video.</documentation>

</annotation>

</enumeration>

<documentation>The total number of impressions, clicks or days that is reserved for {@link Dimension#LINE_ITEM_NAME}. Corresponds to "Goal quantity" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed, Real-time video.</documentation>

</annotation>

</enumeration>

<documentation>Corresponds to "Nielsen Average Number Of Viewers" in the Ad Manager UI. Compatible with the "Reach" report type.</documentation>

</annotation>

</enumeration>

<documentation>The ratio between the goal quantity for {@link Dimension#LINE_ITEM_NAME} of {@link LineItemType#SPONSORSHIP} and the {@link #LINE_ITEM_GOAL_QUANTITY}. Represented as a number between 0..100. Corresponds to "Sponsorship goal (%)" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach.</documentation>

</annotation>

</enumeration>

<documentation>The total number of impressions delivered over the lifetime of a {@link Dimension#LINE_ITEM_NAME}. Corresponds to "Line item lifetime impressions" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed, Real-time video.</documentation>

</annotation>

</enumeration>

<documentation>The total number of clicks delivered over the lifetime of a {@link Dimension#LINE_ITEM_NAME}. Corresponds to "Line item lifetime clicks" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed, Real-time video.</documentation>

</annotation>

</enumeration>

<documentation>Represents {@link LineItem#priority} for {@link Dimension#LINE_ITEM_NAME} as a value between 1 and 16. Can be used for filtering. Corresponds to "Line item priority" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed, Real-time video.</documentation>

</annotation>

</enumeration>

<documentation>Describes the computed {@link LineItem} status that is derived from the current state of the line item. Compatible with any of the following report types: Historical, Future sell-through, Reach, Ad speed, Real-time video.</documentation>

</annotation>

</enumeration>

<documentation>Indicates if a creative is a regular creative or creative set. Values will be 'Creative' or 'Creative set' Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>The type of creative in a creative set - master or companion. Corresponds to "Master or Companion" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Represents the {@link LineItem#contractedUnitsBought} quantity for {@link Dimension#LINE_ITEM_NAME}. Corresponds to "Contracted quantity" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach.</documentation>

</annotation>

</enumeration>

<documentation>Represents the {@link LineItem#discount} for {@link Dimension#LINE_ITEM_NAME}. The number is either a percentage or an absolute value depending on {@link LineItem#discountType}. Corresponds to "Discount" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach.</documentation>

</annotation>

</enumeration>

<documentation>The cost of booking for a non-CPD {@link Dimension#LINE_ITEM_NAME}. Corresponds to "Booked revenue (exclude CPD)" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach.</documentation>

</annotation>

</enumeration>

<documentation>Represents {@link Company#appliedLabels} as a comma separated list of {@link Label#name} for {@link Dimension#ADVERTISER_NAME}. Corresponds to "Advertiser labels" in the Ad Manager UI. Compatible with any of the following report types: Historical, Reach.</documentation>

</annotation>

</enumeration>

<documentation>Represents {@link Company#appliedLabels} as a comma separated list of {@link Label#id} for {@link Dimension#ADVERTISER_NAME}. Compatible with any of the following report types: Historical, Reach.</documentation>

</annotation>

</enumeration>

<documentation>Represents the click-through URL for {@link Dimension#CREATIVE_NAME}. Corresponds to "Click-through URL" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Represents whether a creative is SSL-compliant. Corresponds to "Creative SSL scan result" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Represents whether a creative's SSL status was overridden. Corresponds to "Creative SSL compliance override" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Represents a {@link LineItemCreativeAssociation#startDateTime} for a {@link Dimension#LINE_ITEM_NAME} and a {@link Dimension#CREATIVE_NAME}. Includes the date without the time. Corresponds to "Creative start date" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Represents a {@link LineItemCreativeAssociation#endDateTime} for a {@link Dimension#LINE_ITEM_NAME} and a {@link Dimension#CREATIVE_NAME}. Includes the date without the time. Corresponds to "Creative end date" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Represents the {@link CmsContent#displayName} within the first element of {@link Content#cmsContent} for {@link Dimension#CONTENT_NAME}. Corresponds to "Content source name" in the Ad Manager UI. Compatible with any of the following report types: Historical, YouTube consolidated.</documentation>

</annotation>

</enumeration>

<documentation>Represents the {@link CmsContent#cmsContentId} within the first element of {@link Content#cmsContent} for {@link Dimension#CONTENT_NAME}. Corresponds to "ID of the video in the content source" in the Ad Manager UI. Compatible with any of the following report types: Historical, YouTube consolidated.</documentation>

</annotation>

</enumeration>

<documentation>Breaks down reporting data by child partner name in MCM "Manage Inventory". By default, this attribute is ordered by {@link Dimension#CHILD_NETWORK_CODE}. This dimension only works for MCM "Manage Inventory" parent publishers. Corresponds to "Child partner name" in the Ad Manager UI. Compatible with the "Historical" report type.</documentation>

</annotation>

</enumeration>

<documentation>Represents {@link AdUnit#adUnitCode} for {@link Dimension#AD_UNIT_NAME}. Corresponds to "Ad unit code" in the Ad Manager UI. Compatible with any of the following report types: Historical, Future sell-through, Ad speed, Real-time video.</documentation>

</annotation>

</enumeration>

</restriction>

</simpleType>

<documentation>The file formats available for creating the report.</documentation>

</annotation>

<documentation>The report file is generated as a list of Tab Separated Values.</documentation>

</annotation>

</enumeration>

<documentation>The report file is generated as a list of tab-separated values for Excel.</documentation>

</annotation>

</enumeration>

<documentation>The report file is generated as a list of Comma Separated Values, to be used with automated machine processing. <ul> <li>There is no pretty printing for the output, and no total row.</li> <li>Column headers are the qualified name e.g. "Dimension.ORDER_NAME".</li> <li>Network currency Monetary amounts are represented as micros in the {@link Network#currencyCode currency of the network}.</li> <li>Starting from v201705, local currency Monetary amounts are represented as currency symbol + ' ' + micros. </li> <li>Dates are formatted according to the ISO 8601 standard YYYY-MM-DD</li> <li>DateTimes are formatted according to the ISO 8601 standard YYYY-MM-DDThh:mm:ss[+-]hh:mm</li> </ul></documentation>

</annotation>

</enumeration>

<documentation>The report file is generated as XML.</documentation>

</annotation>

</enumeration>

<documentation>The report file is generated as an Office Open XML spreadsheet designed for Excel 2007+.</documentation>

</annotation>

</enumeration>

</restriction>

</simpleType>

<documentation>A feature is being used that is not enabled on the current network.</documentation>

</annotation>

</enumeration>

<documentation>The value returned if the actual value is not exposed by the requested API version.</documentation>

</annotation>

</enumeration>

</restriction>

</simpleType>

<documentation>The single reason for the internal API error.</documentation>

</annotation>

<documentation>API encountered an unexpected internal error.</documentation>

</annotation>

</enumeration>

<documentation>A temporary error occurred during the request. Please retry.</documentation>

</annotation>

</enumeration>

<documentation>The cause of the error is not known or only defined in newer versions.</documentation>

</annotation>

</enumeration>

<documentation>The API is currently unavailable for a planned downtime.</documentation>

</annotation>

</enumeration>

<documentation>Mutate succeeded but server was unable to build response. Client should not retry mutate.</documentation>

</annotation>

</enumeration>

</restriction>

</simpleType>

<documentation>The reasons for the target error.</documentation>

</annotation>

<documentation>Assuming that a method will not have more than 3 arguments, if it does, return NULL</documentation>

</annotation>

</enumeration>

<documentation>The value returned if the actual value is not exposed by the requested API version.</documentation>

</annotation>

</enumeration>

</restriction>

</simpleType>

<documentation>The reasons for the target error.</documentation>

</annotation>

<documentation>Indicates an error in parsing an attribute.</documentation>

</annotation>

</enumeration>

<documentation>The value returned if the actual value is not exposed by the requested API version.</documentation>

</annotation>

</enumeration>

</restriction>

</simpleType>

<documentation>Describes reasons for permission errors.</documentation>

</annotation>

<documentation>User does not have the required permission for the request.</documentation>

</annotation>

</enumeration>

<documentation>The value returned if the actual value is not exposed by the requested API version.</documentation>

</annotation>

</enumeration>

</restriction>

</simpleType>

<documentation>The reasons for the target error.</documentation>

</annotation>

<documentation>Indicates that there was an error executing the PQL.</documentation>

</annotation>

</enumeration>

<documentation>The value returned if the actual value is not exposed by the requested API version.</documentation>

</annotation>

</enumeration>

</restriction>

</simpleType>

<documentation>The reasons for the target error.</documentation>

</annotation>

<documentation>Indicates that there was a PQL syntax error.</documentation>

</annotation>

</enumeration>

<documentation>The value returned if the actual value is not exposed by the requested API version.</documentation>

</annotation>

</enumeration>

</restriction>

</simpleType>

<documentation>The number of requests made per second is too high and has exceeded the allowable limit. The recommended approach to handle this error is to wait about 5 seconds and then retry the request. Note that this does not guarantee the request will succeed. If it fails again, try increasing the wait time. Another way to mitigate this error is to limit requests to 8 per second for Ad Manager 360 accounts, or 2 per second for Ad Manager accounts. Once again this does not guarantee that every request will succeed, but may help reduce the number of times you receive this error.</documentation>

</annotation>

</enumeration>

<documentation>The value returned if the actual value is not exposed by the requested API version.</documentation>

</annotation>

</enumeration>

<documentation>This user has exceeded the allowed number of new report requests per hour (this includes both reports run via the UI and reports run via {@link ReportService#runReportJob}). The recommended approach to handle this error is to wait about 10 minutes and then retry the request. Note that this does not guarantee the request will succeed. If it fails again, try increasing the wait time. Another way to mitigate this error is to limit the number of new report requests to 250 per hour per user. Once again, this does not guarantee that every request will succeed, but may help reduce the number of times you receive this error.</documentation>

</annotation>

</enumeration>

<documentation>This network has exceeded the allowed number of identifiers uploaded within a 24 hour period. The recommended approach to handle this error is to wait 30 minutes and then retry the request. Note that this does not guarantee the request will succeed. If it fails again, try increasing the wait time.</documentation>

</annotation>

</enumeration>

</restriction>

</simpleType>

<documentation>The reasons for report error.</documentation>

</annotation>

<documentation>Default {@code ReportError} when the reason is not among any already defined.</documentation>

</annotation>

</enumeration>

<documentation>User does not have permission to access the report.</documentation>

</annotation>

</enumeration>

<documentation>User does not have permission to view one or more {@link Dimension}.</documentation>

</annotation>

</enumeration>

<documentation>User has no permission to view one or more attributes.</documentation>

</annotation>

</enumeration>

<documentation>User does not have permission to view one or more {@link Column}.</documentation>

</annotation>

</enumeration>

<documentation>The report query exceeds the maximum allowed number of characters.</documentation>

</annotation>

</enumeration>

<documentation>Invalid report job state for the given operation.</documentation>

</annotation>

</enumeration>

<documentation>Invalid {@link Dimension} objects specified.</documentation>

</annotation>

</enumeration>

<documentation>The attribute ID(s) are not valid.</documentation>

</annotation>

</enumeration>

<documentation>The API error when running the report with {@link CmsMetadataKeyDimension}. There are three reasons for this error. <ol> <li>{@link ReportQuery#dimensions} contains {@link Dimension#CONTENT_CMS_METADATA}, but {@link ReportQuery#cmsMetadataKeyIds} is empty. <li>{@link ReportQuery#cmsMetadataKeyIds} is non-empty, but {@link ReportQuery#dimensions} does not contain {@link Dimension#CONTENT_CMS_METADATA}. <li>The {@link ReportQuery#cmsMetadataKeyIds} specified along with the {@link Dimension#CONTENT_CMS_METADATA} are not valid, i.e., these IDs are not reportable cms metadata key defined by the publisher. </ol></documentation>

</annotation>

</enumeration>

<documentation>Invalid {@link Column} objects specified.</documentation>

</annotation>

</enumeration>

<documentation>Invalid {@link DimensionFilter} objects specified.</documentation>

</annotation>

</enumeration>

<documentation>Invalid date.</documentation>

</annotation>

</enumeration>

<documentation>The start date for running the report should not be later than the end date.</documentation>

</annotation>

</enumeration>

<documentation>The start date for running the report should not be more than three years before now.</documentation>

</annotation>

</enumeration>

<documentation>The list of {@link Dimension} and {@link Column} objects cannot be empty.</documentation>

</annotation>

</enumeration>

<documentation>Attribute has to be selected in combination with dimensions.</documentation>

</annotation>

</enumeration>

<documentation>The provided report violates one or more constraints, which govern incompatibilities and requirements between different report properties. Some reasons for constraint violations include: <ul> <li>Not all {@link Column} objects requested are supported for the given set of {@link Dimension} objects. <li>The report's date range is not compatible with the given set of {@link Column} objects. <li>The report's {@link TimeZoneType} is not compatible with the given set of {@link Column} and {@link Dimension} objects (version 201802 and later). <li>The report's currency is not compatible with the given set of {@link Column} objects. </ul> For versions 201911 and later, this is only returned when some or all of the {@link Column} objects are not supported for the requested {@link Dimension} objects.</documentation>

</annotation>

</enumeration>

<documentation>The report's date range is not compatible with the requested {@link Dimension} and {@link Column} objects.</documentation>

</annotation>

</enumeration>

<documentation>The report's {@link TimeZoneType} is not compatible with the requested {@link Column} and {@link Dimension} objects.</documentation>

</annotation>

</enumeration>

<documentation>The report's currency is not compatible with the requested {@link Column} objects.</documentation>

</annotation>

</enumeration>

<documentation>Failed to store/cache a report.</documentation>

</annotation>

</enumeration>

<documentation>The requested report does not exist.</documentation>

</annotation>

</enumeration>

<documentation>User has no permission to view in another network.</documentation>

</annotation>

</enumeration>

<documentation>The report's {@link AdUnitView} is not compatible with the requested {@link Dimension} and {@link Column} objects.</documentation>

</annotation>

</enumeration>

<documentation>The report uses a field that has been temporarily disabled. See more details at https://ads.google.com/status/publisher.</documentation>

</annotation>

</enumeration>

<documentation>The value returned if the actual value is not exposed by the requested API version.</documentation>

</annotation>

</enumeration>

</restriction>

</simpleType>

<documentation>Represents the status of a {@link ReportJob} running on the server.</documentation>

</annotation>

<documentation>The {@link ReportJob} has completed successfully and is ready to download.</documentation>

</annotation>

</enumeration>

<documentation>The {@link ReportJob} is still being executed.</documentation>

</annotation>

</enumeration>

<documentation>The {@link ReportJob} has failed to run to completion.</documentation>

</annotation>

</enumeration>

</restriction>

</simpleType>

<documentation>A required collection is missing.</documentation>

</annotation>

</enumeration>

<documentation>Collection size is too large.</documentation>

</annotation>

</enumeration>

<documentation>Collection size is too small.</documentation>

</annotation>

</enumeration>

<documentation>The value returned if the actual value is not exposed by the requested API version.</documentation>

</annotation>

</enumeration>

</restriction>

</simpleType>

<documentation>The reasons for the target error.</documentation>

</annotation>

<documentation>Missing required field.</documentation>

</annotation>

</enumeration>

</restriction>

</simpleType>

<documentation>Describes reasons for server errors</documentation>

</annotation>

<documentation>Indicates that an unexpected error occured.</documentation>

</annotation>

</enumeration>

<documentation>Indicates that the server is currently experiencing a high load. Please wait and try your request again.</documentation>

</annotation>

</enumeration>

<documentation>The value returned if the actual value is not exposed by the requested API version.</documentation>

</annotation>

</enumeration>

</restriction>

</simpleType>

<documentation>A bind variable has not been bound to a value.</documentation>

</annotation>

</enumeration>

<documentation>The value returned if the actual value is not exposed by the requested API version.</documentation>

</annotation>

</enumeration>

</restriction>

</simpleType>

<documentation>The reasons for the target error.</documentation>

</annotation>

<documentation>The input string value contains disallowed characters.</documentation>

</annotation>

</enumeration>

<documentation>The input string value is invalid for the associated field.</documentation>

</annotation>

</enumeration>

</restriction>

</simpleType>

<documentation>The value returned if the actual value is not exposed by the requested API version.</documentation>

</annotation>

</enumeration>

</restriction>

</simpleType>

<documentation>Enumerates all allowed time zones that can be used in reports. Note that some time zones are only compatible with specific fields.</documentation>

</annotation>

<documentation>The value returned if the actual value is not exposed by the requested API version.</documentation>

</annotation>

</enumeration>

<documentation>Use the publisher's time zone. For Ad Manager reports, this time zone is compatible with all metrics. For Ad Exchange reports, this time zone is not compatible with "Bids" and "Deals" metrics. Note: if your report includes "time unit" dimensions, only the Ad Manager "time unit" dimensions are compatible with this timezone, e.g.: <ul> <li> {@link com.google.ads.publisher.api.service.reports.Dimension.DATE} <li> {@link com.google.ads.publisher.api.service.reports.Dimension.WEEK} <li> {@link com.google.ads.publisher.api.service.reports.Dimension.MONTH_AND_YEAR} </ul></documentation>

</annotation>

</enumeration>

<documentation>Use the PT time zone. This time zone is only compatible with Ad Exchange metrics in Historical report type. Note: if your report includes "time unit" dimensions, only the PT "time unit" dimensions are compatible with this timezone, e.g.: <ul> <li>{@link com.google.ads.publisher.api.service.reports.Dimension.DATE_PT} <li>{@link com.google.ads.publisher.api.service.reports.Dimension.WEEK_PT} <li>{@link com.google.ads.publisher.api.service.reports.Dimension.MONTH_YEAR_PT} <li>{@link com.google.ads.publisher.api.service.reports.Dimension.DAY_PT} </ul></documentation>

</annotation>

</enumeration>

</restriction>

</simpleType>

<documentation>Returns the URL at which the report file can be downloaded. The report will be generated as a gzip archive, containing the report file itself.</documentation>

</annotation>

</sequence>

</complexType>

</element>

</sequence>

</complexType>

</element>

<documentation>A fault element of type ApiException.</documentation>

</annotation>

</element>

<documentation>Returns the URL at which the report file can be downloaded, and allows for customization of the downloaded report. By default, the report will be generated as a gzip archive, containing the report file itself. This can be changed by setting {@link ReportDownloadOptions#useGzipCompression} to false.</documentation>

</annotation>

</sequence>

</complexType>

</element>

</sequence>

</complexType>

</element>

<documentation>Returns the {@link ReportJobStatus} of the report job with the specified ID.</documentation>

</annotation>

</sequence>

</complexType>

</element>

</sequence>

</complexType>

</element>

<documentation>Retrieves a page of the saved queries either created by or shared with the current user. Each {@link SavedQuery} in the page, if it is compatible with the current API version, will contain a {@link ReportQuery} object which can be optionally modified and used to create a {@link ReportJob}. This can then be passed to {@link ReportService#runReportJob}. The following fields are supported for filtering: <table> <tr> <th scope="col">PQL Property</th> <th scope="col">Object Property</th> </tr> <tr> <td>{@code id}</td> <td>{@link SavedQuery#id}</td> </tr> <tr> <td>{@code name}</td> <td>{@link SavedQuery#name}</td> </tr> </table></documentation>

</annotation>

</sequence>

</complexType>

</element>

</sequence>

</complexType>

</element>

<documentation>Initiates the execution of a {@link ReportQuery} on the server. The following fields are required: <ul> <li>{@link ReportJob#reportQuery} </ul></documentation>

</annotation>

</sequence>

</complexType>

</element>

</sequence>

</complexType>

</element>

</schema>

</wsdl:types>

<wsdl:message name="RequestHeader">

<wsdl:part element="tns:RequestHeader" name="RequestHeader"/>

</wsdl:message>

<wsdl:message name="ResponseHeader">

<wsdl:part element="tns:ResponseHeader" name="ResponseHeader"/>

</wsdl:message>

<wsdl:message name="getReportDownloadURLRequest">

<wsdl:part element="tns:getReportDownloadURL" name="parameters"/>

</wsdl:message>

<wsdl:message name="getReportDownloadURLResponse">

<wsdl:part element="tns:getReportDownloadURLResponse" name="parameters"/>

</wsdl:message>

<wsdl:message name="ApiException">

<wsdl:part element="tns:ApiExceptionFault" name="ApiException"/>

</wsdl:message>

<wsdl:message name="getReportDownloadUrlWithOptionsRequest">

<wsdl:part element="tns:getReportDownloadUrlWithOptions" name="parameters"/>

</wsdl:message>

<wsdl:message name="getReportDownloadUrlWithOptionsResponse">

<wsdl:part element="tns:getReportDownloadUrlWithOptionsResponse" name="parameters"/>

</wsdl:message>

<wsdl:message name="getReportJobStatusRequest">

<wsdl:part element="tns:getReportJobStatus" name="parameters"/>

</wsdl:message>

<wsdl:message name="getReportJobStatusResponse">

<wsdl:part element="tns:getReportJobStatusResponse" name="parameters"/>

</wsdl:message>

<wsdl:message name="getSavedQueriesByStatementRequest">

<wsdl:part element="tns:getSavedQueriesByStatement" name="parameters"/>

</wsdl:message>

<wsdl:message name="getSavedQueriesByStatementResponse">

<wsdl:part element="tns:getSavedQueriesByStatementResponse" name="parameters"/>

</wsdl:message>

<wsdl:message name="runReportJobRequest">

<wsdl:part element="tns:runReportJob" name="parameters"/>

</wsdl:message>

<wsdl:message name="runReportJobResponse">

<wsdl:part element="tns:runReportJobResponse" name="parameters"/>

</wsdl:message>

<wsdl:portType name="ReportServiceInterface">

<wsdl:documentation>Provides methods for executing a {@link ReportJob} and retrieving performance and statistics about ad campaigns, networks, inventory and sales. Follow the steps outlined below: <ul> <li>Create the {@code ReportJob} object by invoking {@link ReportService#runReportJob}. <li>Poll the report job status using {@link ReportService#getReportJobStatus}. <li>Continue to poll until the status is equal to {@link ReportJobStatus#COMPLETED} or {@link ReportJobStatus#FAILED}. <li>If successful, fetch the URL for downloading the report by invoking {@link ReportService#getReportDownloadURL}. </ul> <h4>Test network behavior</h4> The networks created using {@link NetworkService#makeTestNetwork} are unable to provide reports that would be comparable to the production environment because reports require traffic history. In the test networks, reports will consistently return no data for all reports.</wsdl:documentation>

<wsdl:operation name="getReportDownloadURL">

<wsdl:documentation>Returns the URL at which the report file can be downloaded. The report will be generated as a gzip archive, containing the report file itself.</wsdl:documentation>

<wsdl:input message="tns:getReportDownloadURLRequest" name="getReportDownloadURLRequest"/>

<wsdl:output message="tns:getReportDownloadURLResponse" name="getReportDownloadURLResponse"/>

<wsdl:fault message="tns:ApiException" name="ApiException"/>

</wsdl:operation>

<wsdl:operation name="getReportDownloadUrlWithOptions">

<wsdl:documentation>Returns the URL at which the report file can be downloaded, and allows for customization of the downloaded report. By default, the report will be generated as a gzip archive, containing the report file itself. This can be changed by setting {@link ReportDownloadOptions#useGzipCompression} to false.</wsdl:documentation>

<wsdl:input message="tns:getReportDownloadUrlWithOptionsRequest" name="getReportDownloadUrlWithOptionsRequest"/>

<wsdl:output message="tns:getReportDownloadUrlWithOptionsResponse" name="getReportDownloadUrlWithOptionsResponse"/>

<wsdl:fault message="tns:ApiException" name="ApiException"/>

</wsdl:operation>

<wsdl:operation name="getReportJobStatus">

<wsdl:documentation>Returns the {@link ReportJobStatus} of the report job with the specified ID.</wsdl:documentation>

<wsdl:input message="tns:getReportJobStatusRequest" name="getReportJobStatusRequest"/>

<wsdl:output message="tns:getReportJobStatusResponse" name="getReportJobStatusResponse"/>

<wsdl:fault message="tns:ApiException" name="ApiException"/>

</wsdl:operation>

<wsdl:operation name="getSavedQueriesByStatement">

<wsdl:documentation>Retrieves a page of the saved queries either created by or shared with the current user. Each {@link SavedQuery} in the page, if it is compatible with the current API version, will contain a {@link ReportQuery} object which can be optionally modified and used to create a {@link ReportJob}. This can then be passed to {@link ReportService#runReportJob}. The following fields are supported for filtering: <table> <tr> <th scope="col">PQL Property</th> <th scope="col">Object Property</th> </tr> <tr> <td>{@code id}</td> <td>{@link SavedQuery#id}</td> </tr> <tr> <td>{@code name}</td> <td>{@link SavedQuery#name}</td> </tr> </table></wsdl:documentation>

<wsdl:input message="tns:getSavedQueriesByStatementRequest" name="getSavedQueriesByStatementRequest"/>

<wsdl:output message="tns:getSavedQueriesByStatementResponse" name="getSavedQueriesByStatementResponse"/>

<wsdl:fault message="tns:ApiException" name="ApiException"/>

</wsdl:operation>

<wsdl:operation name="runReportJob">

<wsdl:documentation>Initiates the execution of a {@link ReportQuery} on the server. The following fields are required: <ul> <li>{@link ReportJob#reportQuery} </ul></wsdl:documentation>

<wsdl:input message="tns:runReportJobRequest" name="runReportJobRequest"/>

<wsdl:output message="tns:runReportJobResponse" name="runReportJobResponse"/>

<wsdl:fault message="tns:ApiException" name="ApiException"/>

</wsdl:operation>

</wsdl:portType>

<wsdl:binding name="ReportServiceSoapBinding" type="tns:ReportServiceInterface">

<wsdlsoap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http"/>

<wsdl:operation name="getReportDownloadURL">

<wsdlsoap:operation soapAction=""/>

<wsdl:input name="getReportDownloadURLRequest">

<wsdlsoap:header message="tns:RequestHeader" part="RequestHeader" use="literal"/>

<wsdlsoap:body use="literal"/>

</wsdl:input>

<wsdl:output name="getReportDownloadURLResponse">

<wsdlsoap:header message="tns:ResponseHeader" part="ResponseHeader" use="literal"/>

<wsdlsoap:body use="literal"/>

</wsdl:output>

<wsdl:fault name="ApiException">

<wsdlsoap:fault name="ApiException" use="literal"/>

</wsdl:fault>

</wsdl:operation>

<wsdl:operation name="getReportDownloadUrlWithOptions">

<wsdlsoap:operation soapAction=""/>

<wsdl:input name="getReportDownloadUrlWithOptionsRequest">

<wsdlsoap:header message="tns:RequestHeader" part="RequestHeader" use="literal"/>

<wsdlsoap:body use="literal"/>

</wsdl:input>

<wsdl:output name="getReportDownloadUrlWithOptionsResponse">

<wsdlsoap:header message="tns:ResponseHeader" part="ResponseHeader" use="literal"/>

<wsdlsoap:body use="literal"/>

</wsdl:output>

<wsdl:fault name="ApiException">

<wsdlsoap:fault name="ApiException" use="literal"/>

</wsdl:fault>

</wsdl:operation>

<wsdl:operation name="getReportJobStatus">

<wsdlsoap:operation soapAction=""/>

<wsdl:input name="getReportJobStatusRequest">

<wsdlsoap:header message="tns:RequestHeader" part="RequestHeader" use="literal"/>

<wsdlsoap:body use="literal"/>

</wsdl:input>

<wsdl:output name="getReportJobStatusResponse">

<wsdlsoap:header message="tns:ResponseHeader" part="ResponseHeader" use="literal"/>

<wsdlsoap:body use="literal"/>

</wsdl:output>

<wsdl:fault name="ApiException">

<wsdlsoap:fault name="ApiException" use="literal"/>

</wsdl:fault>

</wsdl:operation>

<wsdl:operation name="getSavedQueriesByStatement">

<wsdlsoap:operation soapAction=""/>

<wsdl:input name="getSavedQueriesByStatementRequest">

<wsdlsoap:header message="tns:RequestHeader" part="RequestHeader" use="literal"/>

<wsdlsoap:body use="literal"/>

</wsdl:input>

<wsdl:output name="getSavedQueriesByStatementResponse">

<wsdlsoap:header message="tns:ResponseHeader" part="ResponseHeader" use="literal"/>

<wsdlsoap:body use="literal"/>

</wsdl:output>

<wsdl:fault name="ApiException">

<wsdlsoap:fault name="ApiException" use="literal"/>

</wsdl:fault>

</wsdl:operation>

<wsdl:operation name="runReportJob">

<wsdlsoap:operation soapAction=""/>

<wsdl:input name="runReportJobRequest">

<wsdlsoap:header message="tns:RequestHeader" part="RequestHeader" use="literal"/>

<wsdlsoap:body use="literal"/>

</wsdl:input>

<wsdl:output name="runReportJobResponse">

<wsdlsoap:header message="tns:ResponseHeader" part="ResponseHeader" use="literal"/>

<wsdlsoap:body use="literal"/>

</wsdl:output>

<wsdl:fault name="ApiException">

<wsdlsoap:fault name="ApiException" use="literal"/>

</wsdl:fault>

</wsdl:operation>

</wsdl:binding>

<wsdl:service name="ReportService">

<wsdl:port binding="tns:ReportServiceSoapBinding" name="ReportServiceInterfacePort">

<wsdlsoap:address location="https://ads.google.com/apis/ads/publisher/v202502/ReportService"/>

</wsdl:port>

</wsdl:service>

</wsdl:definitions>

About wsdl-viewer.xsl

This document was generated by SAXON 9.1.0.8 from Saxonica XSLT engine. The engine processed the WSDL in XSLT 2.0 compliant mode.

This page has been generated bywsdl-viewer.xsl, version 3.1.02
Author: tomi vanek
Download athttp://tomi.vanek.sk/xml/wsdl-viewer.xsl.

The transformation was inspired by the article
Uche Ogbuji: WSDL processing with XSLT

Web Service: ReportService