Caution: You are viewing documentation for the API's REST interface. Most of our official client libraries use gRPC. See the REST Introduction for details.

Method: listPlannableProducts

Returns the list of per-location plannable YouTube ad formats with allowed targeting.

List of thrown errors: AuthenticationError AuthorizationError HeaderError InternalError QuotaError RequestError

HTTP request

POST https://googleads.googleapis.com/v7:listPlannableProducts

The URL uses gRPC Transcoding syntax.

Request body

The request body contains data with the following structure:

JSON representation
{
  "plannableLocationId": string
}
Fields
plannableLocationId

string

Required. The ID of the selected location for planning. To list the available plannable location ids use v4.listPlannableLocations.

Response body

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

A response with all available products.

JSON representation
{
  "productMetadata": [
    {
      object (ProductMetadata)
    }
  ]
}
Fields
productMetadata[]

object (ProductMetadata)

The list of products available for planning and related targeting metadata.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

ProductMetadata

The metadata associated with an available plannable product.

JSON representation
{
  "plannableProductName": string,
  "plannableTargeting": {
    object (PlannableTargeting)
  },
  "plannableProductCode": string
}
Fields
plannableProductName

string

The name associated with the ad product.

plannableTargeting

object (PlannableTargeting)

The allowed plannable targeting for this product.

plannableProductCode

string

The code associated with the ad product. E.g. BUMPER, TRUEVIEW_IN_STREAM To list the available plannable product codes use v4.listPlannableProducts.

PlannableTargeting

The targeting for which traffic metrics will be reported.

JSON representation
{
  "ageRanges": [
    enum (ReachPlanAgeRange)
  ],
  "genders": [
    {
      object (GenderInfo)
    }
  ],
  "devices": [
    {
      object (DeviceInfo)
    }
  ],
  "networks": [
    enum (ReachPlanNetwork)
  ]
}
Fields
ageRanges[]

enum (ReachPlanAgeRange)

Allowed plannable age ranges for the product for which metrics will be reported. Actual targeting is computed by mapping this age range onto standard Google common.AgeRangeInfo values.

genders[]

object (GenderInfo)

Targetable genders for the ad product.

devices[]

object (DeviceInfo)

Targetable devices for the ad product.

networks[]

enum (ReachPlanNetwork)

Targetable networks for the ad product.