Configurar o acesso à API

Veja como configurar o acesso à API Data Manager com um SDK ou REST.

Pré-requisitos

  1. Um projeto do Google Cloud ou uma Conta do Google que você quer que seja proprietária do projeto.

    • Se você não tiver um projeto, o processo de configuração na próxima seção vai criar um para você.

    • Se você já tiver um projeto, verifique se sua Conta do Google tem um papel que possa ativar APIs no projeto, como Proprietário, Editor ou Administrador do Service Usage. Para verificar seu papel, abra a página do IAM no console do Google Cloud, selecione seu projeto e encontre sua Conta do Google na lista.

      Para mais detalhes, consulte Ver o acesso atual.

  2. A CLI do Google Cloud instalada.

Ativar a API

Se ainda não tiver feito isso, ative a API Data Manager no seu projeto na nuvem do Google Cloud clicando em Ativar a API Data Manager ou siga as instruções para realizar essa etapa manualmente.

Ativar a API Data Manager

Se você não encontrar a API Data Manager ou se a ativação da API Data Manager falhar, verifique se a Conta do Google atende aos pré-requisitos.

Configurar a autenticação

Você pode usar qualquer um dos métodos de autenticação do Google, além das chaves de API. Recomendamos que você consulte como escolher o método de autenticação certo para seu caso de uso para decidir qual abordagem é adequada para seu caso de uso.

Dois métodos comuns de autenticação são as contas de usuário e as contas de serviço:

  • Contas de usuário: representam pessoas que interagem diretamente com as APIs e os serviços do Google.
  • Contas de serviço: representam apps, não pessoas, como os usuários. Eles permitem que seus apps gerenciem a autenticação e a autorização. Por exemplo, se um app precisar acessar recursos do Google Cloud.

A integração pode usar o Application Default Credentials (ADC) para encontrar automaticamente as credenciais do ambiente, de modo que não seja necessário mudar o código do cliente para autenticação.

Escolha Conta de usuário ou Conta de serviço para configurar o ADC:

Conta de usuário

Veja as etapas para autenticar com credenciais da conta de usuário:

  1. Defina as configurações da Google Auth Platform para seu projeto.

    1. Abra a página Branding no console do Google Cloud.

    2. Selecione o projeto.

    3. Preencha o formulário e clique em Criar.

  2. Como a API Data Manager usa escopos sensíveis, as etapas a seguir são necessárias:

    1. Acesse as configurações de Acesso aos dados do seu projeto.

    2. Clique em Adicionar ou remover escopos.

    3. Na lista de escopos, encontre a API Data Manager e marque a caixa de cada escopo que seu aplicativo exige:

      • .../auth/datamanager: selecione esse escopo para operações padrão da API, como gerenciar dados do cliente, públicos-alvo e eventos. Esse é o escopo principal usado neste guia.

      • .../auth/datamanager.partnerlink: selecione esse escopo apenas se você for um parceiro de dados que cria ou exclui links de parceiros em contas de anunciantes.

    4. Clique em Atualizar.

    5. Clique em Salvar.

    6. Acesse Público no console do Google Cloud e defina as configurações para o desenvolvimento inicial:

      • Defina o Status de publicação como Teste.
      • Defina o Tipo de usuário como Interno (se o projeto estiver em uma organização do Google Workspace) ou Externo (se não estiver).
      • Se você usar Externo, adicione as Contas do Google que você usa para gerar credenciais como Usuários de teste.

      Saiba mais sobre essas configurações em Gerenciar o público-alvo do app.

  3. Clique em Criar cliente OAuth2 para criar um cliente OAuth2 no projeto ou siga as instruções para criar um cliente OAuth2 para computador. Pule esta etapa se você já tiver um cliente OAuth2 para computador que queira usar na API Data Manager.

    Se você clicar em Criar cliente OAuth2, selecione App para computador quando solicitado a Configurar seu cliente OAuth para que você possa usar o cliente nas etapas restantes.

    Criar cliente OAuth2

    Na última etapa, clique em FAZER DOWNLOAD DA CONFIGURAÇÃO DO CLIENTE e anote o local de download escolhido.

  4. Gere um arquivo local do ADC executando o comando a seguir. Esse comando inicia um fluxo da Web em que você precisa fazer login na Conta do Google que está usando com a API.

    Substitua PATH_TO_CLIENT_JSON pelo nome do arquivo JSON que você baixou.

    gcloud auth application-default login \
  --scopes="https://www.googleapis.com/auth/datamanager,https://www.googleapis.com/auth/cloud-platform" \
  --client-id-file="PATH_TO_CLIENT_JSON"

    Se você quiser usar as mesmas credenciais para a API Data Manager e a API Google Ads, inclua o escopo da API Google Ads na lista --scopes:

    gcloud auth application-default login \
  --scopes="https://www.googleapis.com/auth/datamanager,https://www.googleapis.com/auth/adwords,https://www.googleapis.com/auth/cloud-platform" \
  --client-id-file="PATH_TO_CLIENT_JSON"

    Se você quiser usar as mesmas credenciais para a API Data Manager e a API Display & Video 360, inclua o escopo da API Display & Video 360 na lista --scopes:

    gcloud auth application-default login \
  --scopes="https://www.googleapis.com/auth/datamanager,https://www.googleapis.com/auth/display-video,https://www.googleapis.com/auth/cloud-platform" \
  --client-id-file="PATH_TO_CLIENT_JSON"

  5. Confirme se as credenciais estão configuradas corretamente usando o comando a seguir. Se o comando for bem-sucedido, ele vai mostrar um token de acesso no console.

    gcloud auth application-default print-access-token

Conta de serviço

Veja as etapas para criar uma conta de serviço e usar a identidade temporária de conta de serviço para autenticar em um ambiente de desenvolvimento local. Essas etapas usam a representação em vez de chaves de conta de serviço, porque as chaves de conta de serviço podem se tornar um risco de segurança se não forem gerenciadas com cuidado.

  1. Clique no botão Criar conta de serviço abaixo ou siga as instruções para selecionar ou criar uma conta de serviço.

    Criar conta de serviço

  2. Conceda à conta de serviço o papel do IAM de Consumidor do Service Usage (roles/serviceusage.serviceUsageConsumer), que inclui a permissão serviceusage.services.use que permite que a conta de serviço envie solicitações de API para o projeto.

    gcloud projects add-iam-policy-binding PROJECT_ID \
  --member="serviceAccount:SERVICE_ACCOUNT_EMAIL" \
  --role="roles/serviceusage.serviceUsageConsumer"

  3. Conceda à sua Conta do Google o papel do IAM de Criador de token de conta de serviço (roles/iam.serviceAccountTokenCreator) na conta de serviço.

    gcloud iam service-accounts add-iam-policy-binding SERVICE_ACCOUNT_EMAIL \
  --member="user:USER_EMAIL" \
  --role="roles/iam.serviceAccountTokenCreator"

  4. Configure o ADC executando o seguinte comando:

    gcloud auth application-default login \
  --impersonate-service-account=SERVICE_ACCOUNT_EMAIL \
  --scopes="https://www.googleapis.com/auth/datamanager,https://www.googleapis.com/auth/cloud-platform"

    Se você quiser usar as mesmas credenciais para a API Data Manager e a API Google Ads, inclua o escopo da API Google Ads na lista --scopes:

    gcloud auth application-default login \
  --impersonate-service-account=SERVICE_ACCOUNT_EMAIL \
  --scopes="https://www.googleapis.com/auth/datamanager,https://www.googleapis.com/auth/adwords,https://www.googleapis.com/auth/cloud-platform"

    Se você quiser usar as mesmas credenciais para a API Data Manager e a API Display & Video 360, inclua o escopo da API Display & Video 360 na lista --scopes:

    gcloud auth application-default login \
  --impersonate-service-account=SERVICE_ACCOUNT_EMAIL \
  --scopes="https://www.googleapis.com/auth/datamanager,https://www.googleapis.com/auth/display-video,https://www.googleapis.com/auth/cloud-platform"

    Quando solicitado, faça login com sua Conta do Google que tem o papel de Criador de token da conta de serviço.

  5. Confirme se as credenciais estão configuradas corretamente usando o comando a seguir. Se for bem-sucedido, o comando vai mostrar um token de acesso no console.

    gcloud auth application-default print-access-token --scopes="https://www.googleapis.com/auth/datamanager"

Para saber mais sobre autenticação e credenciais para seu app, consulte Métodos de autenticação no Google e Como o Application Default Credentials funciona.

Configurar o acesso à conta

Conta de usuário

Selecione a guia que corresponde ao seu caso de uso.

  • Selecione Anunciante se você estiver usando as credenciais de uma Conta do Google que é um usuário nas contas de anunciante que você quer gerenciar.
  • Selecione Parceiro de dados se você estiver usando as credenciais de uma Conta do Google que é um usuário em uma conta de parceiro de dados e quiser gerenciar contas de anunciante que tenham um link de parceiro para a conta de parceiro de dados. As contas de parceiros de dados são emitidas somente após o processo de aprovação. Para começar, preencha o formulário de interesse.

Advertiser

Conceda ao e-mail associado ao usuário acesso ao Destination.

Siga as instruções para adicionar o e-mail do usuário à conta do Google Ads ou a uma conta de administrador principal do Google Ads.

Display & Video 360

Siga as instruções para adicionar o e-mail do usuário à conta.

Google Analytics

Siga as instruções para adicionar o e-mail do usuário à conta.

Parceiro de dados

Conceda ao e-mail associado ao usuário acesso à sua conta de parceiro de dados. Normalmente, os parceiros de dados usam uma conta de serviço para acessar a API. No entanto, se você usar uma conta de usuário para testes ou outras finalidades, será necessário conceder a ela acesso à conta do parceiro de dados.

Adicione o e-mail do usuário à conta do parceiro de dados na interface do Google Ads seguindo estas instruções.

Conta de serviço

Selecione a guia que corresponde ao seu caso de uso.

  • Selecione Anunciante se você estiver usando as credenciais de uma Conta do Google que é um usuário nas contas de anunciante que você quer gerenciar.
  • Selecione Parceiro de dados se você estiver usando as credenciais de uma Conta do Google que é um usuário em uma conta de parceiro de dados e quiser gerenciar contas de anunciante que tenham um link de parceiro para a conta de parceiro de dados. As contas de parceiros de dados são emitidas somente após o processo de aprovação. Para começar, preencha o formulário de interesse.

Advertiser

Conceda ao e-mail associado à sua conta de serviço acesso ao Destination.

Conclua a configuração de acesso à conta para adicionar a conta de serviço à conta do Google Ads ou a uma conta de administrador do Google Ads principal.

Display & Video 360

Siga as instruções para criar um usuário do Display & Video 360 associado à conta de serviço.

Google Analytics

Siga as instruções para adicionar o e-mail da conta de serviço à conta.

Parceiro de dados

Conceda ao e-mail associado à sua conta de serviço acesso à sua conta de parceiro de dados.

O acesso à conta do parceiro de dados é gerenciado pela interface do Google Ads. Para adicionar a conta de serviço e definir o nível de acesso dela, siga as etapas em Configuração de acesso à conta.

Próximas etapas

Avançar
Instalar uma biblioteca de cliente