Method: billingRates.list
Stay organized with collections
Save and categorize content based on your preferences.
Retrieves a list of billing rates. This method supports paging.
HTTP request
GET https://dfareporting.googleapis.com/dfareporting/v4/userprofiles/{profileId}/billingProfiles/{billingProfileId}/billingRates
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
profileId |
string (int64 format)
User profile ID associated with this request.
|
billingProfileId |
string (int64 format)
Billing profile ID of this billing rate.
|
Request body
The request body must be empty.
Response body
Billing Rate billingRates.list Response
If successful, the response body contains data with the following structure:
| JSON representation |
{
"kind": string,
"nextPageToken": string,
"billingRates": [
{
object (BillingRate)
}
]
} |
| Fields |
kind |
string
Identifies what kind of resource this is. Value: the fixed string
"dfareporting#billingRatesListResponse"
.
|
nextPageToken |
string
Pagination token to be used for the next list operation.
|
billingRates[] |
object (BillingRate)
Billing rates collection.
|
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/dfatrafficking
BillingRate
| JSON representation |
{
"id": string,
"name": string,
"type": enum (Type),
"startDate": string,
"endDate": string,
"currencyCode": string,
"unitOfMeasure": enum (UnitOfMeasure),
"rateInMicros": string,
"tieredRates": [
{
object (BillingRateTieredRate)
}
]
} |
| Fields |
id |
string (int64 format)
ID of this billing rate.
|
name |
string
Name of this billing rate. This must be less than 256 characters long.
|
type |
enum (Type)
Type of this billing rate.
|
startDate |
string
Start date of this billing rate.
|
endDate |
string
End date of this billing rate.
|
currencyCode |
string
Billing currency code in ISO 4217 format.
|
unitOfMeasure |
enum (UnitOfMeasure)
Unit of measure for this billing rate.
|
rateInMicros |
string (int64 format)
Flat rate in micros of this billing rate. This cannot co-exist with tiered rate.
|
tieredRates[] |
object (BillingRateTieredRate)
Tiered rate of this billing rate. This cannot co-exist with flat rate.
|
Type
| Enums |
AD_SERVING |
|
CLICKS |
|
MINIMUM_SERVICE |
|
PATH_TO_CONVERSION |
|
RICH_MEDIA_INPAGE |
|
RICH_MEDIA_EXPANDING |
|
RICH_MEDIA_FLOATING |
|
RICH_MEDIA_VIDEO |
|
RICH_MEDIA_TEASER |
|
RICH_MEDIA_VPAID |
|
INSTREAM_VIDEO |
|
PIXEL |
|
TRACKING |
|
TRAFFICKING_FEATURE |
|
CUSTOM_REPORTS |
|
EXPOSURE_TO_CONVERSION |
|
DATA_TRANSFER |
|
DATA_TRANSFER_SETUP |
|
STARTUP |
|
STATEMENT_OF_WORK |
|
PROVIDED_LIST |
|
PROVIDED_LIST_SETUP |
|
ENHANCED_FORMATS |
|
TRACKING_AD_IMPRESSIONS |
|
TRACKING_AD_CLICKS |
|
NIELSEN_DIGITAL_AD_RATINGS_FEE |
|
INSTREAM_VIDEO_REDIRECT |
|
INSTREAM_VIDEO_VPAID |
|
DISPLAY_AD_SERVING |
|
VIDEO_AD_SERVING |
|
AUDIO_AD_SERVING |
|
ADVANCED_DISPLAY_AD_SERVING |
|
BillingRateTieredRate
| JSON representation |
{
"lowValue": string,
"highValue": string,
"rateInMicros": string
} |
| Fields |
lowValue |
string (int64 format)
The minimum for this tier range.
|
highValue |
string (int64 format)
The maximum for this tier range.
|
rateInMicros |
string (int64 format)
Rate in micros for this tier.
|
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-10-16 UTC.
[null,null,["Last updated 2024-10-16 UTC."],[[["\u003cp\u003eRetrieves a list of billing rates for a specified billing profile and user profile, supporting pagination for large result sets.\u003c/p\u003e\n"],["\u003cp\u003eThe API request requires authorization with the \u003ccode\u003edfatrafficking\u003c/code\u003e scope and uses a \u003ccode\u003eGET\u003c/code\u003e request with profile and billing profile IDs as path parameters.\u003c/p\u003e\n"],["\u003cp\u003eBilling rates can be defined with a flat rate or tiered rates based on usage, encompassing various types like ad serving, clicks, and rich media.\u003c/p\u003e\n"],["\u003cp\u003eEach billing rate includes details like start and end dates, currency, unit of measure (e.g., CPM, CPC), and associated tiered rates if applicable.\u003c/p\u003e\n"],["\u003cp\u003eThe response provides a list of billing rates and a token for retrieving the next page of results if available.\u003c/p\u003e\n"]]],[],null,["# Method: billingRates.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.BillingRatesListResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [BillingRate](#BillingRate)\n - [JSON representation](#BillingRate.SCHEMA_REPRESENTATION)\n- [Type](#Type)\n- [UnitOfMeasure](#UnitOfMeasure)\n- [BillingRateTieredRate](#BillingRateTieredRate)\n - [JSON representation](#BillingRateTieredRate.SCHEMA_REPRESENTATION)\n- [Try it!](#try-it)\n\nRetrieves a list of billing rates. This method supports [paging](/doubleclick-advertisers/trafficking_tasks#list).\n\n### HTTP request\n\n`GET https://dfareporting.googleapis.com/dfareporting/v4/userprofiles/{profileId}/billingProfiles/{billingProfileId}/billingRates`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|------------------------|-----------------------------------------------------------------------------------------------------------------------------------|\n| `profile``Id` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` User profile ID associated with this request. |\n| `billing``Profile``Id` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Billing profile ID of this billing rate. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nBilling Rate billingRates.list Response\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"kind\": string, \"nextPageToken\": string, \"billingRates\": [ { object (/doubleclick-advertisers/rest/v4/billingRates/list#BillingRate) } ] } ``` |\n\n| Fields ||\n|---------------------|------------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` Identifies what kind of resource this is. Value: the fixed string `\"dfareporting#billingRatesListResponse\"` . |\n| `next``Page``Token` | `string` Pagination token to be used for the next list operation. |\n| `billing``Rates[]` | `object (`[BillingRate](/doubleclick-advertisers/rest/v4/billingRates/list#BillingRate)`)` Billing rates collection. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/dfatrafficking`\n\nBillingRate\n-----------\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"id\": string, \"name\": string, \"type\": enum (/doubleclick-advertisers/rest/v4/billingRates/list#Type), \"startDate\": string, \"endDate\": string, \"currencyCode\": string, \"unitOfMeasure\": enum (/doubleclick-advertisers/rest/v4/billingRates/list#UnitOfMeasure), \"rateInMicros\": string, \"tieredRates\": [ { object (/doubleclick-advertisers/rest/v4/billingRates/list#BillingRateTieredRate) } ] } ``` |\n\n| Fields ||\n|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `id` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` ID of this billing rate. |\n| `name` | `string` Name of this billing rate. This must be less than 256 characters long. |\n| `type` | `enum (`[Type](/doubleclick-advertisers/rest/v4/billingRates/list#Type)`)` Type of this billing rate. |\n| `start``Date` | `string` Start date of this billing rate. |\n| `end``Date` | `string` End date of this billing rate. |\n| `currency``Code` | `string` Billing currency code in ISO 4217 format. |\n| `unit``Of``Measure` | `enum (`[UnitOfMeasure](/doubleclick-advertisers/rest/v4/billingRates/list#UnitOfMeasure)`)` Unit of measure for this billing rate. |\n| `rate``In``Micros` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Flat rate in micros of this billing rate. This cannot co-exist with tiered rate. |\n| `tiered``Rates[]` | `object (`[BillingRateTieredRate](/doubleclick-advertisers/rest/v4/billingRates/list#BillingRateTieredRate)`)` Tiered rate of this billing rate. This cannot co-exist with flat rate. |\n\nType\n----\n\n| Enums ||\n|----------------------------------|---|\n| `AD_SERVING` | |\n| `CLICKS` | |\n| `MINIMUM_SERVICE` | |\n| `PATH_TO_CONVERSION` | |\n| `RICH_MEDIA_INPAGE` | |\n| `RICH_MEDIA_EXPANDING` | |\n| `RICH_MEDIA_FLOATING` | |\n| `RICH_MEDIA_VIDEO` | |\n| `RICH_MEDIA_TEASER` | |\n| `RICH_MEDIA_VPAID` | |\n| `INSTREAM_VIDEO` | |\n| `PIXEL` | |\n| `TRACKING` | |\n| `TRAFFICKING_FEATURE` | |\n| `CUSTOM_REPORTS` | |\n| `EXPOSURE_TO_CONVERSION` | |\n| `DATA_TRANSFER` | |\n| `DATA_TRANSFER_SETUP` | |\n| `STARTUP` | |\n| `STATEMENT_OF_WORK` | |\n| `PROVIDED_LIST` | |\n| `PROVIDED_LIST_SETUP` | |\n| `ENHANCED_FORMATS` | |\n| `TRACKING_AD_IMPRESSIONS` | |\n| `TRACKING_AD_CLICKS` | |\n| `NIELSEN_DIGITAL_AD_RATINGS_FEE` | |\n| `INSTREAM_VIDEO_REDIRECT` | |\n| `INSTREAM_VIDEO_VPAID` | |\n| `DISPLAY_AD_SERVING` | |\n| `VIDEO_AD_SERVING` | |\n| `AUDIO_AD_SERVING` | |\n| `ADVANCED_DISPLAY_AD_SERVING` | |\n\nUnitOfMeasure\n-------------\n\n| Enums ||\n|-------|---|\n| `CPM` | |\n| `CPC` | |\n| `EA` | |\n| `P2C` | |\n\nBillingRateTieredRate\n---------------------\n\n| JSON representation |\n|-----------------------------------------------------------------------------|\n| ``` { \"lowValue\": string, \"highValue\": string, \"rateInMicros\": string } ``` |\n\n| Fields ||\n|--------------------|----------------------------------------------------------------------------------------------------------------------|\n| `low``Value` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` The minimum for this tier range. |\n| `high``Value` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` The maximum for this tier range. |\n| `rate``In``Micros` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Rate in micros for this tier. |"]]
