Starts ADH import of a specified BigQuery table populated with the quarterly brand lift benchmark report generated by the customer. This is called by the customer to trigger ADH to import the report.
HTTP request
POST https://adsdatahub.googleapis.com/v1/{customer=customers/*}:submitBrandLiftBenchmark
Required. Year that the benchmark report is for. In the format of YYYY(e.g., 2023).
quarter
integer
Required. Quarter that the benchmark report is for. Allowed values are 1, 2, 3, 4. e.g., when submitting report for 2023 Q1, the value should be 1.
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. Please refer to Brand Lift Benchmark Schema on ADH Dev Site for detailed schema requirements about the table.
instance
string
Optional. The name of the submission feed instance. This shouldn't be populated for the production brand lift 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.
Response body
If successful, the response body contains an instance of Operation.
[[["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\u003eStarts ADH import of a specified BigQuery table containing a quarterly brand lift benchmark report, triggered by the customer.\u003c/p\u003e\n"],["\u003cp\u003eRequires specifying the year, quarter, and source BigQuery table in the request body.\u003c/p\u003e\n"],["\u003cp\u003eUses a POST request to \u003ccode\u003ehttps://adsdatahub.googleapis.com/v1/{customer=customers/*}:submitBrandLiftBenchmark\u003c/code\u003e with the customer ID in the path.\u003c/p\u003e\n"],["\u003cp\u003eRequires the \u003ccode\u003ehttps://www.googleapis.com/auth/adsdatahub\u003c/code\u003e OAuth scope for authorization.\u003c/p\u003e\n"],["\u003cp\u003eReturns an Operation object in the response body upon successful submission.\u003c/p\u003e\n"]]],["The core action is initiating an ADH import of a customer's quarterly brand lift benchmark report from a specified BigQuery table. This is done by sending a `POST` request to `https://adsdatahub.googleapis.com/v1/{customer=customers/*}:submitBrandLiftBenchmark`. The request requires a customer ID in the URL and a JSON body with the `year`, `quarter`, and `sourceTable` of the report, and optionally an `instance`. A successful request returns an `Operation` instance. The operation requires the OAuth scope `https://www.googleapis.com/auth/adsdatahub`.\n"],null,["# Method: customers.submitBrandLiftBenchmark\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 quarterly brand lift benchmark report generated by the customer. This is called by the customer to trigger ADH to import the report.\n\n### HTTP request\n\n`POST https://adsdatahub.googleapis.com/v1/{customer=customers/*}:submitBrandLiftBenchmark`\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| ``` { \"year\": integer, \"quarter\": integer, \"sourceTable\": string, \"instance\": string } ``` |\n\n| Fields ||\n|---------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `year` | `integer` Required. Year that the benchmark report is for. In the format of YYYY(e.g., 2023). |\n| `quarter` | `integer` Required. Quarter that the benchmark report is for. Allowed values are 1, 2, 3, 4. e.g., when submitting report for 2023 Q1, the value should be 1. |\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. Please refer to Brand Lift Benchmark Schema on ADH Dev Site for detailed schema requirements about the table. |\n| `instance` | `string` Optional. The name of the submission feed instance. This shouldn't be populated for the production brand lift 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\n### Response body\n\nIf successful, the response body contains an instance of [Operation](/ads-data-hub/marketers/reference/rest/v1/operations#Operation).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/adsdatahub`"]]
