Práticas recomendadas

Este guia aborda algumas práticas recomendadas que você pode implementar para otimizar a eficiência e o desempenho 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ê para tratar da conformidade com os Termos e Condições da API, seu acesso à API poderá ser reduzido ou revogado.

  • Para receber informações sobre problemas como mudanças no produto, inatividade para manutenção e datas de descontinuação, inscreva-se no nosso blog da API e no 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 compliance 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 T&C, entre em contato com a equipe de compliance respondendo ao e-mail que ela enviou ao analisar sua solicitação de acesso à API.

Otimização

Para otimizar o app, execute operações em lote e, se for o caso, envie objetos esparsos.

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 reduzir o impacto desses custos fixos e aumentar o desempenho 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, é possível 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, imagine que você está 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é 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 o desempenho ideal.

Enviar objetos escassos

Quando os objetos são enviados para a API, os campos precisam ser desserializados, validados e armazenados no banco de dados. Transmitir objetos completos quando você só quer atualizar alguns campos pode resultar em um tempo de processamento extra e em uma diminuição do desempenho. Para mitigar isso, a API Google Ads é compatível com atualizações esparsas, permitindo que você preencha apenas os campos em um objeto que precisam ser alterados 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 no update_mask (também conhecido como FieldMask) não são alterados.

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 precisam ser preenchidos.

Tratamento e gerenciamento de erros

Durante o processo de desenvolvimento, você provavelmente encontrará erros. Nesta seção, descrevemos considerações e estratégias para criar o gerenciamento de erros no seu app. Além disso, acesse 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 possam seguir para resolver o erro (consulte as sugestões a seguir).

Para solicitações iniciadas no back-end, implemente gerenciadores para os diferentes tipos de erros que seu app pode encontrar. Sempre inclua um gerenciador padrão para lidar com erros raros ou nunca encontrados. Uma boa abordagem para um gerenciador 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 é crucial para 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 o app não conhece, fazendo com que o banco de dados local do app fique dessincronizado. Conforme observado no nosso guia Tipos de erro, é possível resolver erros relacionados à sincronização de forma reativa quando eles ocorrem, mas você também pode tentar evitá-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 todas as contas todas as noites para não esgotar as 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 de API, latência de solicitação de ida e volta, número de novas tentativas e a solicitação e resposta brutas higienizadas (com a remoção de credenciais sensíveis, como tokens OAuth e qualquer PII).

Monitore as tendências de erros de API para detectar e resolver problemas no 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.

Use 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 testar a API Google Ads e verificar 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 o Google analisar sua inscrição para níveis de acesso mais altos à API.

Avançar
Limites e cotas da API