Method: customers.recommendations.apply

Aplica las recomendaciones determinadas con los parámetros de aplicación correspondientes.

Lista de errores arrojados: AuthenticationError AuthorizationError DatabaseError FieldError HeaderError InternalError MutateError QuotaError RecommendationError RequestError UrlFieldError

Solicitud HTTP

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

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 con la recomendación.

Cuerpo de la solicitud

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

Representación JSON
{
  "operations": [
    {
      object (ApplyRecommendationOperation)
    }
  ],
  "partialFailure": boolean
}
Campos
operations[]

object (ApplyRecommendationOperation)

Obligatorio. La lista de operaciones para aplicar recomendaciones. Si partialFailure=false todas las recomendaciones deben ser del mismo tipo, hay un límite de 100 operaciones por solicitud.

partialFailure

boolean

Si es verdadero, se llevarán a cabo operaciones exitosas y las operaciones no válidas mostrarán errores. Si es falso, las operaciones se llevarán a cabo como una transacción solo si todas son válidas. El valor predeterminado es falso.

Cuerpo de la respuesta

Mensaje de respuesta para RecommendationService.ApplyRecommendation.

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

Representación JSON
{
  "results": [
    {
      object (ApplyRecommendationResult)
    }
  ],
  "partialFailureError": {
    object (Status)
  }
}
Campos
results[]

object (ApplyRecommendationResult)

Resultados de las operaciones para aplicar recomendaciones.

partialFailureError

object (Status)

Errores relacionados con fallas operativas en el modo de falla parcial. Solo se muestra cuando partialFailure = true y todos los errores ocurren dentro de las operaciones. Si se produce algún error fuera de las operaciones (por ejemplo, errores de autenticación), mostramos el error de nivel de RPC.

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.

ApplyRecommendationOperation

Información sobre la operación para aplicar una recomendación y los parámetros para personalizarla.

Representación JSON
{
  "resourceName": string,

  // Union field apply_parameters can be only one of the following:
  "campaignBudget": {
    object (CampaignBudgetParameters)
  },
  "textAd": {
    object (TextAdParameters)
  },
  "keyword": {
    object (KeywordParameters)
  },
  "targetCpaOptIn": {
    object (TargetCpaOptInParameters)
  },
  "targetRoasOptIn": {
    object (TargetRoasOptInParameters)
  },
  "calloutExtension": {
    object (CalloutExtensionParameters)
  },
  "callExtension": {
    object (CallExtensionParameters)
  },
  "sitelinkExtension": {
    object (SitelinkExtensionParameters)
  },
  "moveUnusedBudget": {
    object (MoveUnusedBudgetParameters)
  },
  "responsiveSearchAd": {
    object (ResponsiveSearchAdParameters)
  },
  "useBroadMatchKeyword": {
    object (UseBroadMatchKeywordParameters)
  },
  "responsiveSearchAdAsset": {
    object (ResponsiveSearchAdAssetParameters)
  },
  "responsiveSearchAdImproveAdStrength": {
    object (ResponsiveSearchAdImproveAdStrengthParameters)
  },
  "raiseTargetCpaBidTooLow": {
    object (RaiseTargetCpaBidTooLowParameters)
  },
  "forecastingSetTargetRoas": {
    object (ForecastingSetTargetRoasParameters)
  },
  "calloutAsset": {
    object (CalloutAssetParameters)
  },
  "callAsset": {
    object (CallAssetParameters)
  },
  "sitelinkAsset": {
    object (SitelinkAssetParameters)
  },
  "raiseTargetCpa": {
    object (RaiseTargetCpaParameters)
  },
  "lowerTargetRoas": {
    object (LowerTargetRoasParameters)
  },
  "forecastingSetTargetCpa": {
    object (ForecastingSetTargetCpaParameters)
  },
  "setTargetCpa": {
    object (ForecastingSetTargetCpaParameters)
  },
  "setTargetRoas": {
    object (ForecastingSetTargetRoasParameters)
  },
  "leadFormAsset": {
    object (LeadFormAssetParameters)
  }
  // End of list of possible types for union field apply_parameters.
}
Campos
resourceName

string

El nombre del recurso de la recomendación que se aplicará.

Campo de unión apply_parameters. Parámetros para usar cuando se aplica la recomendación. Las direcciones (apply_parameters) solo pueden ser una de las siguientes opciones:
campaignBudget

object (CampaignBudgetParameters)

Parámetros opcionales para utilizar cuando se aplica una recomendación de presupuesto de la campaña.

textAd

object (TextAdParameters)

Parámetros opcionales para utilizar cuando se aplica una recomendación de anuncio de texto.

keyword

object (KeywordParameters)

Parámetros opcionales para utilizar cuando se aplica la recomendación de palabras clave.

targetCpaOptIn

object (TargetCpaOptInParameters)

Son los parámetros opcionales que se deben utilizar cuando se aplica la recomendación para habilitar el CPA objetivo.

targetRoasOptIn

object (TargetRoasOptInParameters)

Son los parámetros opcionales que se deben utilizar cuando se aplica la recomendación para habilitar el ROAS objetivo.

calloutExtension

object (CalloutExtensionParameters)

Parámetros que se deben utilizar al aplicar la recomendación de extensiones de texto destacado.

callExtension

object (CallExtensionParameters)

Parámetros que se deben utilizar al aplicar la recomendación de extensión de llamada.

moveUnusedBudget

object (MoveUnusedBudgetParameters)

Parámetros que se deben utilizar al aplicar la recomendación de transferencia de presupuesto sin utilizar.

responsiveSearchAd

object (ResponsiveSearchAdParameters)

Parámetros que se deben utilizar cuando se aplica una recomendación de anuncio de búsqueda responsivo.

useBroadMatchKeyword

object (UseBroadMatchKeywordParameters)

Parámetros que se deben utilizar al aplicar una recomendación de palabras clave de concordancia amplia.

responsiveSearchAdAsset

object (ResponsiveSearchAdAssetParameters)

Parámetros que se deben usar cuando se aplica una recomendación de recursos de anuncios de búsqueda responsivos.

responsiveSearchAdImproveAdStrength

object (ResponsiveSearchAdImproveAdStrengthParameters)

Los parámetros que se deben utilizar cuando se aplica un anuncio de búsqueda responsivo mejoran la recomendación de calidad del anuncio.

raiseTargetCpaBidTooLow

object (RaiseTargetCpaBidTooLowParameters)

Parámetros que se deben usar cuando se aplica una recomendación de oferta de aumento de CPA objetivo demasiado baja. La aplicación es asíncrona y puede demorar minutos, según la cantidad de grupos de anuncios que haya en la campaña relacionada.

forecastingSetTargetRoas

object (ForecastingSetTargetRoasParameters)

Son los parámetros que se deben usar cuando se aplica una recomendación de ROAS objetivo establecida para las previsiones.

calloutAsset

object (CalloutAssetParameters)

Parámetros que se deben usar al aplicar la recomendación de recursos de texto destacado.

callAsset

object (CallAssetParameters)

Parámetros que se deben utilizar al aplicar la recomendación de recursos de llamada.

raiseTargetCpa

object (RaiseTargetCpaParameters)

Parámetros que se deben usar cuando se aplica la recomendación de aumento del CPA objetivo.

lowerTargetRoas

object (LowerTargetRoasParameters)

Parámetros que se deben utilizar al aplicar la recomendación de ROAS objetivo más baja.

forecastingSetTargetCpa

object (ForecastingSetTargetCpaParameters)

Son los parámetros que se deben utilizar cuando se aplica la recomendación de CPA objetivo establecido para las previsiones.

setTargetCpa

object (ForecastingSetTargetCpaParameters)

Son los parámetros que se deben utilizar al aplicar la recomendación establecida de CPA objetivo.

setTargetRoas

object (ForecastingSetTargetRoasParameters)

Son los parámetros que se deben utilizar al aplicar la recomendación establecida de ROAS objetivo.

leadFormAsset

object (LeadFormAssetParameters)

Parámetros que se deben utilizar al aplicar la recomendación de recursos de formulario de clientes potenciales.

CampaignBudgetParameters

Parámetros que se deben utilizar al aplicar una recomendación de presupuesto para la campaña.

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

string (int64 format)

Es el nuevo importe del presupuesto que se establecerá para el recurso del presupuesto objetivo. Éste es un campo obligatorio.

TextAdParameters

Parámetros que se deben utilizar al aplicar una recomendación de anuncio de texto.

Representación JSON
{
  "ad": {
    object (Ad)
  }
}
Campos
ad

object (Ad)

Es un anuncio nuevo para agregar al grupo de anuncios recomendado. Se deben configurar todos los campos necesarios en este mensaje. Éste es un campo obligatorio.

KeywordParameters

Parámetros para usar cuando se aplica la recomendación de palabras clave.

Representación JSON
{
  "matchType": enum (KeywordMatchType),
  "adGroup": string,
  "cpcBidMicros": string
}
Campos
matchType

enum (KeywordMatchType)

El tipo de concordancia de la palabra clave. Éste es un campo obligatorio.

adGroup

string

El recurso del grupo de anuncios al que se agregará la palabra clave. Éste es un campo obligatorio.

cpcBidMicros

string (int64 format)

Opcional: Oferta de CPC que se establecerá para la palabra clave. Si no la estableces, la palabra clave utilizará la oferta según la estrategia de ofertas que utilice el grupo de anuncios objetivo.

TargetCpaOptInParameters

Son los parámetros que se deben utilizar al aplicar la recomendación del CPA objetivo.

Representación JSON
{
  "targetCpaMicros": string,
  "newCampaignBudgetAmountMicros": string
}
Campos
targetCpaMicros

string (int64 format)

CPA promedio para utilizar en la estrategia de ofertas CPA objetivo. Éste es un campo obligatorio.

newCampaignBudgetAmountMicros

string (int64 format)

Es el importe de presupuesto que se establecerá para la campaña (opcional).

TargetRoasOptInParameters

Son los parámetros que se deben usar cuando se aplica una recomendación para habilitar el ROAS objetivo.

Representación JSON
{
  "targetRoas": number,
  "newCampaignBudgetAmountMicros": string
}
Campos
targetRoas

number

ROAS (ingresos por unidad de inversión) promedio para usar en la estrategia de ofertas ROAS objetivo. El valor está entre 0.01 y 1,000.0, inclusive. Este es un campo obligatorio, a menos que se configure newCampaignBudgetAmountMicros.

newCampaignBudgetAmountMicros

string (int64 format)

Es el importe de presupuesto que se establecerá para la campaña (opcional).

CalloutExtensionParameters

Parámetros que se deben utilizar al aplicar la recomendación de extensiones de texto destacado.

Representación JSON
{
  "calloutExtensions": [
    {
      object (CalloutFeedItem)
    }
  ]
}
Campos
calloutExtensions[]

object (CalloutFeedItem)

Extensiones de texto destacado que se agregarán. Éste es un campo obligatorio.

CallExtensionParameters

Parámetros que se deben utilizar al aplicar la recomendación de extensión de llamada.

Representación JSON
{
  "callExtensions": [
    {
      object (CallFeedItem)
    }
  ]
}
Campos
callExtensions[]

object (CallFeedItem)

Se agregarán las extensiones de llamada. Éste es un campo obligatorio.

SitelinkExtensionParameters

Parámetros que se deben utilizar al aplicar la recomendación de vínculos a sitios.

Representación JSON
{
  "sitelinkExtensions": [
    {
      object (SitelinkFeedItem)
    }
  ]
}
Campos

MoveUnusedBudgetParameters

Parámetros que se deben utilizar al aplicar la recomendación de transferencia de presupuesto sin utilizar.

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

string (int64 format)

Importe del presupuesto para pasar de excedente a presupuesto limitado. Éste es un campo obligatorio.

ResponsiveSearchAdParameters

Parámetros que se deben utilizar cuando se aplica una recomendación de anuncio de búsqueda responsivo.

Representación JSON
{
  "ad": {
    object (Ad)
  }
}
Campos
ad

object (Ad)

Obligatorio. Es un anuncio nuevo para agregar al grupo de anuncios recomendado.

UseBroadMatchKeywordParameters

Parámetros que se deben utilizar al aplicar una recomendación de palabras clave de concordancia amplia.

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

string (int64 format)

Es el nuevo importe del presupuesto que se establecerá para el recurso del presupuesto objetivo.

ResponsiveSearchAdAssetParameters

Parámetros que se deben usar cuando se aplica una recomendación de recursos de anuncios de búsqueda responsivos.

Representación JSON
{
  "updatedAd": {
    object (Ad)
  }
}
Campos
updatedAd

object (Ad)

Anuncio actualizado Se reemplazará el contenido del anuncio actual.

ResponsiveSearchAdImproveAdStrengthParameters

Los parámetros que se deben utilizar cuando se aplica un anuncio de búsqueda responsivo mejoran la recomendación de calidad del anuncio.

Representación JSON
{
  "updatedAd": {
    object (Ad)
  }
}
Campos
updatedAd

object (Ad)

Anuncio actualizado Se reemplazará el contenido del anuncio actual.

RaiseTargetCpaBidTooLowParameters

Parámetros que se deben usar cuando se aplica una recomendación de oferta de aumento de CPA objetivo demasiado baja. La aplicación es asíncrona y puede tardar minutos según la cantidad de grupos de anuncios que haya en la campaña relacionada.

Representación JSON
{
  "targetMultiplier": number
}
Campos
targetMultiplier

number

Obligatorio. Un número superior a 1.0 que indica el factor por el que se debe aumentar el CPA objetivo. Éste es un campo obligatorio.

ForecastingSetTargetRoasParameters

Son los parámetros que se deben usar cuando se aplica una recomendación de ROAS objetivo establecida para las previsiones.

Representación JSON
{
  "targetRoas": number,
  "campaignBudgetAmountMicros": string
}
Campos
targetRoas

number

Nuevo ROAS objetivo (ingresos por unidad de inversión) para establecer para un recurso de campaña. El valor está entre 0.01 y 1,000.0, inclusive.

campaignBudgetAmountMicros

string (int64 format)

Es el nuevo importe del presupuesto de la campaña que se establecerá para un recurso de campaña.

CalloutAssetParameters

Parámetros que se deben utilizar al aplicar las recomendaciones de recursos de texto destacado.

Representación JSON
{
  "adAssetApplyParameters": {
    object (AdAssetApplyParameters)
  }
}
Campos
adAssetApplyParameters

object (AdAssetApplyParameters)

Obligatorio. Recursos de texto destacado que se agregarán. Éste es un campo obligatorio.

AdAssetApplyParameters

Parámetros comunes que se usan al aplicar recomendaciones de recursos del anuncio.

Representación JSON
{
  "newAssets": [
    {
      object (Asset)
    }
  ],
  "existingAssets": [
    string
  ],
  "scope": enum (ApplyScope)
}
Campos
newAssets[]

object (Asset)

Los recursos que se crearán y adjuntarán a un alcance. Se puede combinar con elementos existentes en la misma llamada.

existingAssets[]

string

Los nombres de recursos de elementos existentes que se adjuntarán a un alcance. Se puede combinar con nuevos recursos en la misma llamada.

scope

enum (ApplyScope)

Obligatorio. El alcance en el que se aplican los recursos. Los recursos a nivel del alcance de la campaña se aplicarán a la campaña asociada con la recomendación. Los recursos del alcance del cliente se aplicarán a toda la cuenta. Los recursos en el alcance de la campaña anularán los adjuntos al alcance del cliente.

ApplyScope

Es el alcance al que se aplicarán los recursos.

Enumeradores
UNSPECIFIED No se especificó el permiso de aplicación.
UNKNOWN Desconocido.
CUSTOMER Aplica en el alcance del cliente.
CAMPAIGN Aplícalos en el alcance de la campaña.

CallAssetParameters

Parámetros que se deben utilizar al aplicar recomendaciones de recursos de llamada.

Representación JSON
{
  "adAssetApplyParameters": {
    object (AdAssetApplyParameters)
  }
}
Campos
adAssetApplyParameters

object (AdAssetApplyParameters)

Obligatorio. Se deben agregar los recursos de llamada. Éste es un campo obligatorio.

SitelinkAssetParameters

Parámetros que se deben utilizar al aplicar las recomendaciones de recursos de vínculos a sitios.

Representación JSON
{
  "adAssetApplyParameters": {
    object (AdAssetApplyParameters)
  }
}
Campos
adAssetApplyParameters

object (AdAssetApplyParameters)

Obligatorio. Recursos de vínculo a sitio que se agregarán. Éste es un campo obligatorio.

RaiseTargetCpaParameters

Son los parámetros que se deben utilizar cuando se aplican las recomendaciones de aumento del CPA objetivo.

Representación JSON
{
  "targetCpaMultiplier": number
}
Campos
targetCpaMultiplier

number

Obligatorio. Objetivo para establecer el multiplicador de CPA. Éste es un campo obligatorio.

LowerTargetRoasParameters

Son los parámetros que se deben usar al aplicar recomendaciones de ROAS objetivo más bajas.

Representación JSON
{
  "targetRoasMultiplier": number
}
Campos
targetRoasMultiplier

number

Obligatorio. Objetivo para establecer el multiplicador de ROAS. Éste es un campo obligatorio.

ForecastingSetTargetCpaParameters

Son los parámetros que se deben utilizar al aplicar una recomendación de CPA objetivo establecida.

Representación JSON
{
  "targetCpaMicros": string,
  "campaignBudgetAmountMicros": string
}
Campos
targetCpaMicros

string (int64 format)

CPA promedio para utilizar en la estrategia de ofertas CPA objetivo.

campaignBudgetAmountMicros

string (int64 format)

Es el nuevo importe del presupuesto de la campaña que se establecerá para un recurso de campaña.

LeadFormAssetParameters

Parámetros que se deben utilizar al aplicar una recomendación de recursos de formulario de clientes potenciales.

Representación JSON
{
  "adAssetApplyParameters": {
    object (AdAssetApplyParameters)
  },
  "setSubmitLeadFormAssetCampaignGoal": boolean
}
Campos
adAssetApplyParameters

object (AdAssetApplyParameters)

Obligatorio. Se agregarán los recursos de formulario de clientes potenciales. Éste es un campo obligatorio.

setSubmitLeadFormAssetCampaignGoal

boolean

Si es verdadero, el objetivo "Enviar formulario de clientes potenciales" se establecerá en la campaña objetivo. Como resultado, los anuncios se mostrarán como anuncios creativos con formulario de clientes potenciales. Si es falso, no se establecerá el objetivo "Enviar formulario de clientes potenciales" en la campaña y los anuncios incluirán recursos de formulario de clientes potenciales.

ApplyRecommendationResult

Es el resultado de aplicar una recomendación.

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

string

Se muestra cuando se aplica correctamente.