Google Display & Video 360 API Reference

The public API procedures may call the internal procedures which should not be used directly as they can be changed without any explicit notification in the newer versions of the connector. Internal procedures can be recognized by the internal_ prefix in their names. Public API procedures do not have such prefixes in their names.

DataRange

Data ranges to be used in reports

Parameter

Attribute	Type	Description
dataRange	string	Data range
description	string	Data range name

Filters

Filters to be used in reports

Parameter

Attribute	Type	Description
filter	string	Filter
description	string	Report builder name

Metrics

Metrics to be used in reports

Parameter

Attribute	Type	Description
metric	string	Metric
description	string	Report builder name

Queries

Retrieves stored queries

Parameter
<queryId> (optional): Query ID to retrieve
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
queryId	long	Query ID
metadata_title	string	Query title
metadata_dataRange	string	Range of report data
reportDataStartTimeMs	timestamp	The starting time for the data that is shown in the report
reportDataEndTimeMs	timestamp	The ending time for the data that is shown in the report
metadata_latestReportRunTimeMs	timestamp	The time when the latest report started to run
metadata_format	string	Format of the generated report
metadata_googleCloudStoragePathForLatestReport	string	The path to the location in Google Cloud Storage where the latest report is stored
metadata_googleDrivePathForLatestReport	string	The path in Google Drive for the latest report
metadata_locale	string	Locale of the generated reports
metadata_reportCount	integer	Number of reports that have been generated for the query
metadata_running	boolean	Whether the latest report is currently running
metadata_sendNotification	boolean	Whether to send an email notification when a report is ready
metadata_shareEmailAddress	string	List of email addresses that are sent email notifications when the report is finished
params_filters	string	Filters used to match traffic data in your report
params_groupBys	string	Data is grouped by the filters listed in this field
params_includeInviteData	boolean	Deprecated
params_metrics	string	Metrics to include as columns in your report
params_options_includeOnlyTargetedUserLists	boolean	Whether to only include data for audience lists specifically targeted by insertion orders or line items
params_options_pathQueryOptions_channelGrouping_fallbackName	string	The name to apply to an event that does not match any of the rules in the channel grouping
params_options_pathQueryOptions_channelGrouping_name	string	Channel Grouping name
params_type	string	Report type
schedule_endTimeMs	timestamp	Date to stop running scheduled query, in milliseconds since the Unix epoch
schedule_frequency	string	How often the query is run
schedule_nextRunMinuteOfDay	integer	Deprecated
schedule_nextRunTimezoneCode	string	Canonical timezone code for report generation time
schedule_startTimeMs	timestamp	Date to start running scheduled query, in milliseconds since the Unix epoch
timezoneCode	string	Canonical timezone code for report data time
kind	string	Identifies what kind of resource this is

QueryCreate

Creates a query

Parameter
<asynchronous> (optional): Whether the query should be run asynchronously
<title> (optional): Query title
<reportType> (optional): Report type. Type-specific limitations: TYPE_ORDER_ID supports date ranges at most 60 days in the past. TYPE_AUDIENCE_COMPOSITION, TYPE_INVENTORY_AVAILABILITY, TYPE_TRUEVIEW_IAR support date ranges at most 30 days in the past. Acceptable values are in procedure google_display_video.ReportTypes ()
<dataRange> (optional): Range of report data
<dataStart> (optional): The starting date for the data to be shown in the report
<dataEnd> (optional): The ending date for the data to be shown in the report
<groupBys> (optional): CSV list of Filters to group data by
<metrics> (optional): CSV list of Metrics to include as columns in your report
<includeOnlyTargetedUserLists> (optional): Whether to only include data for audience lists specifically targeted by insertion orders or line items. Only applicable for TYPE_GENERAL reports. FILTER_AUDIENCE_LIST must be included as a filter or dimension. Either FILTER_INSERTION_ORDER or FILTER_LINE_ITEM must be included as a filter
<timezoneCode> (optional): Canonical timezone code for report data time
<label> (optional): Multi-tenancy label

Attribute	Type	Description
queryId	long	Query ID
metadata_title	string	Query title
metadata_dataRange	string	Range of report data
reportDataStartTimeMs	timestamp	The starting time for the data that is shown in the report
reportDataEndTimeMs	timestamp	The ending time for the data that is shown in the report
metadata_latestReportRunTimeMs	timestamp	The time when the latest report started to run
metadata_format	string	Format of the generated report
metadata_googleCloudStoragePathForLatestReport	string	The path to the location in Google Cloud Storage where the latest report is stored
metadata_googleDrivePathForLatestReport	string	The path in Google Drive for the latest report
metadata_locale	string	Locale of the generated reports
metadata_reportCount	integer	Number of reports that have been generated for the query
metadata_running	boolean	Whether the latest report is currently running
metadata_sendNotification	boolean	Whether to send an email notification when a report is ready
metadata_shareEmailAddress	string	List of email addresses that are sent email notifications when the report is finished
params_filters	string	Filters used to match traffic data in your report
params_groupBys	string	Data is grouped by the filters listed in this field
params_includeInviteData	boolean	Deprecated
params_metrics	string	Metrics to include as columns in your report
params_options_includeOnlyTargetedUserLists	boolean	Whether to only include data for audience lists specifically targeted by insertion orders or line items
params_options_pathQueryOptions_channelGrouping_fallbackName	string	The name to apply to an event that does not match any of the rules in the channel grouping
params_options_pathQueryOptions_channelGrouping_name	string	Channel Grouping name
params_type	string	Report type
schedule_endTimeMs	timestamp	Date to stop running scheduled query, in milliseconds since the Unix epoch
schedule_frequency	string	How often the query is run
schedule_nextRunMinuteOfDay	integer	Deprecated
schedule_nextRunTimezoneCode	string	Canonical timezone code for report generation time
schedule_startTimeMs	timestamp	Date to start running scheduled query, in milliseconds since the Unix epoch
timezoneCode	string	Canonical timezone code for report data time
kind	string	Identifies what kind of resource this is

QueryDelete

Deletes a stored query as well as the associated stored reports. Try it now

Parameter
<queryId> (optional): Query ID to delete.
<label> (optional): Multi-tenancy label

Attribute	Type	Description
success	boolean

QueryReportFiles

Retrieves stored reports

Parameter
<queryId> (optional): Query ID with which the reports are associated
<preview> (optional): Preview only, don't write into the table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
queryId	long	Query ID
reportId	long	Report ID
googleCloudStoragePath	string	The path to the location in Google Cloud Storage where the report is stored
reportDataEndTimeMs	timestamp	The ending time for the data that is shown in the report
reportDataStartTimeMs	timestamp	The starting time for the data that is shown in the report
status_finishTimeMs	timestamp	The time when this report either completed successfully or failed
status	string	The state of the report
groupBys	string	Data is grouped by the filters listed in this field
metrics	string	Metrics to include as columns in your report
options_includeOnlyTargetedUserLists	boolean	Whether to only include data for audience lists specifically targeted by insertion orders or line items

QueryRun

Runs a stored query to generate a report

Parameter
<asynchronous> (optional): Whether the query should be run asynchronously
<queryId> (optional): Query ID to run
<dataRange> (optional): Range of report data
<dataStart> (optional): The starting date for the data to be shown in the report
<dataEnd> (optional): The ending date for the data to be shown in the report
<timezoneCode> (optional): Canonical timezone code for report data time
<label> (optional): Multi-tenancy label

Attribute	Type	Description
success	boolean

ReportTypes

Report types to be used in reports

Parameter

Attribute	Type	Description
type	string	Report type
description	string	Report type name

Q_<query name>

Format of auto-generated procedures based on queries returned by procedure Queries. These procedures read, parse and show reports generated for the corresponding query.

Parameter
<dataRange> (optional): Range of report data
<dataStart> (optional): The starting date for the data to be shown in the report
<dataEnd> (optional): The ending date for the data to be shown in the report
<timezoneCode> (optional): Canonical timezone code for report data time
<reportUrl> (optional): Path to the report to download and parse (e.g. one returned in the columns googleCloudStoragePath and metadata_googleCloudStoragePathForLatestReport of the procedures QueryReportFiles and Queries)
<daysToRedownload> (optional): How many days to query into the past
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Attribute	Type	Description
<groupBy>	string or date	0 or more filters listed in the column params_groupBys returned by procedure Queries. Full list of metrics is in the procedure Filters.
<metric>	decimal	1 or more metrics listed in the column params_metrics returned by procedure Queries. Full list of metrics is in the procedure Metrics.