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 na Central de API atualizado. 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 por 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 é o lugar ideal para fazer 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 conformidade e análise de tokens entrará em contato com você usando seu e-mail de contato. 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 que você recebeu durante a análise da sua solicitação de 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 são projetados para aceitar uma variedade 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 cada. Como há limites para o número de operações permitidas em uma solicitação, pode ser necessário ajustar o tamanho do lote para atingir o desempenho ideal.
Enviar objetos escassos
Quando os objetos são enviados à 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 mais tempo de processamento e desempenho reduzido.
Para minimizar isso, a Google Ads API é compatível com atualizações escassas, permitindo que você preencha apenas os campos em um objeto que precisa alterar 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 em update_mask (também conhecidos como FieldMask) não são alterados.
Por exemplo, um aplicativo 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. Esta seção descreve considerações e estratégias para criar o gerenciamento de erros no seu 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 funcionam principalmente off-line, emitindo chamadas de API como parte de um processo periódico de back-end. 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 fáceis para resolver o erro (confira as sugestões abaixo).
Para solicitações iniciadas no back-end, implemente gerenciadores para os diferentes tipos de erro que seu app pode encontrar. Sempre inclua um gerenciador padrão para resolver 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 resolução adequada.
Diferenciar tipos de erro
Conhecer as diferenças entre os tipos de erro na Google Ads API é crucial para criar um tratamento eficiente de erros. Alguns dos tipos de erro mais comuns são:
- Erros de autenticação
- Erros que permitem uma nova tentativa
- Erros de validação
- 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 têm acesso manual às contas do Google Ads, eles podem fazer mudanças que seu app não tem conhecimento. Isso faz 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 maneira reativa quando eles ocorrem, mas você também pode 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 ID do cliente, serviço da API, latência da solicitação de ida e volta, número de novas tentativas, solicitação e resposta brutas.
Monitorar tendências
Monitore as tendências nos erros da API para detectar e resolver problemas no 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. Use uma conta de teste para testar 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 ser usado em uma conta de teste. Portanto, você pode começar a desenvolver com a Google Ads API imediatamente depois de solicitar um token de desenvolvedor, mesmo antes de seu aplicativo ser revisado.