Method: accounts.generateRateCard

Returns the rate card which applies for the provided Account for a budget plan of the specified duration.

HTTP request

POST https://ads.wazeapis.com/v1/{account=accounts/*}:generateRateCard

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
account

string

Required. The resource name of the account.

Format: accounts/{account}

Request body

The request body contains data with the following structure:

JSON representation
{
  "budgetPlanDuration": string
}
Fields
budgetPlanDuration

string (Duration format)

Duration of budget plan.

If not specified the rate card for monthly budget plans is returned. For custom pacing the duration must be a multiple of 86,400, the number of seconds in a day.

A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".

Response body

If successful, the response body contains data with the following structure:

A collection of constraints applied to budget amounts and permitted CPMs for different types of campaign and ads.

JSON representation
{
  "pin": {
    object (BudgetCpmConstraints)
  },
  "arrow": {
    object (BudgetCpmConstraints)
  },
  "standardBannerTakeover": {
    object (BudgetCpmConstraints)
  },
  "iabBannerTakeover": {
    object (BudgetCpmConstraints)
  },
  "premiumBannerTakeover": {
    object (BudgetCpmConstraints)
  }
}
Fields
pin

object (BudgetCpmConstraints)

Constraints that apply to pin campaigns.

arrow

object (BudgetCpmConstraints)

Constraints that apply to arrow campaigns.

standardBannerTakeover

object (BudgetCpmConstraints)

Constraints that apply to takeover campaigns where the ads have standardBanner or locationBanner images.

iabBannerTakeover

object (BudgetCpmConstraints)

Constraints that apply to takeover campaigns where the ads have iabImages.

premiumBannerTakeover

object (BudgetCpmConstraints)

Constraints that apply to takeover campaigns where the ads have premiumImages.

BudgetCpmConstraints

Details of budget and CPM restrictions that apply to a particular RateCard.Type.

JSON representation
{
  "minimumBudgetAmount": {
    object (Money)
  },
  "initialBudgetAmount": {
    object (Money)
  },
  "maximumBudgetAmount": {
    object (Money)
  },
  "cpm": {
    object (Money)
  }
}
Fields
minimumBudgetAmount

object (Money)

The minimum permitted budget amount.

initialBudgetAmount

object (Money)

The initial budget amount shown in the web interface.

maximumBudgetAmount

object (Money)

The maximum permitted budget amount.

cpm

object (Money)

The set CPM (cost per thousand impressions) for this RateCard.Type.