Configurar o acesso à API

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

Pré-requisitos

Antes de usar a API Data, verifique se você tem o seguinte:

  1. Um projeto do Google Cloud. Você pode usar um projeto atual ou criar um novo especificamente para a API Data Manager.

  2. Uma Conta do Google que tenha a permissão serviceusage.services.enable no seu projeto na nuvem do Google Cloud ou um papel que inclua essa permissão. Por exemplo, roles/owner e roles/serviceusage.serviceUsageAdmin incluem a permissão serviceusage.services.enable. Para verificar suas permissões, consulte Ver o acesso atual.

  3. A CLI do Google Cloud instalada.

Ativar a API

Se ainda não fez isso, ative a API Data Manager clicando em Ativar a API Data Manager ou siga as instruções para realizar esta etapa manualmente.

Ativar a API Data Manager

Se você não encontrar a API Data Manager ou se a opção Ativar a API Data Manager falhar, verifique se sua 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ê analise como escolher o método de autenticação certo para seu caso de uso para decidir qual abordagem é adequada.

Dois métodos de autenticação comuns são contas de usuário e 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 usuários. Elas permitem que seus apps gerenciem a autenticação e a autorização. Por exemplo, se um app precisar acessar recursos do Google Cloud.

Sua integração pode usar Application Default Credentials (ADC) para encontrar credenciais automaticamente no ambiente, sem precisar mudar o código do cliente para autenticar.

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

Conta de usuário

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

  1. Configure as definições da plataforma Google Auth para seu projeto.

    1. Abra a página de branding no Console do Google Cloud.

    2. Selecione o projeto.

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

  2. Como o escopo da API Data Manager é um escopo sensível, as etapas a seguir são necessárias:

    1. Acesse as configurações de acesso a dados do seu projeto.

    2. Clique em Adicionar ou remover escopos.

    3. Marque a caixa ao lado de API Data Manager na lista de escopos e clique em Atualizar.

    4. Clique em Salvar.

    5. Acesse Público-alvo no Console do Google Cloud e atualize o Status de publicação e o Tipo de usuário. 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 de computador. Você pode pular esta etapa se já tiver um cliente OAuth2 de computador que queira usar para a API Data Manager.

    Se você clicar em Criar cliente OAuth2, selecione App para computador quando solicitado a Configurar o cliente OAuth para poder 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 ADC local 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ê fez download.

    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 --scopes lista:

    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 --scopes lista:

    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 tiver êxito, o comando vai imprimir um token de acesso no console.

    gcloud auth application-default print-access-token

Conta de serviço

Confira as etapas para usar a representação de conta de serviço para autenticar. Estas etapas usam a representação em vez de chaves de conta de serviço, porque as chaves de conta de serviço podem representar um risco de segurança se não forem gerenciadas com cuidado.

  1. Clique no botão Criar conta de serviço a seguir 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 de consumidor de uso de serviço do IAM (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 de criador de token da conta de serviço do IAM (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 --scopes lista:

    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 --scopes lista:

    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 a fazer login, faça login como 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 tiver êxito, o comando vai imprimir 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 do 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 credenciais de uma Conta do Google que seja um usuário nas contas de anunciante que você quer gerenciar.
  • Selecione Parceiro de dados se você estiver usando credenciais de uma Conta do Google que seja um usuário em uma conta de parceiro de dados e quiser gerenciar contas de anunciantes que tenham um link de parceiro para a conta de parceiro de dados.

Advertiser

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

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

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 o e-mail associado ao acesso do usuário à sua conta de parceiro de dados. Normalmente, os parceiros de dados usam uma conta de serviço para acesso à API. No entanto, se você usar uma conta de usuário para testes ou outros fins, conceda acesso à conta de parceiro de dados.

Adicione o e-mail do usuário à conta de parceiro de dados pela 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 credenciais de uma Conta do Google que seja um usuário nas contas de anunciante que você quer gerenciar.
  • Selecione Parceiro de dados se você estiver usando credenciais de uma Conta do Google que seja um usuário em uma conta de parceiro de dados e quiser gerenciar contas de anunciantes que tenham um link de parceiro para a conta de parceiro de dados.

Advertiser

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

Conclua a configuração do 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 o e-mail associado ao acesso da sua conta de serviço à sua conta de parceiro de dados.

O acesso à conta de 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 do acesso à conta.

Próximas etapas

Instale uma biblioteca de cliente e execute exemplos de código para testar sua primeira solicitação da API Data Manager.

Avançar
Instalar uma biblioteca de cliente