Práticas recomendadas

Vídeo: confira a palestra de 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 apps.

Manutenção contínua

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

  • Mantenha seu e-mail de contato de 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 ser informado sobre problemas como alterações de produtos, inatividade de manutenção, datas de suspensão de uso e assim por diante, assine nossa

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

  • Mantenha seu aplicativo em conformidade com os Termos e Condições da API Google Ads (T&C). Se necessário, a equipe de análise e de conformidade de tokens entrará em contato usando seu e-mail de contato. Se você tiver dúvidas ou preocupações sobre o T&C, entre em contato com a equipe de revisão respondendo ao e-mail que ele enviou a você na avaliação do aplicativo do token de desenvolvedor.

Otimização

Operações em lote

Fazer uma solicitação à API envolve diversos 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 o desempenho geral, a maioria dos métodos mutáveis na API foram projetados 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 1 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. Existem 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 um desempenho 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ê quer apenas atualizar alguns campos pode resultar em mais tempo de processamento e diminuição do desempenho. Para reduzir esse problema, 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 necessários. Atualizações esparsas são processadas mais rapidamente e têm menor probabilidade de causar erros. Os campos que não estão em update_mask (também conhecido como FieldMask) não são alterados.

Por exemplo, um aplicativo que atualiza lances em nível de palavra-chave pode se beneficiar do uso de atualizações esparsas, já que somente os campos 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. Esta seção descreve considerações e estratégias para criar gerenciamento de erros no seu app. Além dessa 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 IU. Outros trabalham principalmente off-line, emitindo chamadas de API como parte de um processo periódico de back-end. Muitos aplicativos combinam os dois. Ao pensar em gerenciamento de erros, pode ser útil distinguir esses tipos diferentes 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 maior contexto possível na IU. Ofereça etapas fáceis para resolver o erro (veja as sugestões abaixo).

Para solicitações iniciadas no back-end, implemente gerenciadores 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 apropriada.

Diferenciar tipos de erro

É essencial saber as diferenças entre os tipos de erro na API Google Ads ao criar um tratamento de erros robusto. Alguns dos tipos de erros 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 erros e Erros comuns para mais detalhes.

Back-ends de sincronização

Se os usuários do seu app tiverem acesso manual às contas do Google Ads, eles poderão fazer mudanças de que o app não tem conhecimento, fazendo com que o banco de dados local do app fique fora de sincronia. Conforme observado em nosso guia de tipos de erro, é possível solucionar erros relacionados à sincronização de forma reativa quando eles ocorrerem, mas também é possível tentar evitá-los de maneira 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 a serem registradas incluem o ID de 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 nos erros de 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 automáticos.

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 fazer experimentos com a API Google Ads e verificar se a conectividade, a lógica de gerenciamento de campanhas ou outro processamento do seu aplicativo estão funcionando conforme o esperado. Seu token de desenvolvedor não precisa ser aprovado para uso em uma conta de teste. Assim, você pode começar a desenvolver com a API Google Ads imediatamente depois de solicitar um token de desenvolvedor, mesmo antes da revisão do app.