Method: customers.generateReachForecast

Genera una previsión de alcance para una combinación de productos o segmentación determinada.

Lista de errores arrojados: AuthenticationError AuthorizationError FieldError HeaderError InternalError QuotaError RangeError ReachPlanError RequestError

Solicitud HTTP

POST https://googleads.googleapis.com/v14/customers/{customerId}:generateReachForecast

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

Parámetros de ruta de acceso

Parámetros
customerId

string

Obligatorio. El ID del cliente.

Cuerpo de la solicitud

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

Representación JSON 
{
  "campaignDuration": {
    object (CampaignDuration)
  },
  "cookieFrequencyCapSetting": {
    object (FrequencyCap)
  },
  "targeting": {
    object (Targeting)
  },
  "plannedProducts": [
    {
      object (PlannedProduct)
    }
  ],
  "forecastMetricOptions": {
    object (ForecastMetricOptions)
  },
  "currencyCode": string,
  "cookieFrequencyCap": integer,
  "minEffectiveFrequency": integer,
  "effectiveFrequencyLimit": {
    object (EffectiveFrequencyLimit)
  },
  "customerReachGroup": string
}
Campos
campaignDuration

object (CampaignDuration)

Obligatorio. Duración de la campaña.
cookieFrequencyCapSetting

object (FrequencyCap)

La limitación de frecuencia de cookies elegida se aplicará a cada producto planificado. Esto equivale a la limitación de frecuencia que se expone en Google Ads cuando se crea una campaña, ya que representa la cantidad máxima de veces que se puede mostrar un anuncio al mismo usuario durante un intervalo de tiempo específico. Si no se especifica, se aplica un valor predeterminado de 0 (sin límite).

Este campo reemplaza el campo obsoleto cookieFrequencyCap.
targeting

object (Targeting)

Es la segmentación que se aplicará a todos los productos seleccionados en la combinación de productos.

Esta es la segmentación planificada: los detalles de la ejecución pueden variar según el producto publicitario. Consulta a un especialista en implementación.

Consulte métricas específicas para obtener detalles sobre cómo las afecta la segmentación.
plannedProducts[]

object (PlannedProduct)

Obligatorio. Los productos que se van a prever. La cantidad máxima de productos planificados permitidos es de 15.
forecastMetricOptions

object (ForecastMetricOptions)

Controla las métricas de previsión que se muestran en la respuesta.
currencyCode

string

Es el código de moneda. Código de moneda ISO 4217 de tres caracteres.
cookieFrequencyCap

integer

La limitación de frecuencia de cookies elegida se aplicará a cada producto planificado. Esto equivale a la limitación de frecuencia que se expone en Google Ads cuando se crea una campaña, ya que representa la cantidad máxima de veces que se puede mostrar un anuncio al mismo usuario. Si no se especifica, no se aplica ningún límite.

Este campo dejó de estar disponible en la versión 4 y se quitará con el tiempo. En su lugar, usa cookieFrequencyCapSetting.
minEffectiveFrequency

integer

Se eligió la frecuencia efectiva mínima (la cantidad de veces que una persona estuvo expuesta al anuncio) para las métricas de alcance informadas [1-10]. Esto no afectará la segmentación, sino solo los informes. Si no se especifica, se aplica un valor predeterminado de 1.

Este campo no se puede combinar con el campoEffectiveFrequencyLimit.
effectiveFrequencyLimit

object (EffectiveFrequencyLimit)

El valor [1-10] de la frecuencia efectiva mínima más alta (la cantidad de veces que una persona estuvo expuesta al anuncio) se incluirá en Forecast.effective_frequency_breakdowns. Si no se especifica, no se proporcionará Forecast.effective_frequency_breakdowns.

El valor de frecuencia efectiva que se indica aquí también se utilizará como la frecuencia efectiva mínima para las métricas de alcance informadas.

Este campo no se puede combinar con el campo minEffectiveFrequency.
customerReachGroup

string

Es el nombre del cliente para el que se planifica. Este es un valor definido por el usuario.

Cuerpo de la respuesta

Mensaje de respuesta que contiene la curva de alcance generada.

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)

Hace referencia a los usuarios objetivo para esta curva.
reachCurve

object (ReachCurve)

Es la curva de alcance generada para la combinación de productos planificada.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la Descripción general de OAuth 2.0.

CampaignDuration

La duración de una campaña planificada.

Representación JSON 
{
  "dateRange": {
    object (DateRange)
  },
  "durationInDays": integer
}
Campos
dateRange

object (DateRange)

Período de la campaña. Las fechas se expresan en el formato aaaa-mm-dd, inclusive. La fecha de finalización debe ser inferior a 1 año a partir de ahora y el período debe ser de 92 días o menos.

Este campo no se puede combinar con el campo durationInDays.
durationInDays

integer

Es el valor de duración en días.

Este campo no se puede combinar con el campo dateRange.

FrequencyCap

Es una regla que especifica la cantidad máxima de veces que se puede mostrar un anuncio a un usuario durante un período determinado.

Representación JSON 
{
  "impressions": integer,
  "timeUnit": enum (FrequencyCapTimeUnit)
}
Campos
impressions

integer

Obligatorio. Indica la cantidad de impresiones, inclusive.
timeUnit

enum (FrequencyCapTimeUnit)

Obligatorio. Es el tipo de unidad de tiempo.

EffectiveFrequencyLimit

Límite de frecuencia efectivo.

Representación JSON 
{
  "effectiveFrequencyBreakdownLimit": integer
}
Campos
effectiveFrequencyBreakdownLimit

integer

Es el valor de frecuencia efectivo más alto que se debe incluir en Forecast.effective_frequency_breakdowns. Este campo admite las frecuencias del 1 al 10, inclusive.

Segmentación

Es la segmentación para la que se informarán las métricas de tráfico.

Representación JSON 
{
  "plannableLocationIds": [
    string
  ],
  "ageRange": enum (ReachPlanAgeRange),
  "genders": [
    {
      object (GenderInfo)
    }
  ],
  "devices": [
    {
      object (DeviceInfo)
    }
  ],
  "network": enum (ReachPlanNetwork),
  "audienceTargeting": {
    object (AudienceTargeting)
  },
  "plannableLocationId": string
}
Campos
plannableLocationIds[]

string

Es la lista de IDs de ubicaciones planificados para segmentar anuncios con esta previsión.

Si se proporciona más de un ID, todos deben tener el mismo parentCountryId. No se admite la planificación para más de parent_county. Los ID de ubicación planificables y sus parentCountryId se pueden obtener de ReachPlanService.ListPlannableLocations.

Las solicitudes deben establecer este campo o plannableLocationId.
ageRange

enum (ReachPlanAgeRange)

Rango de edad al que se orienta la app. Un valor sin establecer equivale a la segmentación para todas las edades.
genders[]

object (GenderInfo)

Géneros de segmentación. Un valor sin establecer equivale a la segmentación para MALE y FEMALE.
devices[]

object (DeviceInfo)

Dispositivos de segmentación. Si no se especifica, se orienta a todos los dispositivos aplicables. Los dispositivos aplicables varían según el producto y la región, y se pueden obtener en ReachPlanService.ListPlannableProducts.
network

enum (ReachPlanNetwork)

Es la red que se puede orientar para el producto publicitario. Si no se especifica, se orienta a todas las redes aplicables. Las redes correspondientes varían según el producto y la región, y se pueden obtener de ReachPlanService.ListPlannableProducts.
audienceTargeting

object (AudienceTargeting)

Públicos de orientación. Si no se especifica, no se orienta a ningún público específico.
plannableLocationId

string

El ID de la ubicación seleccionada. Los IDs de ubicación planificables se pueden obtener de ReachPlanService.ListPlannableLocations.

Las solicitudes deben establecer este campo o plannableLocationIds.

Este campo dejó de estar disponible a partir de la versión 12 y se quitará en una versión futura. Usa plannableLocationIds en su lugar.

AudienceTargeting

Segmentación por público para la previsión de alcance

Representación JSON 
{
  "userInterest": [
    {
      object (UserInterestInfo)
    }
  ]
}
Campos
userInterest[]

object (UserInterestInfo)

Es una lista de públicos basados en los intereses de los usuarios que se deben segmentar.

PlannedProduct

Es un producto que se planea para alcanzar el alcance.

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

object (AdvancedProductTargeting)

Configuración de segmentación para el producto seleccionado. Para enumerar la segmentación disponible para cada producto, usa ReachPlanService.ListPlannableProducts.
plannableProductCode

string

Obligatorio. Producto seleccionado para la planificación. Es el código asociado con el producto publicitario (por ejemplo, TrueView o bumper). Para enumerar los códigos de productos planificables disponibles, usa ReachPlanService.ListPlannableProducts.
budgetMicros

string (int64 format)

Obligatorio. Asignación de presupuesto máxima en micros para el producto seleccionado. El valor se especifica en el currencyCode de planificación seleccionado. Por ejemplo: 1 000 000$ = 1 000 000 000 000 micros.

AdvancedProductTargeting

Configuración avanzada de segmentación para los productos.

Representación JSON 
{

  // Union field advanced_targeting can be only one of the following:
  "youtubeSelectSettings": {
    object (YouTubeSelectSettings)
  }
  // End of list of possible types for union field advanced_targeting.
}
Campos
Campo de unión advanced_targeting. Opciones de segmentación para este producto. Las direcciones (advanced_targeting) solo pueden ser una de las siguientes opciones:
youtubeSelectSettings

object (YouTubeSelectSettings)

Configuración de la segmentación de YouTube Select.

YouTubeSelectSettings

Solicita la configuración de las selecciones de contenido de YouTube Select

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

string (int64 format)

Selección de contenido para la segmentación de YouTube Select.

ForecastMetricOptions

Controla las métricas de previsión que se mostrarán.

Representación JSON 
{
  "includeCoview": boolean
}
Campos
includeCoview

boolean

Indica si se deben incluir métricas de visualización en compañía en la previsión de respuesta.

OnTargetAudienceMetrics

Métricas de público para los productos planificados. Estas métricas consideran las siguientes dimensiones de segmentación:

  • Location
  • PlannableAgeRange
  • Género
  • Segmentación por público (solo para youtubeAudienceSize)
Representación JSON 
{
  "youtubeAudienceSize": string,
  "censusAudienceSize": string
}
Campos
youtubeAudienceSize

string (int64 format)

Es el tamaño del público de referencia que coincide con la segmentación considerada para YouTube.
censusAudienceSize

string (int64 format)

Es el tamaño del público de referencia que coincide con la segmentación considerada para el censo.

ReachCurve

La curva de alcance de los productos planificados.

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

object (ReachForecast)

Todos los puntos de la curva de alcance.

ReachForecast

Un punto en la curva de alcance.

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

string (int64 format)

El costo en micros
forecast

object (Forecast)

Métricas de tráfico previstas para este punto.
plannedProductReachForecasts[]

object (PlannedProductReachForecast)

La asignación prevista y las métricas de tráfico para cada producto planificado en este punto de la curva de alcance.

Prever

Métricas de tráfico previstas para los productos y la segmentación planificados

Representación JSON 
{
  "effectiveFrequencyBreakdowns": [
    {
      object (EffectiveFrequencyBreakdown)
    }
  ],
  "onTargetReach": string,
  "totalReach": string,
  "onTargetImpressions": string,
  "totalImpressions": string,
  "viewableImpressions": string,
  "onTargetCoviewReach": string,
  "totalCoviewReach": string,
  "onTargetCoviewImpressions": string,
  "totalCoviewImpressions": string
}
Campos
effectiveFrequencyBreakdowns[]

object (EffectiveFrequencyBreakdown)

Una lista de previsiones de frecuencia efectivas. La lista está ordenada que comienza con 1 o más y termina con el valor establecido en GenerateReachForecastRequest.effective_frequency_limit. Si no se estableció ningúneffectiveFrequencyLimit, esta lista estará vacía.
onTargetReach

string (int64 format)

Es la cantidad de personas únicas a las que se llegó al menos GenerateReachForecastRequest.min_effective_frequency o GenerateReachForecastRequest.effective_frequency_limit veces que coincida exactamente con la segmentación.

Tenga en cuenta que se debe alcanzar una cantidad mínima de personas únicas para que se registren los datos. Si no se alcanza la cantidad mínima, el valor de onTargetReach se redondeará a 0.
totalReach

string (int64 format)

Es la cantidad total de personas únicas a las que se llegó al menos GenerateReachForecastRequest.min_effective_frequency o GenerateReachForecastRequest.effective_frequency_limit veces. Esto incluye a los usuarios que podrían no incluirse en la segmentación especificada.

Tenga en cuenta que se debe alcanzar una cantidad mínima de personas únicas para que se registren los datos. Si no se alcanza la cantidad mínima, el valor de totalReach se redondea a 0.
onTargetImpressions

string (int64 format)

Indica la cantidad de impresiones de anuncios que coinciden exactamente con la segmentación.
totalImpressions

string (int64 format)

Indica la cantidad total de impresiones de anuncios. Esto incluye las impresiones que podrían no incluirse en la segmentación especificada debido a que no hay suficiente información sobre los usuarios que accedieron a su cuenta.
viewableImpressions

string (int64 format)

Indica la cantidad de veces que las impresiones del anuncio se consideraron visibles. Consulte https://support.google.com/google-ads/answer/7029393 para obtener más información sobre los elementos que hacen que un anuncio sea visible y cómo se mide la visibilidad.
onTargetCoviewReach

string (int64 format)

Indica la cantidad de personas únicas alcanzadas que coinciden exactamente con la segmentación, incluidos los usuarios que miran TV en compañía.
totalCoviewReach

string (int64 format)

Indica la cantidad de personas únicas alcanzadas, incluidos los usuarios de visualización en compañía. Esto incluye a los usuarios que podrían no incluirse en la segmentación especificada.
onTargetCoviewImpressions

string (int64 format)

Indica la cantidad de impresiones de anuncios que coinciden exactamente con la segmentación, incluidos los usuarios que miran TV en compañía.
totalCoviewImpressions

string (int64 format)

Indica la cantidad total de impresiones de anuncios, incluidos los usuarios que visualizan el contenido en compañía. Esto incluye las impresiones que podrían no incluirse en la segmentación especificada debido a que no hay suficiente información sobre los usuarios que accedieron a su cuenta.

EffectiveFrequencyBreakdown

Es un desglose de la cantidad de personas únicas a las que se llegó con una frecuencia efectiva determinada.

Representación JSON 
{
  "effectiveFrequency": integer,
  "onTargetReach": string,
  "totalReach": string,
  "effectiveCoviewReach": string,
  "onTargetEffectiveCoviewReach": string
}
Campos
effectiveFrequency

integer

La frecuencia efectiva [1-10].
onTargetReach

string (int64 format)

Es la cantidad de personas únicas a las que se llegó, al menos, con la frecuencia efectiva que coincida exactamente con la segmentación.

Tenga en cuenta que se debe alcanzar una cantidad mínima de personas únicas para que se registren los datos. Si no se alcanza la cantidad mínima, el valor de onTargetReach se redondeará a 0.
totalReach

string (int64 format)

Cantidad total de personas únicas a las que se llegó al menos la frecuencia efectiva. Esto incluye a los usuarios que podrían no incluirse en la segmentación especificada.

Tenga en cuenta que se debe alcanzar una cantidad mínima de personas únicas para que se registren los datos. Si no se alcanza la cantidad mínima, el valor de totalReach se redondea a 0.
effectiveCoviewReach

string (int64 format)

Indica la cantidad de usuarios (incluidos los que usan la visualización en compañía) a los que se alcanzó el valor deeffectiveFrequency asociado.
onTargetEffectiveCoviewReach

string (int64 format)

Es la cantidad de usuarios (incluidos los que usan la visualización en compañía) a los que se llegó para el valoreffectiveFrequency asociado en el segmento demográfico del plan especificado.

PlannedProductReachForecast

La asignación prevista y las métricas de tráfico para un producto específico en un punto de la curva de alcance.

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

string

Producto seleccionado para la planificación. Los códigos de producto devueltos están dentro del conjunto de los devueltos por ListPlannableProducts cuando se usa el mismo ID de ubicación.
costMicros

string (int64 format)

El costo en micros Esto puede diferir de la asignación de entrada del producto si uno o más productos planificados no pueden cumplir con el presupuesto debido a que el inventario es limitado.
plannedProductForecast

object (PlannedProductForecast)

Métricas de tráfico previstas para este producto.

PlannedProductForecast

Métricas de tráfico previstas para un producto planificado

Representación JSON 
{
  "onTargetReach": string,
  "totalReach": string,
  "onTargetImpressions": string,
  "totalImpressions": string,
  "viewableImpressions": string,
  "onTargetCoviewReach": string,
  "totalCoviewReach": string,
  "onTargetCoviewImpressions": string,
  "totalCoviewImpressions": string
}
Campos
onTargetReach

string (int64 format)

Indica la cantidad de personas únicas alcanzadas que coinciden exactamente con la segmentación.

Tenga en cuenta que se debe alcanzar una cantidad mínima de personas únicas para que se registren los datos. Si no se alcanza la cantidad mínima, el valor de onTargetReach se redondeará a 0.
totalReach

string (int64 format)

Cantidad de personas únicas alcanzadas. Esto incluye a los usuarios que podrían no incluirse en la segmentación especificada.

Tenga en cuenta que se debe alcanzar una cantidad mínima de personas únicas para que se registren los datos. Si no se alcanza la cantidad mínima, el valor de totalReach se redondea a 0.
onTargetImpressions

string (int64 format)

Indica la cantidad de impresiones de anuncios que coinciden exactamente con la segmentación.
totalImpressions

string (int64 format)

Indica la cantidad total de impresiones de anuncios. Esto incluye las impresiones que podrían no incluirse en la segmentación especificada debido a que no hay suficiente información sobre los usuarios que accedieron a su cuenta.
viewableImpressions

string (int64 format)

Indica la cantidad de veces que las impresiones del anuncio se consideraron visibles. Consulte https://support.google.com/google-ads/answer/7029393 para obtener más información sobre los elementos que hacen que un anuncio sea visible y cómo se mide la visibilidad.
onTargetCoviewReach

string (int64 format)

Indica la cantidad de personas únicas alcanzadas que coinciden exactamente con la segmentación, incluidos los usuarios que miran TV en compañía.
totalCoviewReach

string (int64 format)

Indica la cantidad de personas únicas alcanzadas, incluidos los usuarios de visualización en compañía. Esto incluye a los usuarios que podrían no incluirse en la segmentación especificada.
onTargetCoviewImpressions

string (int64 format)

Indica la cantidad de impresiones de anuncios que coinciden exactamente con la segmentación, incluidos los usuarios que miran TV en compañía.
totalCoviewImpressions

string (int64 format)

Indica la cantidad total de impresiones de anuncios, incluidos los usuarios que visualizan el contenido en compañía. Esto incluye las impresiones que podrían no incluirse en la segmentación especificada debido a que no hay suficiente información sobre los usuarios que accedieron a su cuenta.