This is legacy documentation, and may not be complete. To see the latest documentation, if you are a marketer, refer to the Marketers site. If you are a measurement partner, refer to the Measurement Partners site.
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
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-09-18 UTC."],[[["\u003cp\u003eInitiates the import of customer-defined report ID to Google campaign ID mapping from a specified BigQuery table into Ads Data Hub.\u003c/p\u003e\n"],["\u003cp\u003eRequires a POST request to the specified endpoint with details about the source BigQuery table and desired import date.\u003c/p\u003e\n"],["\u003cp\u003eThe request body must adhere to a defined JSON structure including fields for date, source table, instance (optional), and metric (optional).\u003c/p\u003e\n"],["\u003cp\u003eA successful request returns an Operation object indicating the status of the import process.\u003c/p\u003e\n"],["\u003cp\u003eUtilizes the \u003ccode\u003ehttps://www.googleapis.com/auth/adsdatahub\u003c/code\u003e OAuth scope for authorization.\u003c/p\u003e\n"]]],["The core function is to initiate an ADH import of a BigQuery table containing customer-defined report ID to Google campaign ID mappings. This is achieved via a `POST` request to `https://adsdatahub.googleapis.com/v1/{customer=customers/*}:submitVendorReportIdMapping`. The request requires a `customer` ID and a JSON body specifying the `date`, `sourceTable`, `instance`(optional), and `metric` (optional). The table should contain specific columns for the mapping. Successful requests return an `Operation` instance. Authorization requires the `https://www.googleapis.com/auth/adsdatahub` scope.\n"],null,["# Method: customers.submitVendorReportIdMapping\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n\nStarts 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.\n\n### HTTP request\n\n`POST https://adsdatahub.googleapis.com/v1/{customer=customers/*}:submitVendorReportIdMapping`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|------------|---------------------------------------------------------------------------------------------------------------------------------------|\n| `customer` | `string` Required. Ads Data Hub customer making the request. This is in the form of 'customers/\\[customerId\\]'. e.g. 'customers/123'. |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"date\": { object (/ads-data-hub/reference/rest/v1/Date) }, \"sourceTable\": string, \"instance\": string, \"metric\": enum (/ads-data-hub/reference/rest/v1/customers.adsDataLinks#Metric) } ``` |\n\n| Fields ||\n|---------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `date` | `object (`[Date](/ads-data-hub/reference/rest/v1/Date)`)` Required. Date that the daily report ID mapping is for. |\n| `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: \u003chttps://developers.google.com/ads-data-hub/confidential/brandmeasurement/reach/report_id_mapping_schema\u003e |\n| `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. |\n| `metric` | `enum (`[Metric](/ads-data-hub/reference/rest/v1/customers.adsDataLinks#Metric)`)` Optional. Metric which the table is reporting. Defaults to [REACH](/ads-data-hub/reference/rest/v1/customers.adsDataLinks#Metric.ENUM_VALUES.REACH) if not populated. |\n\n### Response body\n\nIf successful, the response body contains an instance of [Operation](/ads-data-hub/reference/rest/v1/operations#Operation).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/adsdatahub`"]]