Práticas recomendadas

Este guia aborda algumas práticas recomendadas que você pode implementar para otimizar a eficiência e a performance dos seus apps.

Manter o app

Para garantir que o app seja executado sem interrupções, faça o seguinte:

  • Verifique se a lista de proprietários e editores do seu projeto do Google Cloud está atualizada. Vamos entrar em contato com esses usuários em caso de emergências ou assuntos relacionados à conformidade com os Termos e Condições da API. Se não for possível entrar em contato com você sobre a conformidade com os Termos e Condições da API, seu acesso à API poderá ser reduzido ou revogado.

  • Para ser informado sobre problemas, como mudanças de produtos, tempo de inatividade de manutenção e datas de descontinuação, inscreva-se no nosso blog da API e blog do produto.

  • Mantenha seu app em conformidade com os Termos e Condições (T&C) da API Google Ads. Se necessário, a equipe de conformidade da API vai entrar em contato com os proprietários e editores do seu projeto do Google Cloud com acesso à API. Se você tiver dúvidas sobre os Termos e Condições, entre em contato com a equipe de conformidade respondendo ao e-mail que eles enviaram ao analisar seu pedido de acesso à API.

Otimização

Você pode otimizar seu app executando operações em lote e, se apropriado, enviando objetos escassos.

Operações em lote

Fazer uma solicitação à API envolve vários custos fixos, como latência de rede de ida e volta, processamento de serialização e desserialização e chamadas para sistemas de back-end. Para diminuir o impacto desses custos fixos e aumentar a performance geral, a maioria dos métodos de mutação na API foi projetada para aceitar uma matriz de operações. Ao agrupar várias operações em cada solicitação, você pode reduzir o número de solicitações feitas e os custos fixos associados. Se possível, evite fazer solicitações com apenas uma operação.

Por exemplo, suponha que você esteja adicionando 50.000 palavras-chave a uma campanha em vários grupos de anúncios. Em vez de fazer 50.000 solicitações com uma palavra-chave cada, faça 100 solicitações com 500 palavras-chave cada ou até mesmo 10 solicitações com 5.000 palavras-chave cada. Há limites para o número de operações permitidas em uma solicitação. Portanto, talvez seja necessário ajustar o tamanho do lote para alcançar a performance ideal.

Enviar objetos escassos

Quando os objetos são enviados à API, os campos precisam ser desserializados, validados e armazenados no banco de dados. A transmissão de objetos completos quando você só quer atualizar alguns campos pode resultar em tempo de processamento extra e diminuição da performance. Para atenuar isso, a API Google Ads oferece suporte a atualizações esparsas, permitindo que você preencha apenas os campos de um objeto que precisa mudar ou que são obrigatórios. As atualizações esparsas são processadas mais rapidamente e têm menos probabilidade de produzir erros. Os campos que não estão na update_mask (também conhecida como FieldMask) permanecem inalterados.

Por exemplo, um app que atualiza lances no nível da palavra-chave pode se beneficiar do uso de atualizações esparsas, já que apenas os campos de ID do grupo de anúncios, ID do critério e lances precisariam ser preenchidos.

Tratamento e gerenciamento de erros

Durante o processo de desenvolvimento, você provavelmente encontrará erros. Esta seção descreve considerações e estratégias para criar o gerenciamento de erros no seu app. Além desta seção, consulte o guia de solução de problemas para mais informações sobre como gerenciar erros.

Diferenciar origens de solicitação

Alguns apps são principalmente interativos, emitindo chamadas de API diretamente em resposta a ações iniciadas pelo usuário em uma interface. Outros funcionam principalmente off-line, emitindo chamadas de API como parte de um processo de back-end periódico. Muitos aplicativos combinam os dois. Ao pensar no gerenciamento de erros, pode ser útil distinguir esses diferentes tipos de solicitações.

No caso de solicitações iniciadas pelo usuário, sua principal preocupação deve ser oferecer uma boa experiência aos seus usuários. Use o erro específico que ocorreu para fornecer ao usuário o máximo de contexto possível na interface. Ofereça etapas claras que eles podem seguir para resolver o erro (consulte as sugestões a seguir).

Para solicitações iniciadas no back-end, implemente processadores para os diferentes tipos de erros que seu app pode encontrar. Sempre inclua um processador padrão para resolver erros raros ou que não foram encontrados anteriormente. Uma boa abordagem para um processador padrão é adicionar a operação com falha e o erro a uma fila para que um operador humano analise e determine uma resolução adequada.

Diferenciar tipos de erro

Conhecer as diferenças entre os tipos de erro na API Google Ads é fundamental ao criar um tratamento de erros robusto. Alguns dos tipos de erro mais comuns são:

Consulte Tipos de erro e Erros comuns para mais detalhes.

Sincronizar back-ends

Se os usuários do seu app tiverem acesso manual às contas do Google Ads, eles poderão fazer mudanças que seu app não conhece, fazendo com que o banco de dados local do app fique dessincronizado. Conforme observado no nosso guia Tipos de erro, você pode resolver erros relacionados à sincronização de forma reativa quando eles ocorrem, mas também pode tentar evitar los de forma proativa. Uma estratégia proativa é executar um job de sincronização periódico para reconciliar seu banco de dados local com os objetos do Google Ads nas suas contas. Para hierarquias de contas grandes, evite extrair todos os objetos de cada conta durante a noite para evitar o esgotamento das cotas diárias. Em vez disso, consulte ChangeStatus ou filtre as entidades modificadas recentemente para sincronizar as mudanças de forma incremental.

Erros de registro

Todos os erros devem ser registrados para facilitar a depuração e o monitoramento. No mínimo, registre o ID da solicitação, as operações que causaram o erro e o próprio erro. Outras informações a serem registradas incluem ID de cliente, serviço da API, latência de solicitação de ida e volta, número de novas tentativas e a solicitação e resposta brutas limpas (garantindo a redação de credenciais confidenciais, como tokens OAuth e PII).

Monitore as tendências de erros da API para detectar e resolver problemas com seu app. Considere criar sua própria solução ou usar uma das muitas ferramentas comerciais disponíveis que podem usar seus registros para produzir painéis interativos e enviar alertas automatizados.

Desenvolvimento

Use contas de teste durante o desenvolvimento.

Usar contas de teste

As contas de teste são contas do Google Ads que não veiculam anúncios. Você pode usar uma conta de teste para experimentar a API Google Ads e testar se a conectividade do app, a lógica de gerenciamento de campanhas ou outro processamento estão funcionando conforme o esperado. Seu projeto do Google Cloud só precisa de acesso de teste para ser usado em uma conta de teste. Assim, você pode começar a desenvolver com a API Google Ads imediatamente, enquanto aguarda a análise do Google para níveis de acesso mais altos.

Avançar
Limites e quotas da API