Práticas recomendadas

Vídeo: confira a palestra sobre práticas recomendadas do workshop de 2019

Este guia aborda algumas práticas recomendadas que podem ser implementadas para otimizar a eficiência e o desempenho dos seus apps.

Manutenção contínua

Para garantir que seu aplicativo seja executado sem interrupções:

  • Mantenha o e-mail de contato do desenvolvedor atualizado na Central de API. Ele é o alias que usamos para entrar em contato com você. Se não conseguirmos falar com você sobre a conformidade com os Termos e Condições da API, seu acesso à API poderá ser revogado sem aviso prévio. Evite usar um endereço de e-mail pessoal vinculado a uma conta individual ou não monitorada. Para acessar a Central de API, você precisa fazer login na sua conta de administrador.

  • Para receber informações sobre problemas como mudanças de produtos, inatividade de manutenção, datas de descontinuação e assim por diante, inscreva-se no nosso

O fórum é monitorado regularmente pela equipe da API Google Ads, o que o torna o lugar ideal para postar perguntas sobre a API.

  • Mantenha seu app em conformidade com os Termos e Condições (T&C) da API Google Ads. Se necessário, a equipe de compliance e análise de tokens vai entrar em contato com você usando seu e-mail de contato. Se você tiver dúvidas sobre os T&C, entre em contato com a equipe de análise respondendo ao e-mail enviado a você ao analisar seu pedido de token de desenvolvedor.

Otimização

É possível otimizar seu app executando operações em lote e, se apropriado, enviando objetos raros.

Operações em lote

Fazer uma solicitação à API envolve vários custos fixos, como latência de ida e volta da rede, processamento de serialização e desserialização e chamadas para sistemas de back-end. Para diminuir 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 buscar várias operações em cada solicitação, é possível reduzir os custos fixos associados e o número de solicitações que você faz. 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é 10 solicitações com 5.000 palavras-chave cada. Há limites no número de operações permitido 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 tempo de processamento extra e desempenho reduzido. Para mitigar isso, a API Google Ads oferece suporte a atualizações esparsas, permitindo que você preencha apenas os campos em um objeto que precisam ser alterados ou que são necessá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) 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 o ID do grupo de anúncios, o ID do critério e os campos de lances precisam 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 app. Além desta seção, 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 trabalham principalmente off-line, emitindo chamadas de API como parte de um processo 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 simples que eles podem seguir para resolver o erro (confira as sugestões abaixo).

Para solicitações iniciadas no back-end, implemente processadores para os diferentes tipos de erros que o app pode encontrar. Sempre inclua um gerenciador padrão para resolver erros raros ou não encontrados anteriormente. 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 é fundamental para criar um processamento de erros robusto. Alguns dos tipos de erro mais comuns são:

  1. Erros de autenticação
  2. Erros que podem ser repetidos
  3. Erros de validação
  4. Erros relacionados à sincronização

Consulte Tipos de erro e Erros comuns para mais detalhes.

Back-ends de sincronização

Se os usuários do 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 fora de sincronia. Conforme observado no nosso guia Tipos de erros, é possível resolver erros relacionados à sincronização de forma reativa quando eles ocorrem, mas também é possível tentar evitá-los de forma proativa. Uma estratégia proativa é executar uma tarefa de sincronização durante a noite em todas as suas contas, recuperando os objetos do Google Ads nelas e fazendo comparações com seu banco de dados local.

Erros de registro

Todos os erros devem ser registrados para facilitar a depuração e o monitoramento. No mínimo, registre o código da solicitação, as operações que causaram o erro e o erro em si. Outras informações para registro incluem o ID do cliente, o serviço da API, a latência da solicitação de ida e volta, o número de novas tentativas e a solicitação e a resposta brutas.

Monitore as tendências de erros da API para detectar e resolver problemas com o app. Crie sua própria solução ou use 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 campanha ou outro processamento estão funcionando conforme o esperado. Seu token de desenvolvedor não precisa ser aprovado para ser usado em uma conta de teste. Assim, você pode começar a desenvolver com a API Google Ads imediatamente após solicitar um token de desenvolvedor, mesmo antes da análise do app.