Method: billingRates.list

  • This method retrieves a list of billing rates and supports paging.

  • The HTTP request uses a GET method with specific path parameters for user and billing profile IDs.

  • The request body for this method must be empty.

  • The response body contains a list of BillingRate objects, along with pagination information.

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.