- Solicitud HTTP
- Parámetros de ruta de acceso
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Alcances de la autorización
- ApplyRecommendationOperation
- CampaignBudgetParameters
- TextAdParameters
- KeywordParameters
- TargetCpaOptInParameters
- TargetRoasOptInParameters
- CalloutExtensionParameters
- CallExtensionParameters
- SitelinkExtensionParameters
- MoveUnusedBudgetParameters.
- ResponsiveSearchAdParameters
- UseBroadMatchKeywordParameters
- ResponsiveSearchAdAssetParameters
- ResponsiveSearchAdImproveAdStrengthParameters
- RaiseTargetCpaBidTooLowParameters
- ForecastingSetTargetRoasParameters
- CalloutAssetParameters
- AdAssetApplyParameters
- ApplyScope
- CallAssetParameters
- SitelinkAssetParameters
- RaiseTargetCpaParameters
- LowerTargetRoasParameters
- ForecastingSetTargetCpaParameters
- LeadFormAssetParameters
- ApplyRecommendationResult
- Pruébala
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 |
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 ( |
Campos | |
---|---|
operations[] |
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 |
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 ( |
Campos | |
---|---|
results[] |
Resultados de las operaciones para aplicar recomendaciones. |
partialFailureError |
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 |
Campos | |
---|---|
resourceName |
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 |
Parámetros opcionales para utilizar cuando se aplica una recomendación de presupuesto de la campaña. |
textAd |
Parámetros opcionales para utilizar cuando se aplica una recomendación de anuncio de texto. |
keyword |
Parámetros opcionales para utilizar cuando se aplica la recomendación de palabras clave. |
targetCpaOptIn |
Son los parámetros opcionales que se deben utilizar cuando se aplica la recomendación para habilitar el CPA objetivo. |
targetRoasOptIn |
Son los parámetros opcionales que se deben utilizar cuando se aplica la recomendación para habilitar el ROAS objetivo. |
calloutExtension |
Parámetros que se deben utilizar al aplicar la recomendación de extensiones de texto destacado. |
callExtension |
Parámetros que se deben utilizar al aplicar la recomendación de extensión de llamada. |
sitelinkExtension |
Parámetros que se deben utilizar al aplicar la recomendación de vínculos a sitios. |
moveUnusedBudget |
Parámetros que se deben utilizar al aplicar la recomendación de transferencia de presupuesto sin utilizar. |
responsiveSearchAd |
Parámetros que se deben utilizar cuando se aplica una recomendación de anuncio de búsqueda responsivo. |
useBroadMatchKeyword |
Parámetros que se deben utilizar al aplicar una recomendación de palabras clave de concordancia amplia. |
responsiveSearchAdAsset |
Parámetros que se deben usar cuando se aplica una recomendación de recursos de anuncios de búsqueda responsivos. |
responsiveSearchAdImproveAdStrength |
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 |
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 |
Son los parámetros que se deben usar cuando se aplica una recomendación de ROAS objetivo establecida para las previsiones. |
calloutAsset |
Parámetros que se deben usar al aplicar la recomendación de recursos de texto destacado. |
callAsset |
Parámetros que se deben utilizar al aplicar la recomendación de recursos de llamada. |
sitelinkAsset |
Parámetros que se deben usar al aplicar la recomendación de recursos de vínculos a sitios. |
raiseTargetCpa |
Parámetros que se deben usar cuando se aplica la recomendación de aumento del CPA objetivo. |
lowerTargetRoas |
Parámetros que se deben utilizar al aplicar la recomendación de ROAS objetivo más baja. |
forecastingSetTargetCpa |
Son los parámetros que se deben utilizar cuando se aplica la recomendación de CPA objetivo establecido para las previsiones. |
setTargetCpa |
Son los parámetros que se deben utilizar al aplicar la recomendación establecida de CPA objetivo. |
setTargetRoas |
Son los parámetros que se deben utilizar al aplicar la recomendación establecida de ROAS objetivo. |
leadFormAsset |
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 |
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 ( |
Campos | |
---|---|
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 ( |
Campos | |
---|---|
matchType |
El tipo de concordancia de la palabra clave. Éste es un campo obligatorio. |
adGroup |
El recurso del grupo de anuncios al que se agregará la palabra clave. Éste es un campo obligatorio. |
cpcBidMicros |
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 |
CPA promedio para utilizar en la estrategia de ofertas CPA objetivo. Éste es un campo obligatorio. |
newCampaignBudgetAmountMicros |
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 |
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 |
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 ( |
Campos | |
---|---|
calloutExtensions[] |
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 ( |
Campos | |
---|---|
callExtensions[] |
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 ( |
Campos | |
---|---|
sitelinkExtensions[] |
Los vínculos a sitios que se agregarán Éste es un campo obligatorio. |
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 |
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 ( |
Campos | |
---|---|
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 |
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 ( |
Campos | |
---|---|
updatedAd |
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 ( |
Campos | |
---|---|
updatedAd |
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 |
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 |
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 |
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 ( |
Campos | |
---|---|
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 ( |
Campos | |
---|---|
newAssets[] |
Los recursos que se crearán y adjuntarán a un alcance. Se puede combinar con elementos existentes en la misma llamada. |
existingAssets[] |
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 |
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 ( |
Campos | |
---|---|
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 ( |
Campos | |
---|---|
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 |
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 |
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 |
CPA promedio para utilizar en la estrategia de ofertas CPA objetivo. |
campaignBudgetAmountMicros |
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 ( |
Campos | |
---|---|
adAssetApplyParameters |
Obligatorio. Se agregarán los recursos de formulario de clientes potenciales. Éste es un campo obligatorio. |
setSubmitLeadFormAssetCampaignGoal |
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 |
Se muestra cuando se aplica correctamente. |