Seu primeiro app: pré-requisitos

Antes de começar a programar seu primeiro aplicativo cliente, é necessário realizar algumas ações, caso ainda não tenha feito.

Criar uma Conta do Google e receber permissões do Search Ads 360

Para usar a API Search Ads 360, você precisa de uma Conta do Google e permissões apropriadas concedidas a essa conta no Search Ads 360:

  1. Se você ainda não tem uma Conta do Google, crie uma.

  2. Peça que um gerente de agência do Search Ads 360 crie um usuário para sua Conta do Google.

    Para fazer o download dos relatórios, você precisa ter permissão de visualização para os anunciantes com que trabalha.

    Para adicionar ou editar conversões, você precisará de permissão de edição para os anunciantes com quem trabalhará. Em uma configuração compartilhada do Floodlight, é preciso ter permissão para edição de cada anunciante filho em que você quer fazer o upload de conversões. Não é preciso acessar o anunciante pai nem os anunciantes filhos de que você não está fazendo upload de conversões. Se você usar IDs de clique para atribuir conversões a visitas, verifique se tem acesso para editar o anunciante que gerou o ID de clique. Se você especificar um ID de clique de um anunciante a que não tem acesso para edição, a solicitação não será bem-sucedida.

    O gerente de agência pode configurar sua conta como um Usuário de anunciante com acesso a anunciantes específicos ou configurar sua conta com um nível de acesso mais alto, como Usuário de agência, com acesso a todos os anunciantes da agência.

Ativar o serviço de conversão de API

Se você quiser fazer o upload de dados sobre as conversões, um usuário do Search Ads 360 com privilégios de Gerente de agência precisará fazer login na IU da ferramenta e ativar o serviço de conversão da API. Consulte a Central de Ajuda do Search Ads 360 para mais instruções.

Criar um projeto do Console de APIs do Google e credenciais do OAuth para seu cliente

  1. Inicie a ferramenta de configuração do Console de APIs do Google.
    A ferramenta de configuração ajudará você a criar um projeto (ou usar um projeto atual), ativar a API Search Ads 360 e criar credenciais do OAuth 2.0.
  2. Na página Registrar o aplicativo, selecione um projeto ou escolha Criar um projeto. Em seguida, clique em Continuar.
  3. Depois que o Console de APIs do Google ativar a API Search Ads 360, clique no botão Acessar credenciais.
  4. Na página Criar credenciais, digite as seguintes informações:
    • Qual API você está usando?: Search Ads 360 API
    • Quais dados você vai acessar? Dados do usuário
  5. Clique no botão Próxima.

    A ferramenta de configuração agora oferece ajuda para criar um ID do cliente OAuth 2.0.

  6. Siga o restante das etapas na ferramenta de configuração.

Instale o sa360Api.py

O Search Ads 360 fornece um script utilitário para facilitar o processo de configuração da autorização. Também é possível usar esse script para enviar e receber dados no formato JSON, caso você queira enviar e receber dados antes de projetar e gravar um aplicativo completo. É possível copiar muitos dos exemplos JSON neste site de documentação e inseri-los diretamente no script.

Para instalar o script, siga estas etapas:

  1. Instale o Python 2.7.
    O script não funciona com o Python 3.x.
  2. Instale o cURL.
  3. Faça o download de sa360Api.zip.
  4. Extrair sa360Api.py de sa360Api.zip.
  5. Torne o sa360Api.py executável.

Conhecer os fundamentos de REST

Há duas maneiras de chamar a API:

Se você decidir não usar bibliotecas de cliente, precisará entender os princípios básicos da REST.

REST é um estilo de arquitetura de software que fornece uma abordagem conveniente e consistente para solicitar e modificar dados.

O termo REST é a sigla de "Representational State Transfer". No contexto das APIs do Google, ele se refere ao uso de verbos HTTP para recuperar e modificar representações de dados armazenados pelo Google.

Em um sistema RESTful, os recursos são mantidos em um armazenamento de dados. Um cliente envia uma solicitação para que uma ação específica seja executada no servidor, como a criação, recuperação, atualização ou exclusão de um recurso. Essa ação é executada e uma resposta é enviada, geralmente no formato de uma representação do recurso especificado.

Nas APIs RESTful do Google, o cliente especifica uma ação usando um verbo HTTP, como POST, GET, PUT ou DELETE. Ele especifica um recurso por um URI globalmente exclusivo no seguinte formato:

https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters

Como todos os recursos da API têm URIs exclusivos acessíveis por HTTP, a REST permite o armazenamento em cache dos dados e é otimizada para funcionar na infraestrutura distribuída da Web.

As definições de método (em inglês) encontradas na documentação dos padrões HTTP 1.1 podem ser úteis. Nelas estão incluídas as especificações GET, POST, PUT e DELETE.

REST na API Search Ads 360

As operações da API Search Ads 360 são mapeadas diretamente para os verbos HTTP REST.

O formato específico dos URIs da API Search Ads 360 é:

https://www.googleapis.com/doubleclicksearch/v2/resourcePath?parameters

O conjunto completo de URIs usados em cada operação aceita na API é resumido na Referência da API.

Conhecer os fundamentos do JSON

Se você usar REST, precisará usar o formato JSON para os corpos de solicitação. Você pode especificar que as respostas estejam no formato JSON ou CSV.

JSON (JavaScript Object Notation) é um formato de dados comum e independente de linguagem que oferece uma representação de texto simples das estruturas de dados arbitrárias. Para mais informações, acesse json.org (em inglês).