Method: customers.recommendations.apply

Aplica as recomendações determinadas com parâmetros apply correspondentes.

Lista de erros gerados: AuthenticationError AuthorizationError DatabaseError FieldError HeaderError InternalError MutateError QuotaError RecommendationError RequestError UrlFieldError

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
customerId

string

Obrigatório. O ID do cliente com a recomendação.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON 
{
  "operations": [
    {
      object (ApplyRecommendationOperation)
    }
  ],
  "partialFailure": boolean
}
Campos
operations[]

object (ApplyRecommendationOperation)

Obrigatório. A lista de operações em que as recomendações serão aplicadas. Se partialFailure=false todas as recomendações precisam ser do mesmo tipo. Há um limite de cem operações por solicitação.
partialFailure

boolean

Se verdadeiro, as operações bem-sucedidas serão realizadas e as operações inválidas retornarão erros. Se for falso, as operações serão realizadas como uma transação apenas se todas forem válidas. O padrão é false

Corpo da resposta

Mensagem de resposta para RecommendationService.ApplyRecommendation.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "results": [
    {
      object (ApplyRecommendationResult)
    }
  ],
  "partialFailureError": {
    object (Status)
  }
}
Campos
results[]

object (ApplyRecommendationResult)

Resultados das operações para aplicar recomendações.
partialFailureError

object (Status)

Erros relacionados a falhas de operação no modo de falha parcial. Retornado somente quando partialFailure = true e todos os erros ocorrem dentro das operações. Se ocorrer algum erro fora das operações (por exemplo, erros de autenticação), vamos retornar o erro no nível da RPC.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte a Visão geral do OAuth 2.0.

ApplyRecommendationOperation

Informações sobre a operação para aplicar uma recomendação e os parâmetros de personalização dela.

Representação 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)
  }
  // End of list of possible types for union field apply_parameters.
}
Campos
resourceName

string

O nome do recurso da recomendação a ser aplicada.
Campo de união apply_parameters. Parâmetros a serem usados ao aplicar a recomendação. apply_parameters pode ser apenas de um dos tipos a seguir:
campaignBudget

object (CampaignBudgetParameters)

Parâmetros opcionais a serem usados ao aplicar uma recomendação de orçamento da campanha.
textAd

object (TextAdParameters)

Parâmetros opcionais a serem usados ao aplicar uma recomendação de anúncio de texto.
keyword

object (KeywordParameters)

Parâmetros opcionais a serem usados ao aplicar a recomendação de palavra-chave.
targetCpaOptIn

object (TargetCpaOptInParameters)

Parâmetros opcionais a serem usados ao aplicar a recomendação de ativação do CPA desejado.
targetRoasOptIn

object (TargetRoasOptInParameters)

Parâmetros opcionais a serem usados ao aplicar a recomendação de ativação do ROAS desejado.
calloutExtension

object (CalloutExtensionParameters)

Parâmetros a serem usados ao aplicar a recomendação de extensão de frase de destaque.
callExtension

object (CallExtensionParameters)

Parâmetros a serem usados ao aplicar a recomendação de extensão de chamada.
moveUnusedBudget

object (MoveUnusedBudgetParameters)

Parâmetros a serem usados ao aplicar a recomendação de transferência de orçamento não utilizado.
responsiveSearchAd

object (ResponsiveSearchAdParameters)

Parâmetros a serem usados ao aplicar uma recomendação de anúncio responsivo de pesquisa.
useBroadMatchKeyword

object (UseBroadMatchKeywordParameters)

Parâmetros a serem usados ao aplicar uma recomendação de uso de palavra-chave de correspondência ampla.
responsiveSearchAdAsset

object (ResponsiveSearchAdAssetParameters)

Parâmetros a serem usados ao aplicar uma recomendação de recurso de anúncio responsivo de pesquisa.
responsiveSearchAdImproveAdStrength

object (ResponsiveSearchAdImproveAdStrengthParameters)

Parâmetros a serem usados ao aplicar um anúncio responsivo de pesquisa para melhorar a recomendação de qualidade do anúncio.
raiseTargetCpaBidTooLow

object (RaiseTargetCpaBidTooLowParameters)

Parâmetros a serem usados ao aplicar uma recomendação muito baixa para aumentar o lance de CPA desejado. A aplicação é assíncrona e pode levar alguns minutos, dependendo do número de grupos de anúncios presentes na campanha relacionada.
forecastingSetTargetRoas

object (ForecastingSetTargetRoasParameters)

Parâmetros a serem usados ao aplicar uma recomendação de ROAS desejado definida pela estimativa.
calloutAsset

object (CalloutAssetParameters)

Parâmetros a serem usados ao aplicar a recomendação de recursos de frase de destaque.
callAsset

object (CallAssetParameters)

Parâmetros a serem usados ao aplicar a recomendação de recurso de ligação.
raiseTargetCpa

object (RaiseTargetCpaParameters)

Parâmetros que serão usados ao aplicar a recomendação de aumento do CPA desejado.
lowerTargetRoas

object (LowerTargetRoasParameters)

Parâmetros a serem usados ao aplicar a recomendação de ROAS desejado mais baixo.

CampaignBudgetParameters

Parâmetros a serem usados ao aplicar uma recomendação de orçamento da campanha.

Representação JSON 
{
  "newBudgetAmountMicros": string
}
Campos
newBudgetAmountMicros

string (int64 format)

Novo valor do orçamento a ser definido para o recurso de orçamento-alvo. Este campo é obrigatório.

TextAdParameters

Parâmetros a serem usados ao aplicar uma recomendação de anúncio de texto.

Representação JSON 
{
  "ad": {
    object (Ad)
  }
}
Campos
ad

object (Ad)

Novo anúncio a ser adicionado ao grupo de anúncios recomendado. Todos os campos necessários precisam ser definidos nessa mensagem. Este campo é obrigatório.

KeywordParameters

Parâmetros a serem usados ao aplicar a recomendação de palavra-chave.

Representação JSON 
{
  "matchType": enum (KeywordMatchType),
  "adGroup": string,
  "cpcBidMicros": string
}
Campos
matchType

enum (KeywordMatchType)

Tipo de correspondência da palavra-chave. Este campo é obrigatório.
adGroup

string

O recurso do grupo de anúncios ao qual a palavra-chave será adicionada. Este campo é obrigatório.
cpcBidMicros

string (int64 format)

Opcional, lance de CPC a ser definido para a palavra-chave. Se não for definido, a palavra-chave usará o lance com base na estratégia de lances usada pelo grupo de anúncios de destino.

TargetCpaOptInParameters

Parâmetros a serem usados ao aplicar a recomendação de CPA desejado.

Representação JSON 
{
  "targetCpaMicros": string,
  "newCampaignBudgetAmountMicros": string
}
Campos
targetCpaMicros

string (int64 format)

CPA médio a ser usado na estratégia de lances de CPA desejado. Este campo é obrigatório.
newCampaignBudgetAmountMicros

string (int64 format)

Opcional: o valor do orçamento a ser definido para a campanha.

TargetRoasOptInParameters

Parâmetros a serem usados ao aplicar uma recomendação de ativação do ROAS desejado.

Representação JSON 
{
  "targetRoas": number,
  "newCampaignBudgetAmountMicros": string
}
Campos
targetRoas

number

ROAS médio (receita por unidade de gasto) a ser usado na estratégia de lances de ROAS desejado. O valor está entre 0,01 e 1000,0. Esse campo é obrigatório, a menos que newCampaignBudgetAmountMicros esteja definido.
newCampaignBudgetAmountMicros

string (int64 format)

Opcional: o valor do orçamento a ser definido para a campanha.

CalloutExtensionParameters

Parâmetros a serem usados ao aplicar a recomendação de extensão de frase de destaque.

Representação JSON 
{
  "calloutExtensions": [
    {
      object (CalloutFeedItem)
    }
  ]
}
Campos
calloutExtensions[]

object (CalloutFeedItem)

Extensões de frase de destaque a serem adicionadas. Este campo é obrigatório.

CallExtensionParameters

Parâmetros a serem usados ao aplicar a recomendação de extensão de chamada.

Representação JSON 
{
  "callExtensions": [
    {
      object (CallFeedItem)
    }
  ]
}
Campos
callExtensions[]

object (CallFeedItem)

Extensões de chamada a serem adicionadas. Este campo é obrigatório.

SitelinkExtensionParameters

Parâmetros que serão usados ao aplicar a recomendação de sitelink.

Representação JSON 
{
  "sitelinkExtensions": [
    {
      object (SitelinkFeedItem)
    }
  ]
}
Campos

MoveUnusedBudgetParameters

Parâmetros a serem usados ao aplicar a recomendação de transferência de orçamento não utilizado.

Representação JSON 
{
  "budgetMicrosToMove": string
}
Campos
budgetMicrosToMove

string (int64 format)

Valor do orçamento que será movido do orçamento excedente para o limitado. Este campo é obrigatório.

ResponsiveSearchAdParameters

Parâmetros a serem usados ao aplicar uma recomendação de anúncio responsivo de pesquisa.

Representação JSON 
{
  "ad": {
    object (Ad)
  }
}
Campos
ad

object (Ad)

Obrigatório. Novo anúncio a ser adicionado ao grupo de anúncios recomendado.

UseBroadMatchKeywordParameters

Parâmetros a serem usados ao aplicar uma recomendação de uso de palavra-chave de correspondência ampla.

Representação JSON 
{
  "newBudgetAmountMicros": string
}
Campos
newBudgetAmountMicros

string (int64 format)

Novo valor do orçamento a ser definido para o recurso de orçamento-alvo.

ResponsiveSearchAdAssetParameters

Parâmetros a serem usados ao aplicar uma recomendação de recurso de anúncio responsivo de pesquisa.

Representação JSON 
{
  "updatedAd": {
    object (Ad)
  }
}
Campos
updatedAd

object (Ad)

Anúncio atualizado. O conteúdo do anúncio atual será substituído.

ResponsiveSearchAdImproveAdStrengthParameters

Parâmetros a serem usados ao aplicar um anúncio responsivo de pesquisa para melhorar a recomendação de qualidade do anúncio.

Representação JSON 
{
  "updatedAd": {
    object (Ad)
  }
}
Campos
updatedAd

object (Ad)

Anúncio atualizado. O conteúdo do anúncio atual será substituído.

RaiseTargetCpaBidTooLowParameters

Parâmetros a serem usados ao aplicar uma recomendação muito baixa para aumentar o lance de CPA desejado. A aplicação é assíncrona e pode levar alguns minutos, dependendo do número de grupos de anúncios presentes na campanha relacionada.

Representação JSON 
{
  "targetMultiplier": number
}
Campos
targetMultiplier

number

Obrigatório. Um número maior que 1,0 que indica o fator pelo qual aumentar o CPA desejado. Este campo é obrigatório.

ForecastingSetTargetRoasParameters

Parâmetros a serem usados ao aplicar uma recomendação de ROAS desejado definido de previsão.

Representação JSON 
{
  "targetRoas": number,
  "campaignBudgetAmountMicros": string
}
Campos
targetRoas

number

Novo ROAS (receita por unidade de gasto) desejado a ser definido para um recurso de campanha. O valor está entre 0,01 e 1000,0.
campaignBudgetAmountMicros

string (int64 format)

Novo valor do orçamento de campanha a ser definido para um recurso de campanha.

CalloutAssetParameters

Parâmetros a serem usados ao aplicar as recomendações de recursos de frase de destaque.

Representação JSON 
{
  "adAssetApplyParameters": {
    object (AdAssetApplyParameters)
  }
}
Campos
adAssetApplyParameters

object (AdAssetApplyParameters)

Obrigatório. Recursos de frase de destaque a serem adicionados. Este campo é obrigatório.

AdAssetApplyParameters

Parâmetros comuns usados ao aplicar recomendações de recursos de anúncio.

Representação JSON 
{
  "newAssets": [
    {
      object (Asset)
    }
  ],
  "existingAssets": [
    string
  ],
  "scope": enum (ApplyScope)
}
Campos
newAssets[]

object (Asset)

Os recursos que serão criados e anexados a um escopo. Pode ser combinado com os recursos atuais na mesma chamada.
existingAssets[]

string

Os nomes de recursos dos recursos atuais que serão anexados a um escopo. Pode ser combinado com newAssets na mesma chamada.
scope

enum (ApplyScope)

Obrigatório. O escopo em que os recursos serão aplicados. Os recursos no nível do escopo da campanha vão ser usados na campanha associada à recomendação. Os recursos no escopo do cliente vão ser usados em toda a conta. Os recursos no escopo da campanha vão substituir os que estão no escopo do cliente.

ApplyScope

Escopo para aplicar os recursos.

Enums
UNSPECIFIED O escopo de aplicação não foi especificado.
UNKNOWN Desconhecido.
CUSTOMER Aplique no escopo do cliente.
CAMPAIGN Aplicar no escopo da campanha.

CallAssetParameters

Parâmetros a serem usados ao aplicar as recomendações de recursos de ligação.

Representação JSON 
{
  "adAssetApplyParameters": {
    object (AdAssetApplyParameters)
  }
}
Campos
adAssetApplyParameters

object (AdAssetApplyParameters)

Obrigatório. Recursos de ligação a serem adicionados. Este campo é obrigatório.

SitelinkAssetParameters

Parâmetros que serão usados ao aplicar as recomendações de recursos de sitelink.

Representação JSON 
{
  "adAssetApplyParameters": {
    object (AdAssetApplyParameters)
  }
}
Campos
adAssetApplyParameters

object (AdAssetApplyParameters)

Obrigatório. Recursos de sitelink a serem adicionados. Este campo é obrigatório.

RaiseTargetCpaParameters

Parâmetros que serão usados ao aplicar as recomendações de aumento do CPA desejado.

Representação JSON 
{
  "targetCpaMultiplier": number
}
Campos
targetCpaMultiplier

number

Obrigatório. Meta para a qual o multiplicador de CPA será definido. Este campo é obrigatório.

LowerTargetRoasParameters

Parâmetros a serem usados ao aplicar recomendações de ROAS desejado mais baixo.

Representação JSON 
{
  "targetRoasMultiplier": number
}
Campos
targetRoasMultiplier

number

Obrigatório. Meta para definir o multiplicador de ROAS. Este campo é obrigatório.

ApplyRecommendationResult

O resultado da aplicação de uma recomendação.

Representação JSON 
{
  "resourceName": string
}
Campos
resourceName

string

Retornado para aplicações bem-sucedidas.