REST Resource: customers

  • Ads Data Hub Customer resource provides access to customer-level information and operations.

  • Customers are uniquely identified by a name in the format customers/[customerId].

  • A variety of methods are available for managing and interacting with customer data, including retrieving customer details, exporting job history, generating reports, and submitting data.

  • Several methods focus on importing specific data types such as Brand Lift, Brand Safety Scores, and vendor reports.

  • Customer methods also provide functionalities like describing valid DV360 advertiser IDs and checking import completion status.

Resource: Customer

An Ads Data Hub customer.

JSON representation
{
  "name": string,
  "customerId": string,
  "displayName": string
}
Fields
name

string

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

customerId

string (int64 format)

Ads Data Hub customer ID.

displayName

string

Descriptive customer name.

Methods

describeValidDv360AdvertiserIds

Describes the valid DV360 AdvertiserIds

describeValidFrequencyLimitingEventMatchers
(deprecated)

Lists valid event matchers along with their metadata for frequency capping audience lists.

exportJobHistory

Exports job history of a customer account to customer-selected BigQuery dataset.

generateDv360IvtVideoViewabilityReport

Starts the execution of a query to retrieve invalid traffic viewability metrics for the DV360 platform.

generateIvtReport

Starts the execution of a query to retrieve a day-by-day summary of invalid traffic counts for a specific platform.

get

Retrieves the requested Ads Data Hub customer.

getImportCompletionStatus

Returns the percentage of Google data across all customers that has successfully been ingested into ADH on the given date.

list

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

submitBrandLiftBenchmark

Starts ADH import of a specified BigQuery table populated with the quarterly brand lift benchmark report generated by the customer.

submitBrandLiftStudyReport

Starts ADH import of a specified BigQuery table populated with the brand lift study report generated by the customer.

submitBrandSafetyScores

Starts ADH import of a specified BigQuery table populated with the vendor's Brand Safety score file.

submitVendorAggregatesReport

Starts ADH import of a specified BigQuery table populated with the vendor's summary report for a given metric.

submitVendorReportIdMapping

Starts ADH import of a specified BigQuery table populated with the mapping between customer defined report ID and Google campaign ID.