REST Resource: exchanges.reports
Stay organized with collections
Save and categorize content based on your preferences.
Resource: Report
Report containing multiple report rows.
| JSON representation |
{
"row": [
{
object (ReportRow)
}
],
"name": string,
"reportId": string,
"googleCloudStoragePath": string
} |
| Fields |
row[]
(deprecated) |
object (ReportRow)
Report rows.
|
name |
string
Output only. The resource name of the report.
|
reportId |
string
Output only. Report Id.
|
googleCloudStoragePath |
string
The Bigstore file address of the report when ready. Replace the "bigstore" string with "https://storage.mtls.cloud.google.com", then download the report from Google Cloud Storage (GCS). In the path string, "exchangeapi-xxxxxx" is the GCS bucket name specific to your service account.
|
ReportRow
One row of the reporting data in the Report.
| JSON representation |
{
"reportDate": string,
"reportHour": string,
"publisher": string,
"impressions": string,
"impressionCost": number,
"creativeId": string,
"creativeType": string,
"regionCode": string,
"seatId": string,
"dealId": string,
"deviceType": string,
"weekFirstDate": string,
"ivtImpressions": string,
"ivtImpressionCost": number
} |
| Fields |
reportDate |
string
Date of the report, in ISO_8601 format.
|
reportHour |
string
Hour of the report. Used in hourly report, represent the hour of the day. Value from 0~23, 0 will be represent for [0:00:00 ~ 1:00:00) UTC.
|
publisher |
string
Publisher of the report, i.e. "10005_1350300"
|
impressions |
string (int64 format)
Impression value in specified date/hour/week.
|
impressionCost |
number
Impression cost in specified date/hour/week.
|
creativeId |
string (int64 format)
Creative ID.
|
creativeType |
string
Creative type of the report row, i.e. image/audio.
|
regionCode |
string
Country/Region code.
|
seatId |
string (int64 format)
Seat ID of the buyer.
|
dealId |
string (int64 format)
Deal ID.
|
deviceType |
string
Device type, i.e. mobile/desktop.
|
weekFirstDate |
string
Date of the first day of the week represent the week in report row.
|
ivtImpressions |
string (int64 format)
IVT(Invalid traffic) impression in specified date/hour/week.
|
ivtImpressionCost |
number
IVT(Invalid traffic) impression cost in specified date/hour/week.
|
Methods |
|
|
Get the report from Report Name. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-09-18 UTC.
[[["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 documentation describes the structure and fields of exchange reporting, including the \u003ccode\u003eReport\u003c/code\u003e and \u003ccode\u003eReportRow\u003c/code\u003e resources.\u003c/p\u003e\n"],["\u003cp\u003eA \u003ccode\u003eReport\u003c/code\u003e contains multiple \u003ccode\u003eReportRow\u003c/code\u003e objects and provides information like report name, ID, and Google Cloud Storage path.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eReportRow\u003c/code\u003e (deprecated) includes data points such as impressions, cost, creative details, region, and device type for a specific date and time.\u003c/p\u003e\n"],["\u003cp\u003eYou can retrieve a report using the \u003ccode\u003eget\u003c/code\u003e method with the report name.\u003c/p\u003e\n"]]],[],null,["# REST Resource: exchanges.reports\n\n- [Resource: Report](#Report)\n - [JSON representation](#Report.SCHEMA_REPRESENTATION)\n- [ReportRow](#ReportRow)\n - [JSON representation](#ReportRow.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: Report\n----------------\n\nReport containing multiple report rows.\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"row\": [ { object (/display-video/exchange-reporting/reference/rest/v1alpha1/exchanges.reports#ReportRow) } ], \"name\": string, \"reportId\": string, \"googleCloudStoragePath\": string } ``` |\n\n| Fields ||\n|--------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `row[]` **(deprecated)** | `object (`[ReportRow](/display-video/exchange-reporting/reference/rest/v1alpha1/exchanges.reports#ReportRow)`)` | This item is deprecated! Report rows. |\n| `name` | `string` Output only. The resource name of the report. |\n| `reportId` | `string` Output only. Report Id. |\n| `googleCloudStoragePath` | `string` The Bigstore file address of the report when ready. Replace the \"bigstore\" string with \"https://storage.mtls.cloud.google.com\", then download the report from Google Cloud Storage (GCS). In the path string, \"exchangeapi-xxxxxx\" is the GCS bucket name specific to your service account. |\n\nReportRow\n---------\n\n| This item is deprecated!\nOne row of the reporting data in the Report.\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"reportDate\": string, \"reportHour\": string, \"publisher\": string, \"impressions\": string, \"impressionCost\": number, \"creativeId\": string, \"creativeType\": string, \"regionCode\": string, \"seatId\": string, \"dealId\": string, \"deviceType\": string, \"weekFirstDate\": string, \"ivtImpressions\": string, \"ivtImpressionCost\": number } ``` |\n\n| Fields ||\n|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `reportDate` | `string` Date of the report, in ISO_8601 format. |\n| `reportHour` | `string` Hour of the report. Used in hourly report, represent the hour of the day. Value from 0\\~23, 0 will be represent for \\[0:00:00 \\~ 1:00:00) UTC. |\n| `publisher` | `string` Publisher of the report, i.e. \"10005_1350300\" |\n| `impressions` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Impression value in specified date/hour/week. |\n| `impressionCost` | `number` Impression cost in specified date/hour/week. |\n| `creativeId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Creative ID. |\n| `creativeType` | `string` Creative type of the report row, i.e. image/audio. |\n| `regionCode` | `string` Country/Region code. |\n| `seatId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Seat ID of the buyer. |\n| `dealId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Deal ID. |\n| `deviceType` | `string` Device type, i.e. mobile/desktop. |\n| `weekFirstDate` | `string` Date of the first day of the week represent the week in report row. |\n| `ivtImpressions` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` IVT(Invalid traffic) impression in specified date/hour/week. |\n| `ivtImpressionCost` | `number` IVT(Invalid traffic) impression cost in specified date/hour/week. |\n\n| Methods ------- ||\n|--------------------------------------------------------------------------------------------|----------------------------------|\n| ### [get](/display-video/exchange-reporting/reference/rest/v1alpha1/exchanges.reports/get) | Get the report from Report Name. |"]]
