Method: customers.generateKeywordForecastMetrics

Muestra métricas (como impresiones, clics, costo total) de una previsión de palabras clave para una campaña determinada.

Lista de errores arrojados: AuthenticationError AuthorizationError CollectionSizeError HeaderError InternalError QuotaError RequestError

Solicitud HTTP

POST https://googleads.googleapis.com/v16/customers/{customerId}:generateKeywordForecastMetrics

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

Parámetros de ruta de acceso

Parámetros
customerId

string

El ID del cliente.

Cuerpo de la solicitud

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

Representación JSON 
{
  "forecastPeriod": {
    object (DateRange)
  },
  "campaign": {
    object (CampaignToForecast)
  },
  "currencyCode": string
}
Campos
forecastPeriod

object (DateRange)

Es el período de la previsión. La fecha de inicio debe ser posterior a la fecha actual y la de finalización debe estar dentro de 1 año a partir de hoy. La zona horaria de referencia utilizada es la de la cuenta de Google Ads que pertenece al cliente. Si no se establece, se utilizará un período predeterminado desde el próximo domingo hasta el sábado siguiente.
campaign

object (CampaignToForecast)

Obligatorio. Es la campaña que se utiliza en la previsión.
currencyCode

string

Es la moneda que se usa para la conversión del tipo de cambio. De forma predeterminada, se usa la moneda de la cuenta del cliente. Configura este campo solo si la moneda es diferente de la de la cuenta. Puede encontrar la lista de códigos de moneda válidos en https://developers.google.com/google-ads/api/data/codes-formats#currency-codes.

Cuerpo de la respuesta

Mensaje de respuesta para [KeywordPlanIdeaService.GenerateKeywordForecastMetrics].

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

Representación JSON 
{
  "campaignForecastMetrics": {
    object (KeywordForecastMetrics)
  }
}
Campos
campaignForecastMetrics

object (KeywordForecastMetrics)

Resultados de la previsión de la campaña.

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.

CampaignToForecast

Una campaña para realizar una previsión de campaña de palabras clave

Representación JSON 
{
  "languageConstants": [
    string
  ],
  "geoModifiers": [
    {
      object (CriterionBidModifier)
    }
  ],
  "keywordPlanNetwork": enum (KeywordPlanNetwork),
  "negativeKeywords": [
    {
      object (KeywordInfo)
    }
  ],
  "biddingStrategy": {
    object (CampaignBiddingStrategy)
  },
  "adGroups": [
    {
      object (ForecastAdGroup)
    }
  ],
  "conversionRate": number
}
Campos
languageConstants[]

string

La lista de nombres de recursos e idiomas a los que se orientará. El nombre del recurso tiene el formato "languageConstants/{criterionId}". Para ver la lista de códigos de criterios de idioma, consulta https://developers.google.com/google-ads/api/data/codes-formats#languages.
geoModifiers[]

object (CriterionBidModifier)

Ubicaciones de segmentación. Las ubicaciones deben ser únicas.
keywordPlanNetwork

enum (KeywordPlanNetwork)

Obligatorio. Es la red que se usa para la segmentación.
negativeKeywords[]

object (KeywordInfo)

Es la lista de palabras clave negativas que se usarán en la campaña cuando se realice la previsión.
biddingStrategy

object (CampaignBiddingStrategy)

Obligatorio. La estrategia de ofertas de la campaña.
adGroups[]

object (ForecastAdGroup)

Indica los grupos de anuncios de la campaña nueva que se van a prever.
conversionRate

number

El porcentaje de conversiones esperado (cantidad de conversiones dividida por la cantidad de clics totales) tal como lo definió el usuario Este valor se expresa como un valor decimal, por lo que se debe ingresar un porcentaje de conversiones esperado del 2% como 0.02. Si este campo se deja vacío, se usará un porcentaje de conversiones estimado.

CriterionBidModifier

modificador de ofertas del criterio de ubicación.

Representación JSON 
{
  "geoTargetConstant": string,
  "bidModifier": number
}
Campos
geoTargetConstant

string

El nombre del recurso de la ubicación geográfica a la que se orientará. El nombre del recurso tiene el formato "geoTargetConstants/{criterionId}".
bidModifier

number

El multiplicador asociado para el valueId. Si se establece, este valor no puede ser 0.

CampaignBiddingStrategy

Estrategias de oferta compatibles con las previsiones de campañas nuevas.

Representación JSON 
{

  // Union field bidding_strategy can be only one of the following:
  "manualCpcBiddingStrategy": {
    object (ManualCpcBiddingStrategy)
  },
  "maximizeClicksBiddingStrategy": {
    object (MaximizeClicksBiddingStrategy)
  },
  "maximizeConversionsBiddingStrategy": {
    object (MaximizeConversionsBiddingStrategy)
  }
  // End of list of possible types for union field bidding_strategy.
}
Campos
Campo de unión bidding_strategy. Estrategias de ofertas Las direcciones (bidding_strategy) solo pueden ser una de las siguientes opciones:
manualCpcBiddingStrategy

object (ManualCpcBiddingStrategy)

Usar la estrategia de ofertas de CPC manuales para realizar previsiones
maximizeClicksBiddingStrategy

object (MaximizeClicksBiddingStrategy)

Usar la estrategia de ofertas Maximizar clics para realizar previsiones
maximizeConversionsBiddingStrategy

object (MaximizeConversionsBiddingStrategy)

Usa la estrategia de ofertas Maximizar conversiones para realizar previsiones.

ManualCpcBiddingStrategy

Estrategia de ofertas de CPC manual.

Representación JSON 
{
  "maxCpcBidMicros": string,
  "dailyBudgetMicros": string
}
Campos
maxCpcBidMicros

string (int64 format)

Obligatorio. Es una oferta en micros que se aplicará a los grupos de anuncios dentro de la campaña para una estrategia de ofertas de CPC manuales.
dailyBudgetMicros

string (int64 format)

Presupuesto a nivel de la campaña en micros. Si se establece, se aplicará un valor mínimo para la moneda local que se use en la campaña. Se mostrará un error cuando se muestre el valor mínimo si la configuración de este campo es demasiado baja.

MaximizeClicksBiddingStrategy

estrategia de ofertas Maximizar clics.

Representación JSON 
{
  "dailyTargetSpendMicros": string,
  "maxCpcBidCeilingMicros": string
}
Campos
dailyTargetSpendMicros

string (int64 format)

Obligatorio. Es la inversión objetivo diaria en micros que se utilizará para la estimación. Se aplica un valor mínimo para la moneda local que se utiliza en la campaña. Se mostrará un error cuando se muestre el valor mínimo si la configuración de este campo es demasiado baja.
maxCpcBidCeilingMicros

string (int64 format)

Límite máximo de las ofertas de CPC máx. en micros.

MaximizeConversionsBiddingStrategy

estrategia de ofertas Maximizar conversiones.

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

string (int64 format)

Obligatorio. Es la inversión objetivo diaria en micros que se utilizará para la estimación. Este valor debe ser superior a cero.

ForecastAdGroup

Es un grupo de anuncios que forma parte de una campaña para la que se realiza una previsión.

Representación JSON 
{
  "biddableKeywords": [
    {
      object (BiddableKeyword)
    }
  ],
  "negativeKeywords": [
    {
      object (KeywordInfo)
    }
  ],
  "maxCpcBidMicros": string
}
Campos
biddableKeywords[]

object (BiddableKeyword)

Obligatorio. Es la lista de palabras clave aptas para ofertas que se usarán en el grupo de anuncios cuando se realice la previsión. Se requiere al menos una palabra clave.
negativeKeywords[]

object (KeywordInfo)

Los detalles de la palabra clave. Debes especificar tanto el texto de la palabra clave como el tipo de concordancia.
maxCpcBidMicros

string (int64 format)

El CPC máximo que se usará para el grupo de anuncios al generar tráfico previsto. Este valor anulará el valor de CPC máximo establecido en la estrategia de oferta. Especifica este campo solo para las estrategias de ofertas que alcanzan los valores máximos de CPC.

BiddableKeyword

Una parte de palabra clave apta para oferta de un grupo de anuncios.

Representación JSON 
{
  "keyword": {
    object (KeywordInfo)
  },
  "maxCpcBidMicros": string
}
Campos
keyword

object (KeywordInfo)

Obligatorio. Palabra clave. Deben contener texto y tipo de concordancia.
maxCpcBidMicros

string (int64 format)

Es una oferta de CPC máximo en micros que anula la oferta de CPC máximo a nivel del grupo de anuncios en la simulación de previsión. Este valor anulará el valor de CPC máx. establecido en la estrategia de ofertas y el grupo de anuncios. Especifica este campo solo para las estrategias de ofertas que admiten valores de CPC máximo.

KeywordForecastMetrics

Las métricas de previsión para la campaña de palabras clave sin plan

Representación JSON 
{
  "impressions": number,
  "clickThroughRate": number,
  "averageCpcMicros": string,
  "clicks": number,
  "costMicros": string,
  "conversions": number,
  "conversionRate": number,
  "averageCpaMicros": string
}
Campos
impressions

number

Es la cantidad total de impresiones.
clickThroughRate

number

Es la tasa de clics promedio. Solo está disponible si las impresiones son superiores a 0.
averageCpcMicros

string (int64 format)

Es el CPC promedio. Solo está disponible si los clics son > 0.
clicks

number

Es la cantidad total de clics.
costMicros

string (int64 format)

Es el costo total.
conversions

number

Cantidad de conversiones prevista: clics * porcentaje de conversiones
conversionRate

number

Porcentaje de conversiones previsto.
averageCpaMicros

string (int64 format)

Costo promedio por adquisición calculado como costo: Micros / conversiones