Configurar e usar o OAuth

Todas as chamadas da API Local Services precisam ser autorizadas pelo OAuth 2.0. Isso permite que o app cliente da API Local Services acesse a conta de anúncios dos Serviços Locais de um usuário sem precisar processar ou armazenar as informações de login dele.

A API Local Services usa o protocolo OAuth 2.0 para autenticar usuários. Para saber mais sobre o OAuth 2.0, consulte Como usar o OAuth 2.0 para acessar as APIs do Google.

Configurar um projeto do Console de APIs do Google para a API Local Services

Para autenticar e autorizar usuários do Google Ads, você precisa ter credenciais para acessar os servidores OAuth 2.0 do Google. Essas credenciais identificam seu aplicativo para o Google e permitem gerar tokens OAuth para gerenciar usuários do Google Ads. Use o Console de APIs do Google para gerenciar o acesso às suas credenciais do Google OAuth 2.0.

Para receber essas credenciais, siga estas etapas:

  1. Criar um projeto Para isso, acesse o Console de APIs do Google. Clique em Criar projeto, insira um nome e clique em Criar.

  2. Ative a API Local Services no seu projeto:

    1. Abra a biblioteca de APIs no Console de APIs do Google. Se necessário, selecione um projeto ou crie um novo. A biblioteca de APIs lista todas as APIs disponíveis, agrupadas por família de produtos e popularidade.

      Se a API Local Services não estiver visível na lista, use a caixa de pesquisa para encontrá-la.

    2. Selecione a API Local Services e clique em Ativar.

  3. Escolha um tipo de app. A API Local Services usa os mesmos tipos de apps da API Google Ads. Para mais detalhes sobre qual tipo de app usar, consulte Escolher um tipo de app.

  4. Crie um ID e uma chave secreta do cliente. Para a API Local Services, siga as mesmas etapas para criar um ID do cliente e um segredo do cliente usados na API Google Ads. As etapas são idênticas para os dois casos de uso.

Usar a biblioteca de cliente para receber tokens do OAuth 2.0

Para uma lista de bibliotecas de cliente que podem ser usadas para fazer solicitações de autorização do OAuth 2.0, consulte Bibliotecas de cliente. Siga as instruções específicas da biblioteca para saber como usar um token de atualização e conseguir um novo token de acesso.

Como conseguir um token de atualização do OAuth 2.0

Recomendamos que você use as bibliotecas de cliente em produção para autenticar usuários. Se você quiser usar um cliente HTTP para fins de teste, siga estas instruções para receber um token de atualização e um token de acesso do OAuth 2.0. As etapas 1, 2 e 3 são instruções de configuração única que você precisa realizar manualmente. As etapas 4 e 5 podem ser automatizadas depois para serem executadas sem intervenção humana, como um job cron.

  1. Faça o download e instale o curl, uma ferramenta de linha de comando para fazer solicitações HTTP na Web.

  2. Siga as instruções na página do OAuth Playground para conseguir um token de atualização do OAuth 2.0. Use o seguinte escopo para a API Local Services:

    https://www.googleapis.com/auth/adwords

    É o mesmo escopo do OAuth 2.0 usado pela API Google Ads.

    Ao final desta etapa, você vai receber dois tokens: um de atualização e um de acesso. Salve os dois.

  3. Execute o comando a seguir em um prompt para verificar se a etapa anterior foi concluída:

    curl https://oauth2.googleapis.com/tokeninfo?access_token=<INSERT_ACCESS_TOKEN>

    Se a saída do comando mostrar uma mensagem como esta, a operação foi bem-sucedida:

    {
  "azp": "************-********************************.apps.googleusercontent.com",
  "aud": "************-********************************.apps.googleusercontent.com",
  "scope": "https://www.googleapis.com/auth/adwords [googleapis.com]",
  "exp": "1611183382",
  "expires_in": "3482",
  "access_type": "offline"
}

    Se houver um erro ou o escopo não estiver correto, tente gerar os tokens de novo.

  4. Gerar um novo token de acesso sem intervenção manual. Isso é importante porque os tokens de acesso expiram a cada hora. Os tokens de atualização levam muito mais tempo para expirar. Por isso, muitas vezes é necessário revogá-los manualmente quando não são mais necessários.

    Para receber um novo token de acesso, execute o seguinte comando:

    curl --data "refresh_token=<INSERT_REFRESH_TOKEN>&client_id=<INSERT_CLIENT_ID>&client_secret=<INSERT_CLIENT_SECRET>&grant_type=refresh_token" -X POST "https://oauth2.googleapis.com/token”

  5. Execute a seguinte chamada de API:

    curl -H "Authorization: Bearer <INSERT_ACCESS_TOKEN>" https://localservices.googleapis.com/v1/accountReports:search?query=manager_customer_id:<INSERT_10_DIGIT_MANAGER_CUSTOMER_ID_WITHOUT_HYPHENS>

    Se a chamada for bem-sucedida, a configuração estará concluída.