- Solicitação HTTP
- Parâmetros de caminho
- Corpo da solicitação
- Corpo da resposta
- Escopos de autorização
- 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
- Faça um teste
Aplica determinadas recomendações 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/v16/customers/{customerId}/recommendations:apply
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de caminho
Parâmetros | |
---|---|
customerId |
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 ( |
Campos | |
---|---|
operations[] |
Obrigatório. A lista de operações para aplicar recomendações. Se partialFailure=false todas as recomendações precisam ser do mesmo tipo. Há um limite de cem operações por solicitação. |
partialFailure |
Se verdadeiro, as operações bem-sucedidas serão executadas 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 ( |
Campos | |
---|---|
results[] |
Resultados das operações para aplicar recomendações. |
partialFailureError |
Erros relacionados a falhas de operação no modo de falha parcial. Retornado apenas 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), retornaremos o erro de nível 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 para personalizá-la.
Representação JSON |
---|
{ "resourceName": string, // Union field |
Campos | |
---|---|
resourceName |
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 |
Parâmetros opcionais usados ao aplicar uma recomendação de orçamento da campanha. |
textAd |
Parâmetros opcionais a serem usados ao aplicar uma recomendação de anúncio de texto. |
keyword |
Parâmetros opcionais usados ao aplicar a recomendação de palavras-chave. |
targetCpaOptIn |
Parâmetros opcionais a serem usados ao aplicar a recomendação de ativação do CPA desejado. |
targetRoasOptIn |
Parâmetros opcionais a serem usados ao aplicar a recomendação de ativação do ROAS desejado. |
calloutExtension |
Parâmetros a serem usados ao aplicar a recomendação de extensão de frase de destaque. |
callExtension |
Parâmetros a serem usados ao aplicar a recomendação de extensão de chamada. |
sitelinkExtension |
Parâmetros a serem usados ao aplicar a recomendação de sitelink. |
moveUnusedBudget |
Parâmetros a serem usados ao aplicar a recomendação de mover orçamento não utilizado. |
responsiveSearchAd |
Parâmetros a serem usados ao aplicar uma recomendação de anúncio responsivo de pesquisa. |
useBroadMatchKeyword |
Parâmetros a serem usados ao aplicar uma recomendação de uso de palavra-chave de correspondência ampla. |
responsiveSearchAdAsset |
Parâmetros a serem usados ao aplicar uma recomendação de recurso de anúncio responsivo de pesquisa. |
responsiveSearchAdImproveAdStrength |
Os parâmetros a serem usados ao aplicar um anúncio responsivo de pesquisa melhoram a recomendação de qualidade do anúncio. |
raiseTargetCpaBidTooLow |
Parâmetros a serem usados ao aplicar uma recomendação de aumento do lance de CPA desejado muito baixo. A aplicação é assíncrona e pode levar minutos, dependendo do número de grupos de anúncios presentes na campanha relacionada. |
forecastingSetTargetRoas |
Parâmetros a serem usados ao aplicar uma recomendação de ROAS desejado definida pela previsão. |
calloutAsset |
Parâmetros a serem usados ao aplicar a recomendação de recurso de frase de destaque. |
callAsset |
Parâmetros a serem usados ao aplicar a recomendação de recurso de ligação. |
sitelinkAsset |
Parâmetros a serem usados ao aplicar a recomendação de recurso de sitelink. |
raiseTargetCpa |
Parâmetros a serem usados ao aplicar a recomendação de aumentar o CPA desejado. |
lowerTargetRoas |
Parâmetros a serem usados ao aplicar a recomendação de ROAS desejado mais baixo. |
forecastingSetTargetCpa |
Parâmetros a serem usados ao aplicar a estimativa de recomendação de CPA desejado. |
setTargetCpa |
Parâmetros a serem usados ao aplicar a recomendação de CPA desejado definida. |
setTargetRoas |
Parâmetros a serem usados ao aplicar a recomendação de ROAS desejado definida. |
leadFormAsset |
Parâmetros a serem usados ao aplicar a recomendação de recursos de formulário de lead. |
CampaignBudgetParameters
Parâmetros a serem usados ao aplicar uma recomendação de orçamento da campanha.
Representação JSON |
---|
{ "newBudgetAmountMicros": string } |
Campos | |
---|---|
newBudgetAmountMicros |
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 ( |
Campos | |
---|---|
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 ( |
Campos | |
---|---|
matchType |
Tipo de correspondência da palavra-chave. Este campo é obrigatório. |
adGroup |
O recurso do grupo de anúncios ao qual adicionar a palavra-chave. Este campo é obrigatório. |
cpcBidMicros |
Opcional: lance de CPC a ser definido para a palavra-chave. Se não for definido, a palavra-chave vai 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 |
CPA médio a ser usado na estratégia de lances de CPA desejado. Este campo é obrigatório. |
newCampaignBudgetAmountMicros |
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 |
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 |
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 ( |
Campos | |
---|---|
calloutExtensions[] |
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 ( |
Campos | |
---|---|
callExtensions[] |
Extensões de chamada a serem adicionadas. Este campo é obrigatório. |
SitelinkExtensionParameters
Parâmetros a serem usados ao aplicar a recomendação de sitelink.
Representação JSON |
---|
{
"sitelinkExtensions": [
{
object ( |
Campos | |
---|---|
sitelinkExtensions[] |
Sitelinks a serem adicionados. Este campo é obrigatório. |
MoveUnusedBudgetParameters
Parâmetros a serem usados ao aplicar a recomendação de mover orçamento não utilizado.
Representação JSON |
---|
{ "budgetMicrosToMove": string } |
Campos | |
---|---|
budgetMicrosToMove |
Valor do orçamento que será transferido 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 ( |
Campos | |
---|---|
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 |
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 ( |
Campos | |
---|---|
updatedAd |
Anúncio atualizado. O conteúdo do anúncio atual será substituído. |
ResponsiveSearchAdImproveAdStrengthParameters
Os parâmetros a serem usados ao aplicar um anúncio responsivo de pesquisa melhoram a recomendação de qualidade do anúncio.
Representação JSON |
---|
{
"updatedAd": {
object ( |
Campos | |
---|---|
updatedAd |
Anúncio atualizado. O conteúdo do anúncio atual será substituído. |
RaiseTargetCpaBidTooLowParameters
Parâmetros a serem usados ao aplicar uma recomendação de aumento do lance de CPA desejado muito baixo. A aplicação é assíncrona e pode levar minutos, dependendo do número de grupos de anúncios presentes na campanha relacionada.
Representação JSON |
---|
{ "targetMultiplier": number } |
Campos | |
---|---|
targetMultiplier |
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 definida pela previsão.
Representação JSON |
---|
{ "targetRoas": number, "campaignBudgetAmountMicros": string } |
Campos | |
---|---|
targetRoas |
Novo ROAS desejado (receita por unidade de gasto) a ser definido para um recurso de campanha. O valor está entre 0,01 e 1000,0. |
campaignBudgetAmountMicros |
Novo valor do orçamento da 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 ( |
Campos | |
---|---|
adAssetApplyParameters |
Obrigatório. Recursos de frase de destaque a serem adicionados. Este campo é obrigatório. |
AdAssetApplyParameters
Parâmetros comuns usados ao aplicar as recomendações de recursos de anúncio.
Representação JSON |
---|
{ "newAssets": [ { object ( |
Campos | |
---|---|
newAssets[] |
Os recursos a serem criados e anexados a um escopo. Isso pode ser combinado com os recursos atuais na mesma chamada. |
existingAssets[] |
Os nomes dos recursos atuais que serão anexados a um escopo. Isso pode ser combinado com newAssets na mesma chamada. |
scope |
Obrigatório. O escopo em que os recursos serão aplicados. Os recursos no escopo da campanha serão aplicados à campanha associada à recomendação. Os recursos no escopo do cliente serão aplicados a toda a conta. Os recursos no escopo da campanha vão substituir os anexados 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 para aplicar as recomendações de recursos de ligação.
Representação JSON |
---|
{
"adAssetApplyParameters": {
object ( |
Campos | |
---|---|
adAssetApplyParameters |
Obrigatório. Recursos de ligação que serão adicionados Este campo é obrigatório. |
SitelinkAssetParameters
Parâmetros a serem usados ao aplicar as recomendações de recursos de sitelink.
Representação JSON |
---|
{
"adAssetApplyParameters": {
object ( |
Campos | |
---|---|
adAssetApplyParameters |
Obrigatório. Recursos de sitelink a serem adicionados. Este campo é obrigatório. |
RaiseTargetCpaParameters
Parâmetros a serem usados ao aplicar as recomendações de aumento do CPA desejado.
Representação JSON |
---|
{ "targetCpaMultiplier": number } |
Campos | |
---|---|
targetCpaMultiplier |
Obrigatório. Valor desejado para definir o multiplicador de CPA. 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 |
Obrigatório. Meta para definir o multiplicador de ROAS. Este campo é obrigatório. |
ForecastingSetTargetCpaParameters
Parâmetros a serem usados ao aplicar uma recomendação de CPA desejado definida.
Representação JSON |
---|
{ "targetCpaMicros": string, "campaignBudgetAmountMicros": string } |
Campos | |
---|---|
targetCpaMicros |
CPA médio a ser usado na estratégia de lances de CPA desejado. |
campaignBudgetAmountMicros |
Novo valor do orçamento da campanha a ser definido para um recurso de campanha. |
LeadFormAssetParameters
Parâmetros a serem usados ao aplicar uma recomendação de recursos de formulário de lead.
Representação JSON |
---|
{
"adAssetApplyParameters": {
object ( |
Campos | |
---|---|
adAssetApplyParameters |
Obrigatório. Recursos de formulário de lead a serem adicionados Este campo é obrigatório. |
setSubmitLeadFormAssetCampaignGoal |
Se verdadeiro, a meta "Enviar formulário de lead" vai ser definida na campanha de destino. Como resultado, eles vão aparecer como anúncios de criativo de formulário de lead. Se for "false", a meta "Enviar formulário de lead" não vai ser definida na campanha, e os anúncios vão conter recursos de formulário de lead. |
ApplyRecommendationResult
O resultado da aplicação de uma recomendação.
Representação JSON |
---|
{ "resourceName": string } |
Campos | |
---|---|
resourceName |
Retornado para aplicações bem-sucedidas. |