Metadata for customer brand lift report submission request associated with each operation.
JSON representation
{"startTime": string,"endTime": string,// Union field request can be only one of the following:"benchmark": {object (SubmitBrandLiftBenchmarkRequest)},"studyReport": {object (SubmitBrandLiftStudyReportRequest)}// End of list of possible types for union field request.}
A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
Union field request. Request of submitting a brand lift report. This will be either a benchmark or a study report. request can be only one of the following:
Required. Ads Data Hub customer making the request. This is in the form of 'customers/[customerId]'. e.g. 'customers/123'.
year
integer
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.
SubmitBrandLiftStudyReportRequest
Request to submit a customer generated brand lift study report.
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.
[[["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\u003eThis page documents the metadata and request formats for submitting customer brand lift reports to Ads Data Hub.\u003c/p\u003e\n"],["\u003cp\u003eThe reports can be either benchmark reports, submitted quarterly, or study reports, submitted for specific dates.\u003c/p\u003e\n"],["\u003cp\u003eAll requests require specifying the customer, data source table, and relevant time period (quarter or date).\u003c/p\u003e\n"],["\u003cp\u003eAn optional "instance" field can be used for testing purposes when working with Google on alternate submission feeds.\u003c/p\u003e\n"]]],["This document outlines requests for submitting customer-generated brand lift reports, either as a benchmark or study report. These submissions include a `startTime` and `endTime`. Benchmark submissions require the `customer`, `year`, `quarter`, `sourceTable`, and optionally, `instance`. Study report submissions need the `customer`, `date`, `sourceTable`, and optionally, `instance`. Both report types must specify a `sourceTable` in BigQuery and the `customer`'s Ads Data Hub ID.\n"],null,["# SubmitBrandLiftReportMetadata\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n- [SubmitBrandLiftBenchmarkRequest](#SubmitBrandLiftBenchmarkRequest)\n - [JSON representation](#SubmitBrandLiftBenchmarkRequest.SCHEMA_REPRESENTATION)\n- [SubmitBrandLiftStudyReportRequest](#SubmitBrandLiftStudyReportRequest)\n - [JSON representation](#SubmitBrandLiftStudyReportRequest.SCHEMA_REPRESENTATION)\n\nMetadata for customer brand lift report submission request associated with each operation.\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"startTime\": string, \"endTime\": string, // Union field `request` can be only one of the following: \"benchmark\": { object (/ads-data-hub/marketers/reference/rest/v1/SubmitBrandLiftReportMetadata#SubmitBrandLiftBenchmarkRequest) }, \"studyReport\": { object (/ads-data-hub/marketers/reference/rest/v1/SubmitBrandLiftReportMetadata#SubmitBrandLiftStudyReportRequest) } // End of list of possible types for union field `request`. } ``` |\n\n| Fields ||\n|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `startTime` | `string (`[Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Timestamp)` format)` Import start time. A timestamp in RFC3339 UTC \"Zulu\" format, with nanosecond resolution and up to nine fractional digits. Examples: `\"2014-10-02T15:01:23Z\"` and `\"2014-10-02T15:01:23.045123456Z\"`. |\n| `endTime` | `string (`[Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Timestamp)` format)` Import end time. A timestamp in RFC3339 UTC \"Zulu\" format, with nanosecond resolution and up to nine fractional digits. Examples: `\"2014-10-02T15:01:23Z\"` and `\"2014-10-02T15:01:23.045123456Z\"`. |\n| Union field `request`. Request of submitting a brand lift report. This will be either a benchmark or a study report. `request` can be only one of the following: ||\n| `benchmark` | `object (`[SubmitBrandLiftBenchmarkRequest](/ads-data-hub/marketers/reference/rest/v1/SubmitBrandLiftReportMetadata#SubmitBrandLiftBenchmarkRequest)`)` Request for brand lift quarter benchmark report submission. |\n| `studyReport` | `object (`[SubmitBrandLiftStudyReportRequest](/ads-data-hub/marketers/reference/rest/v1/SubmitBrandLiftReportMetadata#SubmitBrandLiftStudyReportRequest)`)` Request for brand lift study report submission. |\n\nSubmitBrandLiftBenchmarkRequest\n-------------------------------\n\nRequest to submit a customer generated brand lift quarter benchmark report.\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------|\n| ``` { \"customer\": string, \"year\": integer, \"quarter\": integer, \"sourceTable\": string, \"instance\": string } ``` |\n\n| Fields ||\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| `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\nSubmitBrandLiftStudyReportRequest\n---------------------------------\n\nRequest to submit a customer generated brand lift study report.\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"customer\": string, \"date\": { object (/ads-data-hub/marketers/reference/rest/v1/Date) }, \"sourceTable\": string, \"instance\": string } ``` |\n\n| Fields ||\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| `date` | `object (`[Date](/ads-data-hub/marketers/reference/rest/v1/Date)`)` Required. Date that the study report 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. 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. |"]]
