Page Summary
-
SubmitBrandLiftReportMetadata is used to define the request for submitting customer brand lift reports, either a benchmark or a study report.
-
A benchmark report submission requires the customer ID, year, quarter, and the source BigQuery table.
-
A study report submission requires the customer ID, date, and the source BigQuery table.
-
Both benchmark and study report submissions can optionally include an instance name for testing purposes.
Metadata for customer brand lift report submission request associated with each operation.
| JSON representation |
|---|
{ "startTime" : string , "endTime" : string , // Union field |
startTime
string (
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"
.
endTime
string (
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"
.
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:benchmark
object (
SubmitBrandLiftBenchmarkRequest
)
Request for brand lift quarter benchmark report submission.
studyReport
object (
SubmitBrandLiftStudyReportRequest
)
Request for brand lift study report submission.
SubmitBrandLiftBenchmarkRequest
Request to submit a customer generated brand lift quarter benchmark report.
| JSON representation |
|---|
{ "customer" : string , "year" : integer , "quarter" : integer , "sourceTable" : string , "instance" : string } |
| Fields | |
|---|---|
customer
|
Required. Ads Data Hub customer making the request. This is in the form of 'customers/[customerId]'. e.g. 'customers/123'. |
year
|
Required. Year that the benchmark report is for. In the format of YYYY(e.g., 2023). |
quarter
|
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
|
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
|
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.
| JSON representation |
|---|
{
"customer"
:
string
,
"date"
:
{
object (
|
| Fields | |
|---|---|
customer
|
Required. Ads Data Hub customer making the request. This is in the form of 'customers/[customerId]'. e.g. 'customers/123'. |
date
|
Required. Date that the study report is for. |
sourceTable
|
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
|
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. |
