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/v18: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 ReachPlanService.ListPlannableLocations.

Response body

A response with all available products.

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

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 (for example: BUMPER, TRUEVIEW_IN_STREAM). To list the available plannable product codes use ReachPlanService.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)
  ],
  "youtubeSelectLineups": [
    {
      object (YouTubeSelectLineUp)
    }
  ],
  "surfaceTargeting": {
    object (SurfaceTargetingCombinations)
  }
}
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. TABLET device targeting is automatically applied to reported metrics when MOBILE targeting is selected for CPM_MASTHEAD, GOOGLE_PREFERRED_BUMPER, and GOOGLE_PREFERRED_SHORT products.
networks[]

enum (ReachPlanNetwork)

Targetable networks for the ad product.
youtubeSelectLineups[]

object (YouTubeSelectLineUp)

Targetable YouTube Select Lineups for the ad product.
surfaceTargeting

object (SurfaceTargetingCombinations)

Targetable surface combinations for the ad product.

YouTubeSelectLineUp

A Plannable YouTube Select Lineup for product targeting.

JSON representation 
{
  "lineupId": string,
  "lineupName": string
}
Fields
lineupId

string (int64 format)

The ID of the YouTube Select Lineup.
lineupName

string

The unique name of the YouTube Select Lineup.

SurfaceTargetingCombinations

The surface targeting combinations available for an ad product.

JSON representation 
{
  "defaultTargeting": {
    object (SurfaceTargeting)
  },
  "availableTargetingCombinations": [
    {
      object (SurfaceTargeting)
    }
  ]
}
Fields
defaultTargeting

object (SurfaceTargeting)

Default surface targeting applied to the ad product.
availableTargetingCombinations[]

object (SurfaceTargeting)

Available surface target combinations for the ad product.