Method: advertisers.reachForecast.generateReachForecast

Gera uma previsão de alcance para um determinado anunciante e configuração de segmentação.

Solicitação HTTP

POST https://displayvideo.googleapis.com/v4/advertisers/{advertiserId}/reachForecast:generateReachForecast

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 que vai veicular a campanha planejada.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON 
{
  "targeting": {
    object (Targeting)
  },
  "campaignDuration": {
    object (CampaignDuration)
  },
  "currencyCode": string,
  "plannedProducts": [
    {
      object (PlannedProduct)
    }
  ],
  "minEffectiveFrequency": integer
}
Campos
targeting

object (Targeting)

Obrigatório. Os parâmetros de segmentação da campanha planejada.
campaignDuration

object (CampaignDuration)

Obrigatório. A duração da campanha planejada.
currencyCode

string

Obrigatório. O código da moeda do plano no formato ISO 4217.
plannedProducts[]

object (PlannedProduct)

Obrigatório. A lista de itens de linha a serem incluídos na previsão.
minEffectiveFrequency

integer

Opcional. A frequência efetiva mínima para as métricas de alcance informadas. É o número mínimo de vezes que um cliente precisa ser exposto ao anúncio para que ele seja considerado eficaz. Essa configuração afeta apenas os relatórios.

Precisa estar entre 1 e 10 (inclusive). Se não for especificado, o padrão será 1.

Corpo da resposta

Mensagem de resposta para "ReachForecastService.GenerateReachForecast".

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

Representação JSON 
{
  "onTargetAudienceMetrics": {
    object (OnTargetAudienceMetrics)
  },
  "reachCurve": {
    object (ReachCurve)
  }
}
Campos
onTargetAudienceMetrics

object (OnTargetAudienceMetrics)

Os tamanhos estimados de público-alvo para a área geográfica segmentada.
reachCurve

object (ReachCurve)

A curva de previsão gerada.

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.

Segmentação

Configurações de segmentação para uma campanha planejada.

Representação JSON 
{
  "plannableLocationIds": [
    string
  ],
  "ageRange": enum (PlannableAgeRange),
  "genders": [
    enum (Gender)
  ],
  "devices": [
    enum (DeviceType)
  ]
}
Campos
plannableLocationIds[]

string (int64 format)

Obrigatório. IDs de locais planejáveis para segmentação.

Os locais planejáveis podem ser recuperados usando o método reachForecast.retrievePlannableLocations.
ageRange

enum (PlannableAgeRange)

Opcional. A faixa etária a ser segmentada.
genders[]

enum (Gender)

Opcional. As opções de gênero para segmentação.
devices[]

enum (DeviceType)

Opcional. Os dispositivos a serem segmentados.

CampaignDuration

A duração do plano de alcance.

Representação JSON 
{

  // Union field duration can be only one of the following:
  "durationDays": integer,
  "dateRange": {
    object (DateRange)
  }
  // End of list of possible types for union field duration.
}
Campos
Campo de união duration. Escolha da duração da campanha. duration pode ser apenas de um dos tipos a seguir:
durationDays

integer

Obrigatório. O número de dias que o plano cobre.
dateRange

object (DateRange)

Obrigatório. O período que o plano abrange.

PlannedProduct

Configuração de um produto específico no plano.

Representação JSON 
{
  "plannableProductCode": string,
  "budgetMicros": string,
  "advancedProductTargeting": {
    object (AdvancedProductTargeting)
  }
}
Campos
plannableProductCode

string

Obrigatório. O código do produto, por exemplo, "VIDEO_REACH_CAMPAIGN".
budgetMicros

string (int64 format)

Obrigatório. O orçamento para este produto em micros.
advancedProductTargeting

object (AdvancedProductTargeting)

Opcional. Substituições opcionais de segmentação no nível do item de linha.

AdvancedProductTargeting

Substituições de segmentação específicas do produto.

Representação JSON 
{
  "surfaceTargetingSettings": {
    object (SurfaceTargetingSettings)
  },
  "targetFrequency": {
    object (TargetFrequency)
  },
  "frequencyCap": {
    object (FrequencyCap)
  },
  "ageRange": enum (PlannableAgeRange),
  "genders": [
    enum (Gender)
  ],
  "devices": [
    enum (DeviceType)
  ],
  "userInterestIds": [
    string
  ],
  "userListIds": [
    string
  ],
  "youtubeSelectSettings": {
    object (YouTubeSelectSettings)
  },
  "dateRange": {
    object (DateRange)
  },
  "plannableLocationIds": [
    string
  ],
  "network": enum (PlannableNetwork)
}
Campos
surfaceTargetingSettings

object (SurfaceTargetingSettings)

Opcional. Plataformas planejáveis para segmentação.
targetFrequency

object (TargetFrequency)

Opcional. É o número médio de vezes que os anúncios serão mostrados para a mesma pessoa durante um determinado período.
frequencyCap

object (FrequencyCap)

Opcional. O limite de frequência para o produto específico.
ageRange

enum (PlannableAgeRange)

Opcional. A faixa etária a ser segmentada.
genders[]

enum (Gender)

Opcional. As opções de gênero para segmentação.
devices[]

enum (DeviceType)

Opcional. Os dispositivos a serem segmentados.
userInterestIds[]

string

Opcional. Os IDs de interesse do usuário a serem segmentados.

Os interesses do usuário planejáveis podem ser recuperados usando o método reachForecast.retrievePlannableUserInterests.
userListIds[]

string

Opcional. Os IDs das listas de usuários a serem segmentadas.

As listas de usuários planejáveis podem ser recuperadas usando o método reachForecast.retrievePlannableUserInterests.
youtubeSelectSettings

object (YouTubeSelectSettings)

Opcional. Configurações do YouTube Select.
dateRange

object (DateRange)

Opcional. O período a ser segmentado.
plannableLocationIds[]

string (int64 format)

Opcional. IDs de locais planejáveis para segmentação.
network

enum (PlannableNetwork)

Opcional. A rede de destino.

SurfaceTargetingSettings

Seleção de segmentação por plataforma.

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

enum (PlannableSurface)

Opcional. As plataformas a serem segmentadas.

YouTubeSelectSettings

Configurações dos Lineups do YouTube Select.

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

string (int64 format)

Opcional. O ID do Lineup do YouTube Select.

OnTargetAudienceMetrics

Tamanhos estimados de público-alvo para uma região geográfica segmentada.

Representação JSON 
{
  "youtubeAudienceSize": string,
  "censusAudienceSize": string
}
Campos
youtubeAudienceSize

string (int64 format)

Tamanho estimado do público do YouTube.
censusAudienceSize

string (int64 format)

Tamanho do público com base nos dados do censo da região segmentada.

ReachCurve

A curva de alcance gerada.

Representação JSON 
{
  "reachForecasts": [
    {
      object (ReachForecast)
    }
  ]
}
Campos
reachForecasts[]

object (ReachForecast)

Pontos ao longo da curva, ordenados por custo.

ReachForecast

Um único ponto na curva de alcance.

Representação JSON 
{
  "costMicros": string,
  "plannedProductReachForecasts": [
    {
      object (PlannedProductReachForecast)
    }
  ],
  "forecast": {
    object (PlannedProductForecast)
  }
}
Campos
costMicros

string (int64 format)

Custo total para este ponto em micros.
plannedProductReachForecasts[]

object (PlannedProductReachForecast)

Detalhamento de produtos individuais nesse ponto de custo.
forecast

object (PlannedProductForecast)

Previsão agregada para todo o plano.

PlannedProductReachForecast

Previsão de performance para um produto específico.

Representação JSON 
{
  "costMicros": string,
  "plannableProductCode": string,
  "plannedProductForecast": {
    object (PlannedProductForecast)
  }
}
Campos
costMicros

string (int64 format)

O custo em micros para este produto.
plannableProductCode

string

O código do produto.
plannedProductForecast

object (PlannedProductForecast)

Métricas de performance do produto.

PlannedProductForecast

Métricas de performance para um ponto de previsão.

Representação JSON 
{
  "onTargetReach": string,
  "onTargetImpressions": string,
  "trueviewViews": string,
  "totalReach": string,
  "totalImpressions": string,
  "viewableImpressions": string,
  "onTargetCoviewReach": string,
  "totalCoviewReach": string,
  "onTargetCoviewImpressions": string,
  "totalCoviewImpressions": string
}
Campos
onTargetReach

string (int64 format)

Número de pessoas únicas alcançadas que correspondem à definição de público-alvo.
onTargetImpressions

string (int64 format)

Número de impressões no público-alvo.
trueviewViews

string (int64 format)

Número de visualizações TrueView.
totalReach

string (int64 format)

Número total de pessoas únicas alcançadas.
totalImpressions

string (int64 format)

Número total de impressões.
viewableImpressions

string (int64 format)

Número de impressões visíveis.
onTargetCoviewReach

string (int64 format)

Número de pessoas únicas alcançadas que correspondem à definição de público-alvo, incluindo quem assistiu junto.
totalCoviewReach

string (int64 format)

Número total de pessoas únicas alcançadas, incluindo quem assistiu junto.
onTargetCoviewImpressions

string (int64 format)

Número de impressões no público-alvo, incluindo covisualizadores.
totalCoviewImpressions

string (int64 format)

Número total de impressões, incluindo covisualizadores.