Method: advertisers.reachForecast.retrievePlannableProducts

Recupera a lista de produtos que podem ser planejados para um local.

Solicitação HTTP

GET https://displayvideo.googleapis.com/v4/advertisers/{advertiserId}/reachForecast:retrievePlannableProducts

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
advertiserId

string (int64 format)

Obrigatório. O ID do anunciante para listar produtos planejáveis.

Parâmetros de consulta

Parâmetros
plannableLocationId

string

Obrigatório. O ID do local planejável.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Resposta para "reachForecast.retrievePlannableProducts"

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON
{
  "productMetadata": [
    {
      object (ProductMetadata)
    }
  ]
}
Campos
productMetadata[]

object (ProductMetadata)

Apenas saída. A lista de metadados do produto mostrando as possibilidades de segmentação.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/display-video

Para mais informações, consulte OAuth 2.0 Overview.

ProductMetadata

Metadados de um produto planejável.

Representação JSON
{
  "plannableProductDescription": string,
  "plannableProductCode": string,
  "plannableTargeting": {
    object (PlannableTargeting)
  },
  "displayName": string,
  "plannableProductCoreAttributes": {
    object (PlannableProductCoreAttributes)
  }
}
Campos
plannableProductDescription

string

Apenas saída. A descrição em texto simples do produto de publicidade.

plannableProductCode

string

Apenas saída. O código do produto planejável (por exemplo, "YOUTUBE_REACH_MIX").

plannableTargeting

object (PlannableTargeting)

Apenas saída. Os recursos de segmentação disponíveis para este produto.

displayName

string

Apenas saída. O nome associado ao produto de publicidade. Por exemplo: "Campanha para visualizações de vídeo".

plannableProductCoreAttributes

object (PlannableProductCoreAttributes)

Apenas saída. Atributos principais do produto.

PlannableTargeting

Recursos de segmentação para um determinado produto.

Representação JSON
{
  "ageRanges": [
    enum (PlannableAgeRange)
  ],
  "surfaceTargetingCombinations": {
    object (SurfaceTargetingCombinations)
  },
  "genders": [
    enum (Gender)
  ],
  "networks": [
    enum (PlannableNetwork)
  ],
  "devices": [
    enum (DeviceType)
  ],
  "youtubeSelectLineups": [
    {
      object (YouTubeSelectLineUp)
    }
  ],
  "defaultYoutubeSelectLineup": {
    object (YouTubeSelectLineUp)
  }
}
Campos
ageRanges[]

enum (PlannableAgeRange)

Apenas saída. Faixas etárias planejáveis permitidas para o produto. A segmentação real é calculada mapeando essa faixa etária para a segmentação por idade padrão do Google.

surfaceTargetingCombinations

object (SurfaceTargetingCombinations)

Apenas saída. Combinações de plataformas segmentáveis para o produto de publicidade.

genders[]

enum (Gender)

Apenas saída. Gêneros segmentáveis para o produto de publicidade.

networks[]

enum (PlannableNetwork)

Apenas saída. Redes segmentáveis para o produto de publicidade.

devices[]

enum (DeviceType)

Apenas saída. Dispositivos segmentáveis para o produto de publicidade.

youtubeSelectLineups[]

object (YouTubeSelectLineUp)

Apenas saída. Lineups do YouTube Select segmentáveis para o produto de publicidade.

defaultYoutubeSelectLineup

object (YouTubeSelectLineUp)

Apenas saída. O lineup padrão do YouTube Select para este produto, se aplicável.

SurfaceTargetingCombinations

Regras de segmentação por plataforma.

Representação JSON
{
  "availableSurfaceTypes": [
    enum (PlannableSurface)
  ],
  "validSurfaceCombinations": [
    {
      object (SurfaceTargetingCombination)
    }
  ],
  "defaultSurfaceTypes": [
    enum (PlannableSurface)
  ]
}
Campos
availableSurfaceTypes[]

enum (PlannableSurface)

Apenas saída. Os tipos de superfície disponíveis.

validSurfaceCombinations[]

object (SurfaceTargetingCombination)

Apenas saída. Combinações válidas de plataformas que podem ser selecionadas juntas.

defaultSurfaceTypes[]

enum (PlannableSurface)

Apenas saída. Os tipos de plataforma padrão para este produto.

SurfaceTargetingCombination

Uma combinação válida de plataformas.

Representação JSON
{
  "choices": [
    enum (PlannableSurface)
  ]
}
Campos
choices[]

enum (PlannableSurface)

Apenas saída. A combinação de superfícies.

YouTubeSelectLineUp

Um Lineup planejável do YouTube Select para segmentação por produto.

Representação JSON
{
  "lineupId": string,
  "displayName": string
}
Campos
lineupId

string (int64 format)

Apenas saída. O ID do Lineup do YouTube Select.

displayName

string

Apenas saída. O nome de exibição do Lineup do YouTube Select.

PlannableProductCoreAttributes

Atributos principais de um produto planejável.

Representação JSON
{
  "productCategory": enum (PlannableProductCategory),
  "buyingMethod": enum (PlannableBuyingMethod),
  "costModel": enum (PlannableCostModel)
}
Campos
productCategory

enum (PlannableProductCategory)

Apenas saída. A categoria do produto.

buyingMethod

enum (PlannableBuyingMethod)

Apenas saída. O método de compra.

costModel

enum (PlannableCostModel)

Apenas saída. O modelo de custo.

PlannableBuyingMethod

O método de compra de um produto planejável.

Tipos enumerados
PLANNABLE_BUYING_METHOD_UNSPECIFIED Não especificado.
PLANNABLE_BUYING_METHOD_AUCTION Leilão.
PLANNABLE_BUYING_METHOD_RESERVATION Reserva.

PlannableCostModel

O modelo de custo de um produto planejável.

Tipos enumerados
PLANNABLE_COST_MODEL_UNSPECIFIED Não especificado.
PLANNABLE_COST_MODEL_CPM CPM máximo.
PLANNABLE_COST_MODEL_CPV CPV.
PLANNABLE_COST_MODEL_CPC CPC.
PLANNABLE_COST_MODEL_CPA CPA médio.