Como alterar e inspecionar objetos

Objetivo :entender como modificar e inspecionar objetos usando a API Google Ads.

Conforme discutido no guia da estrutura da API, cada recurso de nível superior na API Google Ads tem um serviço correspondente específico do tipo de recurso que oferece suporte a:

• Como modificar instâncias do recurso
• Como recuperar uma única instância do recurso para inspeção

Este guia vai usar CampaignService para demonstrar como modificar e inspecionar objetos Campaign, mas os mesmos conceitos se aplicam a todos os outros serviços específicos a cada tipo de recurso.

Termo-chave: um recurso de nível superior é um recurso cujo nome não inclui um ponto (.). Por exemplo, Campaign é um recurso de nível superior, mas Campaign.NetworkSettings não é.

Como mudar objetos

Cada serviço específico ao tipo de recurso tem um método mutate que aceita uma solicitação de mutação. Essa solicitação consiste em:

• Um customerId
• Um conjunto de operações
• Uma configuração de tipo de conteúdo de resposta que determina se o recurso mutável ou apenas o nome do recurso precisa ser retornado após a mutação.

Por exemplo, o método MutateCampaigns de CampaignService aceita um MutateCampaignsRequest que consiste em:

• Um customerId
• Uma coleção de objetos CampaignOperation
• O campo response_content_type que indica o tipo de resposta preferido.

Operações

Um objeto de operação, como um CampaignOperation, permite que você especifique a ação que quer executar em um único recurso definindo o campo operation dele. Esse campo é um campo oneof que consiste nos seguintes atributos, cujo tipo é o tipo do recurso:

create

Cria uma nova instância do recurso.

update

Atualiza o recurso para corresponder aos atributos do recurso update. Quando esse campo está definido, você também precisa definir a update_mask da operação, que informa à API Google Ads quais atributos modificar durante a operação de atualização. Cada biblioteca de cliente tem um método utilitário ou auxiliar que gera o update_mask para você, conforme demonstrado nas nossas bibliotecas de cliente.

remove

Remove o recurso.

Como o campo operation é um campo oneof, não é possível usar uma única operação para modificar vários objetos. Por exemplo, se você quiser criar uma campanha e remover outra, adicione duas instâncias de CampaignOperation à solicitação: uma com create definida e outra com remove definida.

Operações em lote

Embora uma única operação possa criar, atualizar ou remover um único recurso, uma única solicitação de mutação pode conter várias operações. É necessário combinar as operações em uma única solicitação de mutação em vez de enviar várias solicitações de mutação que contêm uma única operação.

Por exemplo, se você quiser criar 10 campanhas, envie uma única MutateCampaignsRequest com 10 objetos CampaignOperation.

Respostas da solicitação "mutate"

O que é retornado na resposta depende do que foi enviado no response_content_type da solicitação de mutação. Por exemplo, se MUTABLE_RESOURCE for especificado, a resposta vai conter apenas os campos mutáveis na campanha. Em seguida, é possível fazer mutações de acompanhamento nesse objeto de recurso sem precisar reconstruí-lo.

Erros de mutação

As operações em uma determinada solicitação de mutação só serão aplicadas à sua conta do Google Ads se todas as operações na solicitação forem bem-sucedidas. Confira o guia de erros comuns para ver uma lista de erros comuns e como resolvê-los.

Aviso: get não é mais compatível. Use search ou searchStream para recuperar objetos.

Como inspecionar objetos com get (descontinuado)

Além de mudar objetos, cada serviço específico ao tipo de recurso também tem um método get para recuperar todos os atributos de um único recurso. Esse método aceita uma solicitação GET que tenha resource_name como único atributo.

Importante: use get com moderação.

Os métodos get são uma conveniência oferecida pela API Google Ads para recuperar todos os atributos de um único objeto. Embora eles sejam uma excelente ferramenta para aprender sobre a API ou inspecionar um objeto individualmente para depuração ou fins educacionais, não recomendamos que o app use métodos get para recuperar objetos para processamento ou geração de relatórios. Em vez disso, use GoogleAdsService, já que ele permite recuperar apenas atributos específicos de objetos, oferece suporte à recuperação de métricas de desempenho e permite streaming em grandes conjuntos de resultados. Se o app enviar um grande número de solicitações GET, poderá ocorrer a limitação de taxa.