Retrieves the authenticated user's list of performance metrics. Try it now.
Request
HTTP request
GET https://www.googleapis.com/adexchangebuyer/v1.4/performancereport
Parameters
Parameter name | Value | Description |
---|---|---|
Required query parameters | ||
accountId |
long |
The account id to get the reports. |
endDateTime |
string |
The end time of the report in ISO 8601 timestamp format using UTC. |
startDateTime |
string |
The start time of the report in ISO 8601 timestamp format using UTC. |
Optional query parameters | ||
maxResults |
unsigned integer |
Maximum number of entries returned on one result page. If not set, the default is 100. Optional.
Acceptable values are 1 to 1000 , inclusive.
|
pageToken |
string |
A continuation token, used to page through performance reports. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. Optional. |
Authorization
This request requires authorization with the following scope:
Scope |
---|
https://www.googleapis.com/auth/adexchange.buyer |
For more information, see the authentication and authorization page.
Request body
Do not supply a request body with this method.
Response
If successful, this method returns a response body with the following structure:
{ "kind": "adexchangebuyer#performanceReportList", "performanceReport": [ { "kind": "adexchangebuyer#performanceReport", "timestamp": long, "region": string, "latency50thPercentile": double, "latency85thPercentile": double, "latency95thPercentile": double, "quotaConfiguredLimit": double, "quotaThrottledLimit": double, "calloutStatusRate": [ (value) ], "creativeStatusRate": [ (value) ], "outOfQuota": double, "noQuotaInRegion": double, "cookieMatcherStatusRate": [ (value) ], "hostedMatchStatusRate": [ (value) ], "pixelMatchRequests": double, "pixelMatchResponses": double, "inventoryMatchRate": double, "bidRequestRate": double, "successfulRequestRate": double, "unsuccessfulRequestRate": double, "bidRate": double, "filteredBidRate": double } ] }
Property name | Value | Description | Notes |
---|---|---|---|
kind |
string |
Resource type. | |
performanceReport[] |
list |
A list of performance reports relevant for the account. | |
performanceReport[].kind |
string |
Resource type. | |
performanceReport[].timestamp |
long |
The unix timestamp of the starting time of this performance data. | |
performanceReport[].region |
string |
The trading location of this data.
Acceptable values are:
|
|
performanceReport[].latency50thPercentile |
double |
The 50th percentile round trip latency(ms) as perceived from Google servers for the duration period covered by the report. | |
performanceReport[].latency85thPercentile |
double |
The 85th percentile round trip latency(ms) as perceived from Google servers for the duration period covered by the report. | |
performanceReport[].latency95thPercentile |
double |
The 95th percentile round trip latency(ms) as perceived from Google servers for the duration period covered by the report. | |
performanceReport[].quotaConfiguredLimit |
double |
The configured quota limits for this account. | |
performanceReport[].quotaThrottledLimit |
double |
The throttled quota limits for this account. | |
performanceReport[].calloutStatusRate[] |
list |
Rate of various prefiltering statuses per match. Please refer to the callout-status-codes.txt file for different statuses. | |
performanceReport[].creativeStatusRate[] |
list |
Rate of ads with a given status. Please refer to the creative-status-codes.txt file for different statuses. | |
performanceReport[].outOfQuota |
double |
Rate of various quota account statuses per quota check. | |
performanceReport[].noQuotaInRegion |
double |
Rate of various quota account statuses per quota check. | |
performanceReport[].cookieMatcherStatusRate[] |
list |
Average QPS for cookie matcher operations. | |
performanceReport[].hostedMatchStatusRate[] |
list |
Average QPS for hosted match operations. | |
performanceReport[].pixelMatchRequests |
double |
Average QPS for pixel match requests from clients. | |
performanceReport[].pixelMatchResponses |
double |
Average QPS for pixel match responses from clients. | |
performanceReport[].inventoryMatchRate |
double |
The number of potential queries based on your pretargeting settings. | |
performanceReport[].bidRequestRate |
double |
The number of bid requests sent to your bidder. | |
performanceReport[].successfulRequestRate |
double |
The number of properly formed bid responses received by our servers within the deadline. | |
performanceReport[].unsuccessfulRequestRate |
double |
The number of bid responses that were unsuccessful due to timeouts, incorrect formatting, etc. | |
performanceReport[].bidRate |
double |
The number of bid responses with an ad. | |
performanceReport[].filteredBidRate |
double |
The number of bid responses that were filtered due to a policy violation or other errors. |
Try it!
Use the APIs Explorer below to call this method on live data and see the response.