Method: advertisers.reachForecast.generateReachForecast

Genera una previsión de alcance para un anunciante y una configuración de segmentación determinados.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta

Parámetros
advertiserId

string (int64 format)

Obligatorio. Es el ID del anunciante que publicará la campaña planificada.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON 
{
  "targeting": {
    object (Targeting)
  },
  "campaignDuration": {
    object (CampaignDuration)
  },
  "currencyCode": string,
  "plannedProducts": [
    {
      object (PlannedProduct)
    }
  ],
  "minEffectiveFrequency": integer
}
Campos
targeting

object (Targeting)

Obligatorio. Son los parámetros de segmentación de la campaña planificada.
campaignDuration

object (CampaignDuration)

Obligatorio. Es la duración de la campaña planificada.
currencyCode

string

Obligatorio. Es el código de moneda del plan en formato ISO 4217.
plannedProducts[]

object (PlannedProduct)

Obligatorio. Es la lista de líneas de pedido que se incluirán en la previsión.
minEffectiveFrequency

integer

Opcional. Es la frecuencia efectiva mínima para las métricas de alcance informadas. Es la cantidad mínima de veces que un cliente debe estar expuesto al anuncio para que se considere eficaz. Este parámetro de configuración solo afecta los informes.

Debe estar comprendido entre 1 y 10, ambos incluidos. Si no se especifica, se aplica el valor predeterminado 1.

Cuerpo de la respuesta

Es el mensaje de respuesta de ReachForecastService.GenerateReachForecast.

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Representación JSON 
{
  "onTargetAudienceMetrics": {
    object (OnTargetAudienceMetrics)
  },
  "reachCurve": {
    object (ReachCurve)
  }
}
Campos
onTargetAudienceMetrics

object (OnTargetAudienceMetrics)

Son los tamaños estimados del público para la ubicación geográfica segmentada.
reachCurve

object (ReachCurve)

Es la curva de previsión generada.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

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

Para obtener más información, consulta OAuth 2.0 Overview.

Segmentación

Configuración de la segmentación para una campaña planificada.

Representación JSON 
{
  "plannableLocationIds": [
    string
  ],
  "ageRange": enum (PlannableAgeRange),
  "genders": [
    enum (Gender)
  ],
  "devices": [
    enum (DeviceType)
  ]
}
Campos
plannableLocationIds[]

string (int64 format)

Obligatorio. Son los IDs de las ubicaciones planificables para la segmentación.

Las ubicaciones planificables se pueden recuperar con el método reachForecast.retrievePlannableLocations.
ageRange

enum (PlannableAgeRange)

Opcional. Es el rango de edad para la segmentación.
genders[]

enum (Gender)

Opcional. Son las opciones de género para la segmentación.
devices[]

enum (DeviceType)

Opcional. Son los dispositivos para segmentar.

CampaignDuration

Es la duración del plan de alcance.

Representación 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ón duration. Puedes elegir la duración de la campaña. duration puede ser solo uno de los parámetros siguientes:
durationDays

integer

Obligatorio. Cantidad de días que cubre el plan.
dateRange

object (DateRange)

Obligatorio. Es el período que abarca el plan.

PlannedProduct

Es la configuración de un producto específico en el plan.

Representación JSON 
{
  "plannableProductCode": string,
  "budgetMicros": string,
  "advancedProductTargeting": {
    object (AdvancedProductTargeting)
  }
}
Campos
plannableProductCode

string

Obligatorio. Es el código del producto, p.ej., "VIDEO_REACH_CAMPAIGN".
budgetMicros

string (int64 format)

Obligatorio. Es el presupuesto de este producto en micros.
advancedProductTargeting

object (AdvancedProductTargeting)

Opcional. Son anulaciones opcionales de la segmentación a nivel de la línea de pedido.

AdvancedProductTargeting

Son las anulaciones de la segmentación específicas del producto.

Representación 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 en las que se pueden planificar campañas.
targetFrequency

object (TargetFrequency)

Opcional. Es la cantidad promedio de veces que los anuncios se mostrarán a la misma persona durante un período determinado.
frequencyCap

object (FrequencyCap)

Opcional. Es la limitación de frecuencia para el producto específico.
ageRange

enum (PlannableAgeRange)

Opcional. Es el rango de edad para la segmentación.
genders[]

enum (Gender)

Opcional. Son las opciones de género para la segmentación.
devices[]

enum (DeviceType)

Opcional. Son los dispositivos para segmentar.
userInterestIds[]

string

Opcional. Son los IDs de los intereses del usuario para la segmentación.

Los intereses del usuario que se pueden planificar se pueden recuperar con el método reachForecast.retrievePlannableUserInterests.
userListIds[]

string

Opcional. Son los IDs de las listas de usuarios a las que se segmentará la campaña.

Las listas de usuarios planificables se pueden recuperar con el método reachForecast.retrievePlannableUserInterests.
youtubeSelectSettings

object (YouTubeSelectSettings)

Opcional. Configuración de YouTube Select.
dateRange

object (DateRange)

Opcional. Es el período para el que se segmenta.
plannableLocationIds[]

string (int64 format)

Opcional. Son los IDs de ubicaciones que se pueden planificar para la segmentación.
network

enum (PlannableNetwork)

Opcional. Es la red a la que se segmenta.

SurfaceTargetingSettings

Selección de la segmentación por plataformas.

Representación JSON 
{
  "surfaces": [
    enum (PlannableSurface)
  ]
}
Campos
surfaces[]

enum (PlannableSurface)

Opcional. Son las plataformas en las que se segmentarán los anuncios.

YouTubeSelectSettings

Es la configuración de las selecciones de contenido de YouTube Select.

Representación JSON 
{
  "lineupId": string
}
Campos
lineupId

string (int64 format)

Opcional. Es el ID de la selección de contenido de YouTube Select.

OnTargetAudienceMetrics

Son los tamaños estimados del público para una ubicación geográfica segmentada.

Representación JSON 
{
  "youtubeAudienceSize": string,
  "censusAudienceSize": string
}
Campos
youtubeAudienceSize

string (int64 format)

Es el tamaño estimado del público de YouTube.
censusAudienceSize

string (int64 format)

Tamaño del público en función de los datos del censo de la ubicación geográfica segmentada.

ReachCurve

Es la curva de alcance generada.

Representación JSON 
{
  "reachForecasts": [
    {
      object (ReachForecast)
    }
  ]
}
Campos
reachForecasts[]

object (ReachForecast)

Son los puntos a lo largo de la curva, ordenados por costo.

ReachForecast

Es un solo punto en la curva de alcance.

Representación JSON 
{
  "costMicros": string,
  "plannedProductReachForecasts": [
    {
      object (PlannedProductReachForecast)
    }
  ],
  "forecast": {
    object (PlannedProductForecast)
  }
}
Campos
costMicros

string (int64 format)

Es el costo total para este punto en micros.
plannedProductReachForecasts[]

object (PlannedProductReachForecast)

Desglose de productos individuales en este punto de costo.
forecast

object (PlannedProductForecast)

Es la previsión agregada para todo el plan.

PlannedProductReachForecast

Es la previsión del rendimiento de un producto específico.

Representación JSON 
{
  "costMicros": string,
  "plannableProductCode": string,
  "plannedProductForecast": {
    object (PlannedProductForecast)
  }
}
Campos
costMicros

string (int64 format)

Es el costo en micros de este producto.
plannableProductCode

string

Es el código del producto.
plannedProductForecast

object (PlannedProductForecast)

Son las métricas de rendimiento del producto.

PlannedProductForecast

Son las métricas de rendimiento para un punto de previsión.

Representación 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)

Es la cantidad de personas únicas alcanzadas que coinciden con la definición de público objetivo.
onTargetImpressions

string (int64 format)

Es la cantidad de impresiones por segmentación.
trueviewViews

string (int64 format)

Es la cantidad de vistas de TrueView.
totalReach

string (int64 format)

Es la cantidad total de personas únicas alcanzadas.
totalImpressions

string (int64 format)

Es la cantidad total de impresiones.
viewableImpressions

string (int64 format)

Cantidad de impresiones visibles
onTargetCoviewReach

string (int64 format)

Es la cantidad de personas únicas alcanzadas que coinciden con la definición de público objetivo, incluidos los usuarios que miraron el contenido en compañía.
totalCoviewReach

string (int64 format)

Es la cantidad total de personas únicas alcanzadas, incluidos los usuarios que miraron el contenido en compañía.
onTargetCoviewImpressions

string (int64 format)

Cantidad de impresiones por segmentación, incluidos los usuarios de visualización en compañía.
totalCoviewImpressions

string (int64 format)

Es la cantidad total de impresiones, incluidos los usuarios que miraron el contenido en compañía.