Package google.ads.adsdatahub.v1

Index

CustomerService

The Ads Data Hub CustomerService allows users to retrieve Ads Data Hub customers to which the user has access. It also manages ad data links from Ads Data Hub customers to other Google advertising entities.

GetCustomer

rpc GetCustomer(GetCustomerRequest) returns (Customer)

Retrieves the requested Ads Data Hub customer.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adsdatahub
ListCustomers

rpc ListCustomers(ListCustomersRequest) returns (ListCustomersResponse)

Lists Ads Data Hub customers to which the current user has access.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adsdatahub

QueryService

The Ads Data Hub QueryService allows customers to create and execute queries to generate reports from their data in BigQuery joined with Google data.

CreateAnalysisQuery

rpc CreateAnalysisQuery(CreateAnalysisQueryRequest) returns (AnalysisQuery)

Creates an analysis query for later execution. No query validation is performed at this time.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adsdatahub
CreateUserListQuery

rpc CreateUserListQuery(CreateUserListQueryRequest) returns (UserListQuery)

Creates a user list query for later execution. No query validation is performed at this time.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adsdatahub
DeleteAnalysisQuery

rpc DeleteAnalysisQuery(DeleteAnalysisQueryRequest) returns (Empty)

Deletes an analysis query.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adsdatahub
DeleteUserListQuery

rpc DeleteUserListQuery(DeleteUserListQueryRequest) returns (Empty)

Deletes a user list query.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adsdatahub
GetAnalysisQuery

rpc GetAnalysisQuery(GetAnalysisQueryRequest) returns (AnalysisQuery)

Retrieves the requested analysis query.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adsdatahub
GetUserListQuery

rpc GetUserListQuery(GetUserListQueryRequest) returns (UserListQuery)

Retrieves the requested user list query.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adsdatahub
ListAnalysisQueries

rpc ListAnalysisQueries(ListAnalysisQueriesRequest) returns (ListAnalysisQueriesResponse)

Lists the analysis queries owned by the specified customer.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adsdatahub
ListUserListQueries

rpc ListUserListQueries(ListUserListQueriesRequest) returns (ListUserListQueriesResponse)

Lists the user list queries owned by the specified customer.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adsdatahub
StartAnalysisQuery

rpc StartAnalysisQuery(StartAnalysisQueryRequest) returns (Operation)

Starts execution on a stored analysis query. The results will be written to the specified BigQuery destination table. The returned operation name can be used to poll for query completion status.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adsdatahub
StartTransientAnalysisQuery

rpc StartTransientAnalysisQuery(StartTransientAnalysisQueryRequest) returns (Operation)

Starts execution on a transient analysis query. The results will be written to the specified BigQuery destination table. The returned operation name can be used to poll for query completion status.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adsdatahub
StartTransientUserListQuery

rpc StartTransientUserListQuery(StartTransientUserListQueryRequest) returns (Operation)

Starts execution on a transient user list query. The results uploaded to the specified Google Ads user list. The returned operation name can be used to poll for query completion status.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adsdatahub
StartUserListQuery

rpc StartUserListQuery(StartUserListQueryRequest) returns (Operation)

Starts execution on a stored user list query. The results uploaded to the specified Google Ads user list. The returned operation name can be used to poll for query completion status.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adsdatahub
UpdateAnalysisQuery

rpc UpdateAnalysisQuery(UpdateAnalysisQueryRequest) returns (AnalysisQuery)

Updates an existing analysis query. Partial updates are supported. The following query fields cannot be updated using this method and will be ignored:

  • query_state
  • create_time
  • create_email
  • update_time
  • update_email
Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adsdatahub
UpdateUserListQuery

rpc UpdateUserListQuery(UpdateUserListQueryRequest) returns (UserListQuery)

Updates an existing user list query. Partial updates are supported. The following query fields cannot be updated using this method and will be ignored:

  • create_time
  • create_email
  • update_time
  • update_email
Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adsdatahub
ValidateAnalysisQuery

rpc ValidateAnalysisQuery(ValidateAnalysisQueryRequest) returns (ValidateAnalysisQueryResponse)

Performs static validation checks on the provided analysis query.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adsdatahub
ValidateUserListQuery

rpc ValidateUserListQuery(ValidateUserListQueryRequest) returns (ValidateUserListQueryResponse)

Performs static validation checks on the provided user list query.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adsdatahub

TableService

The Ads Data Hub TableService allows users to retrieve schemas for Ads Data Hub tables and temp tables.

GetTable

rpc GetTable(GetTableRequest) returns (Table)

Retrieves the requested Ads Data Hub table.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adsdatahub
GetTempTable

rpc GetTempTable(GetTempTableRequest) returns (TempTable)

Retrieves the requested Ads Data Hub temp table.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adsdatahub
ListTables

rpc ListTables(ListTablesRequest) returns (ListTablesResponse)

Lists the Ads Data Hub tables to which the specified customer has access.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adsdatahub
ListTempTables

rpc ListTempTables(ListTempTablesRequest) returns (ListTempTablesResponse)

Lists the Ads Data Hub temp tables that the customer has created. Temp tables are created for a specific ads data customer ID, match data customer ID, and query type.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adsdatahub

UserListService

The Ads Data Hub UserListService allows users to create and retrieved Google Ads user lists managed through Ads Data Hub.

CreateUserList

rpc CreateUserList(CreateUserListRequest) returns (UserList)

Creates an Ads Data Hub-managed Google Ads user list.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adsdatahub
GetUserList

rpc GetUserList(GetUserListRequest) returns (UserList)

Retrieves the requested Ads Data Hub-managed user list.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adsdatahub
ListUserLists

rpc ListUserLists(ListUserListsRequest) returns (ListUserListsResponse)

Lists the user lists managed by the specified Ads Data Hub customer.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adsdatahub

Entity

Represents an advertising entity that can be linked to an Ads Data Hub customer.

Fields
entity_id

int64

Entity ID. The value listed here is dependent on the entity type.

display_name

string

Entity display name.

type

EntityType

Type of linked entity.

EntityType

Supported advertising entities.

Enums
ENTITY_TYPE_UNSPECIFIED Unspecified entity type.
GOOGLE_ADS_CUSTOMER A Google Ads customer. The entity_id corresponds to [Customer.id][https://developers.google.com/google-ads/api/reference/rpc/google.ads.googleads.v0.resources#customer] in the Google Ads API.
GOOGLE_ADS_CAMPAIGN A Google Ads campaign. The entity_id corresponds to [Campaign.id][https://developers.google.com/google-ads/api/reference/rpc/google.ads.googleads.v0.resources#campaign] in the Google Ads API.
GMP_CM_ACCOUNT A Google Marketing Platform Campaign Manager account. The entity_id corresponds to [Accounts.id][https://developers.google.com/doubleclick-advertisers/v3.3/accounts]
GMP_CM_FLOODLIGHT A Campaign Manager floodlight account. The entity_id corresponds to [FloodlightConfigurations.accountId][https://developers.google.com/doubleclick-advertisers/v3.3/floodlightConfigurations]
GMP_DV360_PARTNER A Display & Video 360 partner ID. The entity_id is a DV360 partner ID.
GMP_DV360_ADVERTISER A Display & Video 360 advertiser ID. The entity_id is a DV360 advertiser ID.

Metric

Metrics that can be exposed through ad data links.

Enums
METRIC_UNSPECIFIED Unspecified metric.
BRAND_LIFT The link allows access to Brand Lift data, if available.
BRAND_SAFETY The link allows access to brand safety data, if available.
REACH The link allows access to reach data, if available.
VIEWABILITY The link allows access to viewability data, if available.

Platform

Supported advertising platforms.

Enums
PLATFORM_UNSPECIFIED Unspecified platform.
GOOGLE_ADS The entity is associated with Google Ads.
GOOGLE_MARKETING_PLATFORM The entity is associated with Google Marketing Platform.

AnalysisQuery

Defines an analysis query that can be executed within Ads Data Hub.

Fields
name

string

Name that uniquely identifies a query. It has the form customers/[customer_id]/analysisQueries/[resource_id], e.g. 'customers/123/analysisQueries/abcd1234'. The resource ID is generated by the server.

title

string

Query title, which is unique within a single Ads Data Hub customer and query type.

query_text

string

Query text written in Standard SQL. See https://cloud.google.com/bigquery/docs/reference/standard-sql/.

parameter_types

map<string, ParameterType>

Any additional parameters expected by the query. Maps each argument name to its argument type.

merge_spec

MergeSpec

Instructions for row merging. If present, then any rows that would have been dropped for privacy reasons will be combined into a single merged row. The merged row will be included in the final output if the merged row meets privacy requirements.

query_state

QueryState

Query state.

update_time

Timestamp

Time the query was last updated.

update_email

string

Email address of user who last updated the query.

create_time

Timestamp

Time the query was created.

create_email

string

Email address of user who created the query.

query_share[]

QueryShare

Indicates ways that a query may be shared beyond the owning Ads Data Hub customer.

ArrayValue

Defines an array parameter value.

Fields
values[]

ParameterValue

The array values.

Column

Defines a Table column.

Fields
column_id

string

Column identifier.

column_type

FieldType

Column type.

CreateAnalysisQueryRequest

Request to create a new analysis query.

Fields
parent

string

The parent resource name that owns the query, e.g. 'customers/123'.

query

AnalysisQuery

The query to create.

CreateUserListQueryRequest

Request to create a new user list query.

Fields
parent

string

The parent resource name that owns the query, e.g. 'customers/123'.

query

UserListQuery

The query to create.

CreateUserListRequest

Request to create an Ads Data Hub-managed Google Ads user list.

Fields
parent

string

The parent resource name that owns the user list, e.g. 'customers/123'.

user_list

UserList

The user list to create.

Customer

An Ads Data Hub customer.

Fields
name

string

Name that uniquely identifies a customer. It should have the form customers/[customer_id], e.g 'customers/123'.

customer_id

int64

Ads Data Hub customer ID.

display_name

string

Descriptive customer name.

AccessType

Types of access allowed.

Enums
ACCESS_TYPE_UNSPECIFIED Unspecified access type.
ADS_DATA If this is an inbound link, the linked customer has provided access to their Ads Data Hub ads data and can be listed as an ads_data_customer_id during query execution. If this is an outbound link, the linked customer has access to the current customer's ads data.
MATCH_DATA If this is an inbound link, the linked customer has provided access to their Ads Data Hub match table data and can be listed as a match_data_customer_id during query execution. If this is an outbound link, the linked customer has access to the current customer's match table data.
MANAGEMENT Management links specify how link permissions propagate across customers. E.g., if A has an inbound management link to B and B has an inbound ads data link to C, then A has an indirect inbound ads data link to C. If A manages B and B manages C, then A will have inbound management links to both B and C, and C will have outbound management links to both A and B.

DeleteAnalysisQueryRequest

Request to delete an analysis query.

Fields
name

string

The full name of the analysis query to delete. This is of the form 'customers/[customer_id]/analysisQueries/[resource_id]', e.g. 'customers/123/analysisQueries/resource123'.

DeleteUserListQueryRequest

Request to delete a user list query.

Fields
name

string

The full name of the user list query to delete. This is of the form 'customers/[customer_id]/userListQueries/[resource_id]', e.g. 'customers/123/userListQueries/resource123'.

FieldType

Defines a BigQuery field type.

Fields
Union field field_type. Field type. field_type can be only one of the following:
type

string

BigQuery simple type, e.g. 'STRING' or 'INT64'. See https://cloud.google.com/bigquery/docs/reference/standard-sql/data-types.

array_type

FieldType

Type of the array's elements, if this is an 'ARRAY' type.

struct_type

StructType

Struct field type, if this is a 'STRUCT' type.

GetAnalysisQueryRequest

Request to retrieve the analysis query with the provided name.

Fields
name

string

Full resource name, e.g. 'customers/123/analysisQueries/abcd1234'.

GetCustomerRequest

Request to retrieve an Ads Data Hub customer.

Fields
name

string

Full resource name, e.g. 'customers/123'.

GetTableRequest

Request to retrieve an Ads Data Hub table.

Fields
name

string

Full resource name, e.g. 'customers/123/tables/adh.google_ads_impressions.

ads_data_customer_id

int64

Optional. Linked Ads Data Hub customer ID that owns the ads data used by the table. Only relevant if the table is an ADH table with ads data.

match_data_customer_id

int64

Optional. Linked Ads Data Hub customer ID that owns the match data for the query. Only relevant if the table is an ADH table with match data.

GetTempTableRequest

Request to retrieve an Ads Data Hub temp table.

Fields
name

string

Full resource name, e.g. 'customers/123/tables/resource-id'.

GetUserListQueryRequest

Request to retrieve the user list query with the provided name.

Fields
name

string

Full resource name, e.g. 'customers/123/userListQueries/abcd1234'.

GetUserListRequest

Request to retrieve an Ads Data Hub-managed Google Ads user list.

Fields
name

string

Full resource name, e.g. 'customers/123/userLists/12345678.

LinkStatus

Possible account link statuses.

Enums
PENDING The link request has not been answered.
APPROVED The link has been approved and is active.
REJECTED The link has been rejected.

ListAdsDataLinksRequest

Request to retrieve a list ad data links.

Fields
parent

string

Parent customer resource name, e.g. 'customers/123'.

page_size

int32

Maximum number of items to return. If 0, the server will determine the number of linked customers to return.

page_token

string

Page token, returned by a previous call, used to request the next page of results, if any.

filter

string

The standard list filter.

ListAdsDataLinksResponse

Response to a ListAdsDataLinks request.

Fields
next_page_token

string

A token that can be used to request the next results page. This field is empty if there are no additional results.

ListAnalysisQueriesRequest

Request to retrieve a list of available analysis queries.

Fields
parent

string

Parent customer resource name, e.g. 'customers/123'.

page_size

int32

Maximum number of items to return. If 0, The server will determine the number of queries to return.

page_token

string

Page token, returned by a previous call, used to request the next page of results, if any.

filter

string

The standard list filter.

ListAnalysisQueriesResponse

Response to a ListDataQueries request. Contains the queries owned by the specified customer.

Fields
queries[]

AnalysisQuery

A list of queries.

next_page_token

string

A token that can be used to request the next results page. This field is empty if there are no additional results.

ListCustomerLinksRequest

Request to retrieve a list of linked Ads Data Hub customers.

Fields
parent

string

Parent customer resource name, e.g. 'customers/123'.

page_size

int32

Maximum number of items to return. If 0, the server will determine the number of linked customers to return.

page_token

string

Page token, returned by a previous call, used to request the next page of results, if any.

filter

string

The standard list filter.

ListCustomerLinksResponse

Response to a ListCustomerLinks request. Contains the Ads Data Hub customers linked to the specified customer.

Fields
next_page_token

string

A token that can be used to request the next results page. This field is empty if there are no additional results.

ListCustomersRequest

Request to retrieve a list of Ads Data Hub customers.

Fields
page_size

int32

Maximum number of items to return. If 0, the server will determine the number of customers to return.

page_token

string

Page token, returned by previous call, to request the next page of results, if any.

ListCustomersResponse

Response to a ListCustomers request. Contains the Ads Data Hub customers accessible by the current user.

Fields
customers[]

Customer

A list of customers.

next_page_token

string

A token that can be used to request the next results page. This field is empty if there are no additional results.

ListTablesRequest

Request to retrieve a list of Ads Data Hub tables accessible by the customer.

Fields
parent

string

Parent customer resource name, e.g. 'customers/123'.

ads_data_customer_id

int64

Optional. Linked Ads Data Hub customer ID that owns the ads data used by the tables. Defaults to the parent resource.

match_data_customer_id

int64

Optional. Linked Ads Data Hub customer ID that owns the match data for the query. Defaults to the parent resource.

page_size

int32

Maximum number of items to return. If 0, the server will determine the number of tables to return.

page_token

string

Page token, returned by a previous call, used to request the next page of results, if any. The page token must have been returned by a call with the same request parameters.

ListTablesResponse

Response to a ListTables request. Contains the Ads Data Hub tables accessible by the customer.

Fields
tables[]

Table

A list of tables.

next_page_token

string

A token that can be used to request the next results page. This field is empty if there are no additional results.

ListTempTablesRequest

Request to retrieve a list of Ads Data Hub temp tables created by the customer.

Fields
parent

string

Parent customer resource name, e.g. 'customers/123'.

ads_data_customer_id

int64

Optional. Linked Ads Data Hub customer ID used when executing the original temp table queries. Defaults to the parent resource.

match_data_customer_id

int64

Optional. Linked Ads Data Hub customer ID used when executing the original temp table queries. Defaults to the parent resource.

query_type

QueryType

Type of query that created the tables. Temp tables are only accessible to to queries of the same type.

page_size

int32

Maximum number of items to return. If 0, the server will determine the number of tables to return.

page_token

string

Page token, returned by a previous call, used to request the next page of results, if any. The page token must have been returned by a call with the same request parameters.

ListTempTablesResponse

Response to a ListTempTables request.

Fields
tables[]

TempTable

A list of tables.

next_page_token

string

A token that can be used to request the next results page. This field is empty if there are no additional results.

ListUserListQueriesRequest

Request to retrieve a list of available user list queries.

Fields
parent

string

Parent customer resource name, e.g. 'customers/123'.

page_size

int32

Maximum number of items to return. If 0, The server will determine the number of queries to return.

page_token

string

Page token, returned by a previous call, used to request the next page of results.

filter

string

The standard list filter.

ListUserListQueriesResponse

Response to a ListDataQueries request. Contains the queries owned by the specified customer, sorted by title.

Fields
queries[]

UserListQuery

A list of queries.

next_page_token

string

A token that can be used to request the next results page. This field is empty if there are no additional results.

ListUserListsRequest

Request to retrieve a list of Google Ads user lists managed by the specified Ads Data Hub customer.

Fields
parent

string

Parent customer resource name, e.g. 'customers/123'.

page_size

int32

Maximum number of items to return. If 0, the server will determine the number of user lists to return.

page_token

string

Page token, returned by a previous call, used to request the next page of results.

ListUserListsResponse

Response to a ListUserLists request. Contains the Google Ads user lists managed by the specified Ads Data Hub customer.

Fields
user_lists[]

UserList

A list of user lists.

next_page_token

string

A token that can be used to request the next results page. This field is empty if there are no additional results.

MergeColumn

Merge instructions for a single output column.

Fields
type

MergeType

Method used to combine the values for the column.

value

ParameterValue

The constant value to use (only valid for CONSTANT merge type).

MergeType

All supported operations for column merging.

Enums
MERGE_TYPE_UNSPECIFIED Unspecified merge type. The merged column value will be NULL.
CONSTANT Replace merged column value with the given constant.
SUM Take the sum of the merged column values.

MergeSpec

Merge instructions for an analysis query result schema.

Fields
columns

map<string, MergeColumn>

Instructions for merging each column, keyed by name. Any missing columns will be treated as MERGE_TYPE_UNSPECIFIED.

ParameterType

Information about a specific query parameter.

Fields
type

FieldType

Parameter field type.

description

string

Optional. Parameter description.

default_value

ParameterValue

Optional. Value that should be used if no parameter value is provided.

ParameterValue

Represents a BigQuery parameter value.

Fields
Union field parameter_value. Parameter value. parameter_value can be only one of the following:
value

string

Value for a non-array, non-struct parameter.

array_value

ArrayValue

Value for an array parameter.

struct_value

StructValue

Value for a struct parameter.

QueryExecutionSpec

Defines the query execution parameters.

Fields
ads_data_customer_id

int64

Optional. Linked Ads Data Hub customer ID that owns the ads data used in the query. If absent, then the query will be run using the ads data owned by the Ads Data Hub customer running the query.

match_data_customer_id

int64

Optional. Linked Ads Data Hub customer ID that owns the match data for the query. If absent, then the query will be run using the match data owned by the Ads Data Hub customer ID running the query, if applicable.

start_date

Date

The start date (inclusive) for the query.

end_date

Date

The end date (inclusive) for the query.

time_zone

string

Optional. The time zone for the query start and end dates. If not specified, defaults to 'UTC'.

parameter_values

map<string, ParameterValue>

Any additional parameters expected by the query. Maps each parameter name to its bound value.

job_id

string

Optional. Job ID for the query operation. The resulting operation will have the name "operations/[job_id]", e.g. "operations/job_123". If an operation with the same job ID already exists, this will result in an error. If absent, a job ID will be generated by the server.

QueryMetadata

Metadata about a query execution job. This is stored in the metadata field of the google.longrunning.Operation returned by a query execution request.

Fields
query_resource_name

string

Name of the query resource that was executed, e.g. customers/123/analysisQueries/abcd1234 Only present for stored query execution.

query_title

string

Title of the query executed.

customer_id

int64

The Ads Data Hub customer ID that executed the query.

ads_data_customer_id

int64

Ads Data Hub customer ID used for ads data.

match_data_customer_id

int64

Ads Data Hub customer ID used for match table data.

parameter_values

map<string, ParameterValue>

Parameter values used in the query. Maps each argument name to its bound value.

start_time

Timestamp

Query execution start time.

end_time

Timestamp

Query execution end time.

Union field output. Location where query results get stored. output can be only one of the following:
dest_table

string

Destination table for query results. Used for analysis queries.

user_list_id

int64

User list to populate with query results. Used for user list queries.

QueryResponse

Response returned for successful query execution jobs. This is stored in the response field of the google.longrunning.Operation returned by a query execution request.

QueryShare

Indicates ways that a query may be shared beyond the owning Ads Data Hub customer.

Fields
share_type

ShareType

Indicates how the query may be shared with other Ads Data Hub customers.

ShareType

Supported query sharing types.

Enums
SHARE_TYPE_UNSPECIFIED Query sharing type is unspecified.
MANAGED_CUSTOMERS Query can be run from an Ads Data Hub customer that owns the query, or any Ads Data Hub customer managed by that customer.

QueryState

State that determines an analysis query's run mode.

Enums
QUERY_STATE_UNSPECIFIED Query state is unspecified.
RUNNABLE Query is available to be run by the customer.
WHITELISTED Query has been manually reviewed and approved to run without certain runtime privacy checks.

QueryType

Query type.

Enums
QUERY_TYPE_UNSPECIFIED No query type specified.
ANALYSIS The table can be accessed through an AnalysisQuery.
USER_LIST The table can be accessed through a UserListQuery.

StartAnalysisQueryRequest

Request to start execution on a stored analysis query.

Fields
name

string

Full resource name, e.g. 'customers/123/analysisQueries/abcd1234'.

spec

QueryExecutionSpec

Defines the query execution parameters.

dest_table

string

Destination BigQuery table for query results with the format 'project.dataset.table_name'. If project is not specified, uses default project for the provided customer. If neither project nor dataset is specified, uses the default project and dataset.

customer_id

int64

Optional. Ads Data Hub customer executing the query. If not specified, defaults to the customer that owns the query.

StartTransientAnalysisQueryRequest

Request to start execution of a transient analysis query.

Fields
parent

string

Full resource name of the customer executing the query, e.g. 'customers/123'.

query

AnalysisQuery

The query to execute.

spec

QueryExecutionSpec

Defines the query execution parameters.

dest_table

string

Destination BigQuery table for query results with the format 'project.dataset.table_name'. If project is not specified, uses default project for the provided customer. If neither project nor dataset is specified, uses the default project and dataset.

StartTransientUserListQueryRequest

Request to start execution of a transient user list query.

Fields
parent

string

Full resource name of the customer executing the query, e.g. 'customers/123'.

query

UserListQuery

The query to execute.

spec

QueryExecutionSpec

Defines the query execution parameters.

user_list_id

int64

Google Ads user list ID. Note that the user list must be managed by the Ads Data Hub customer executing the query.

StartUserListQueryRequest

Request to start execution on a stored user list query.

Fields
name

string

Full resource name, e.g. 'customers/123/userListQueries/abcd1234'.

spec

QueryExecutionSpec

Defines the query execution parameters.

user_list_id

int64

Google Ads user list ID. Note that the user list must be managed by the Ads Data Hub customer executing the query.

customer_id

int64

Optional. Ads Data Hub customer executing the query. If not specified, defaults to the customer that owns the query.

StructField

A key-value pair that defines a single struct field.

Fields
field_name

string

Field name.

field_type

FieldType

Field type.

StructType

Defines a struct type.

Fields
fields[]

StructField

An ordered list of fields for a given struct.

StructValue

Defines a struct parameter value.

Fields
values

map<string, ParameterValue>

The struct field values keyed by field name.

Table

Defines a table that can be queried.

Fields
name

string

Name that uniquely identifies a table. It has the form customers/[customer_id]/tables/[table_path], e.g. 'customers/123/tables/adh.google_ads_impressions'.

table_path

string

Fully qualified table path, e.g. 'adh.google_ads_impressions'.

columns[]

Column

A list of table columns.

TempTable

Defines a temp table created by an Ads Data Hub query. Temp tables are created using CREATE TABLE temp_table AS (...) in an Ads Data Hub query. Temp tables remain active for 72 hours before needing to be refreshed.

Fields
name

string

Name that uniquely identifies a table. It has the form customers/[customer_id]/tempTables/[resource_id]. The resource ID is generated by the server.

table_path

string

Fully qualified table path, e.g. 'tmp.table'

ads_data_customer_id

int64

Linked Ads Data Hub customer ID used when executing the original temp table query.

match_data_customer_id

int64

Linked Ads Data Hub customer ID used when executing the original temp table query.

query_type

QueryType

Type of query that created the table. Temp tables are only accessible to to queries of the same type.

columns[]

Column

A list of table columns.

UpdateAnalysisQueryRequest

Request to update an analysis query.

Fields
query

AnalysisQuery

The query to update.

update_mask

FieldMask

Field mask used to support partial updates.

UpdateUserListQueryRequest

Request to update a user list query.

Fields
query

UserListQuery

The query to update.

update_mask

FieldMask

Field mask used to support partial updates.

UserList

Defines an Ads Data Hub-managed Google Ads user list.

Fields
name

string

Name that uniquely identifies an Ads Data Hub user list. It has the form customers/[customer_id]/userLists/[user_list_id]

user_list_id

int64

Google Ads user list ID. This field is generated by the service.

ads_data_customer_id

int64

Linked Ads Data Hub customer ID associated with this user list. This ID must be specified as the ads_data_customer_id when running UserListQuery jobs using this user list.

title

string

User list title, which is unique for the specified ads_data_customer_id.

description

string

User list description.

UserListQuery

Defines a user list query that can be executed within Ads Data Hub.

Fields
name

string

Name that uniquely identifies a query. It has the form customers/[customer_id]/userListQueries/[resource_id], e.g. 'customers/123/userListQueries/abcd1234'. The resource ID is generated by the server.

title

string

Query title, which is unique within a single Ads Data Hub customer and query type.

query_text

string

Query text.

parameter_types

map<string, ParameterType>

Any additional parameters expected by the query. Maps each argument name to its argument type.

update_time

Timestamp

Time the query was last updated.

update_email

string

Email address of user who last updated the query.

create_time

Timestamp

Time the query was created.

create_email

string

Email address of user who created the query.

query_share[]

QueryShare

Indicates ways that a query may be shared beyond the owning Ads Data Hub customer.

ValidateAnalysisQueryRequest

Request to validate an analysis query.

Fields
parent

string

The parent resource name that owns the query, e.g. 'customers/123'.

query

AnalysisQuery

The query to validate.

ads_data_customer_id

int64

Optional. Linked Ads Data Hub customer ID to use for validating ads data and temp table access. Defaults to the parent resource.

match_data_customer_id

int64

Optional. Linked Ads Data Hub customer ID to use for validating match data and temp table access. Defaults to the parent resource.

ValidateAnalysisQueryResponse

Response to a ValidateAnalysisQuery request.

ValidateUserListQueryRequest

Request to validate a user list query.

Fields
parent

string

The parent resource name that owns the query, e.g. 'customers/123'.

query

UserListQuery

The query to validate.

ads_data_customer_id

int64

Optional. Linked Ads Data Hub customer ID to use for validating ads data and temp table access. Defaults to the parent resource.

match_data_customer_id

int64

Optional. Linked Ads Data Hub customer ID to use for validating match data and temp table access. Defaults to the parent resource.

ValidateUserListQueryResponse

Response to a ValidateUserListQuery request.