Configurar o acesso à API

Confira 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 com 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 tiver feito isso, ative a API Data Manager 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 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 no Google, além das chaves de API. Recomendamos que você revise como Escolher o método de autenticação certo para seu caso de uso e decida qual abordagem é adequada para seu caso de uso.

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 o Application Default Credentials (ADC) para encontrar automaticamente as credenciais do ambiente. Assim, não é necessário 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

Estas são as etapas para autenticar com credenciais da conta de usuário:

  1. Configure as configurações da plataforma de autenticação do Google 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 é 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 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 com a API Data Manager.

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

    Criar cliente OAuth2

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

  4. Gere um arquivo ADC local executando o seguinte comando. 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 seguinte comando. Se o comando for bem-sucedido, ele 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 uma conta de serviço para autenticar. Essas etapas usam a representação em vez de chaves de conta de serviço porque elas podem representar um risco de segurança se não forem gerenciadas com cuidado.

  1. Clique no botão Criar conta de serviço 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 Service Usage Consumer (roles/serviceusage.serviceUsageConsumer), que inclui a permissão serviceusage.services.use que permite à conta de serviço enviar 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 da 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 Criador de token da conta de serviço.

  5. Confirme se as credenciais estão configuradas corretamente usando o seguinte comando. Se a operação for bem-sucedida, 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 funcionam as Application Default Credentials.

Configurar o acesso à conta

Conta de usuário

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

  • Se você estiver usando uma conta do Google Ads, 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.
  • Se você estiver usando uma conta do Display & Video 360, siga as instruções para adicionar o e-mail do usuário à conta.
  • Se você estiver usando uma propriedade do Google Analytics, siga as instruções para adicionar o e-mail do usuário à conta.
  • Se você estiver acessando o Destination usando uma conta de parceiro de dados com um link de parceiro da conta do anunciante, siga as instruções para adicionar o e-mail do usuário à conta de parceiro de dados.

Conta de serviço

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

  • Se você estiver usando uma conta do Google Ads, conclua a configuração de acesso à conta para adicionar a conta de serviço à conta do Google Ads ou a uma conta de administrador principal do Google Ads.
  • Se você estiver usando uma conta do Display & Video 360, siga as instruções para criar um usuário do Display & Video 360 associado à conta de serviço.
  • Se você estiver usando uma propriedade do Google Analytics, siga as instruções para adicionar o e-mail do usuário à conta.
  • Se você estiver acessando o Destination usando uma conta de parceiro de dados com um link de parceiro da conta de anunciante, conclua a Configuração de acesso à conta na conta de parceiro de dados para adicionar a conta de serviço e definir o nível de acesso dela.

Próximas etapas

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

Avançar
Instalar uma biblioteca de cliente