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 seu 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 se informar sobre problemas como alterações de produtos, tempo de inatividade por manutenções, datas de descontinuação etc.,

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

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

Otimização

Operações em lote

Fazer uma solicitação à API acarreta 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 o desempenho geral, a maioria dos métodos mutate na API é projetada para aceitar uma série 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 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, pode ser 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 amenizar esse problema, a API Google Ads é compatível com atualizações avulsas. Assim, você pode preencher apenas os campos em um objeto que precisa mudar ou que são obrigatórios. Atualizações esparsas são processadas mais rapidamente e têm menos probabilidade de produzir erros. Os campos que não estiverem na 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, porque somente 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 as considerações e estratégias para criar o gerenciamento de erros no seu app. Além desta seção, visite o Guia de solução de problemas para mais informações sobre o gerenciamento de erros.

Diferenciar origens de solicitação

Alguns apps são principalmente interativos e emitem chamadas de API diretamente em resposta a ações iniciadas pelo usuário em uma interface. Outras trabalham principalmente off-line, emitindo chamadas de API como parte de um processo periódico de back-end. Muitos aplicativos combinam os dois. Ao considerar o 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 possam seguir para resolver o erro (confira as sugestões abaixo).

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 solucionar erros raros ou não 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 solução adequada.

Diferenciar tipos de erro

Conhecer as diferenças entre os tipos de erro da API Google Ads é essencial para criar uma solução eficiente de erros. 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.

Sincronizar back-ends

Se os usuários do seu app têm acesso manual às contas do Google Ads, eles podem fazer mudanças que seu app não reconhece, 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 ocorrem, mas você também pode tentar evitá-los proativamente. 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 ID de cliente, serviço de API, latência de solicitação de ida e volta, número de novas tentativas e solicitação e resposta brutas.

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

Desenvolvimento

Use contas de teste

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, a lógica de gerenciamento de campanhas ou outros processamentos do seu aplicativo 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 depois de solicitar um token de desenvolvedor, mesmo antes da revisão do seu aplicativo.