Method: customers.submitVendorReportIdMapping

  • The content describes how to start an Ads Data Hub import of a BigQuery table containing customer-defined report ID to Google campaign ID mappings.

  • This process is triggered by the customer to initiate the import of the mapping data into Ads Data Hub.

  • The request uses an HTTP POST method to a specific Ads Data Hub API endpoint with a customer identifier in the path parameters.

  • The request body requires the date of the report, the source BigQuery table details, and optionally allows specifying an instance name and metric.

  • A successful request returns an Operation instance, and authorization requires the https://www.googleapis.com/auth/adsdatahub OAuth scope.

Starts ADH import of a specified BigQuery table populated with the mapping between customer defined report ID and Google campaign ID. This is called by the customer to trigger ADH to import the mapping.

HTTP request

POST https://adsdatahub.googleapis.com/v1/{customer=customers/*}:submitVendorReportIdMapping

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
customer

string

Required. Ads Data Hub customer making the request. This is in the form of 'customers/[customerId]'. e.g. 'customers/123'.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "date": {
    object (Date)
  },
  "sourceTable": string,
  "instance": string,
  "metric": enum (Metric)
}
Fields
date

object (Date)

Required. Date that the daily report ID mapping is for.
sourceTable

string

Required. Source BigQuery table for query results in the format 'project.dataset.table_name'. The project, dataset, and table_name must all be provided explicitly. Table must have the following columns: date report_date, string vendorClientId, string vendor_reporting_id, string entity_type, int entityId. For more details, see Report ID Mapping Schema on ADH Dev Site: https://developers.google.com/ads-data-hub/confidential/brandmeasurement/reach/report_id_mapping_schema
instance

string

Optional. The name of the submission feed instance. This shouldn't be populated for the production ID mapping feed, but can be filled out with a prearranged instance name when a vendor works with Google to test a new or alternate version of their submission feed.
metric

enum (Metric)

Optional. Metric which the table is reporting. Defaults to REACH if not populated.

Response body

If successful, the response body contains an instance of Operation.

Authorization scopes

Requires the following OAuth scope:

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