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;
  2. Uma Conta do Google com a permissão serviceusage.services.enable no seu projeto 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 acesso atual.

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 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ê consulte Escolher o método de autenticação certo para seu caso de uso e decida qual abordagem é adequada para você.

Dois métodos comuns de autenticação 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. Eles permitem que seus aplicativos gerenciem a autenticação e a autorização. Por exemplo, se um aplicativo 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 Representação de conta de serviço para configurar o ADC:

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 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 do Gerenciador de Dados é um escopo sensível a , as seguintes etapas 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 Data Manager API na lista de escopos e clique em Atualizar.

    4. Clique em Salvar.

    5. Acesse Público 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 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 Desktop.

    Criar cliente OAuth2

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

  4. Gere um arquivo ADC local executando o seguinte comando. Este comando inicia um fluxo web onde você será solicitado a 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"
    
  5. Confirme se as credenciais estão configuradas corretamente usando o seguinte comando. Se bem-sucedido, o comando imprime um token de acesso no console.

    gcloud auth application-default print-access-token
    

Para saber mais sobre autenticação e credenciais do seu app, consulte Métodos de autenticação no Google e Como as credenciais padrão do aplicativo funcionam.

Configurar o acesso à conta operacional

Conceda ao e-mail associado à sua conta de usuário acesso ao Destination.

  • Se você estiver usando uma conta do Google Ads ou de parceiro de dados, siga as instruções para adicionar o e-mail do usuário à conta.
  • Se você estiver usando uma conta do Display & Video 360, siga as instruções para adicionar o e-mail do usuário à conta.

Configure o SDK para sua linguagem de programação.

Na sua máquina local, instale o SDK de sua escolha:

REST

  1. Atualize os marcadores de posição no exemplo a seguir, como OPERATING_ACCOUNT_PRODUCT, OPERATING_ACCOUNT_ID e AUDIENCE_ID, com os valores da sua conta e destino.
  2. Substitua PROJECT_ID pelo ID da sua conta do Google Cloud.
  3. Copie o exemplo para a linha de comando para enviar a solicitação.

    Remova o atributo linkedAccount da entrada no destinations se você não estiver acessando o operatingAccount usando um link de produto estabelecido.

    #!/bin/bash
    
    # Uses gcloud to get an access token. If the Application Default
    # Credentials aren't for a service account, the command that specifies
    # --scopes fails. This sample falls back to the command without the
    # --scopes argument.
    DATA_MANAGER_ACCESS_TOKEN="$(gcloud auth application-default print-access-token --scopes=https://www.googleapis.com/auth/datamanager || \
      gcloud auth application-default print-access-token)"
    
    # Fetches and prints the scope information for the access token. If you
    # get scope-related errors when you send the request in the next step,
    # verify that this output includes the Data Manager API scope:
    #   https://www.googleapis.com/auth/datamanager
    curl https://www.googleapis.com/oauth2/v1/tokeninfo?access_token="${DATA_MANAGER_ACCESS_TOKEN}"
    
    # Sends the request.
    curl -X POST "https://datamanager.googleapis.com/v1/audienceMembers:ingest" \
      --header "Authorization: Bearer ${DATA_MANAGER_ACCESS_TOKEN}" \
      --header "x-goog-user-project: PROJECT_ID" \
      --header "Content-Type: application/json" \
      --data @- <<EOF
    {
      "destinations": [
        {
          "operatingAccount": {
            "accountType": "OPERATING_ACCOUNT_TYPE",
            "accountId": "OPERATING_ACCOUNT_ID"
          },
          "loginAccount": {
            "accountType": "LOGIN_ACCOUNT_TYPE",
            "accountId": "LOGIN_ACCOUNT_ID"
          },
          "linkedAccount": {
            "accountType": "LINKED_ACCOUNT_TYPE",
            "accountId": "LINKED_ACCOUNT_ID"
          },
          "productDestinationId": "AUDIENCE_ID"
        }
      ],
      "audienceMembers": [
        {
          "userData": {
            "userIdentifiers": [
              {
                "emailAddress": "07e2f1394b0ea80e2adca010ea8318df697001a005ba7452720edda4b0ce57b3"
              },
              {
                "emailAddress": "1df6b43bc68dd38eca94e6a65b4f466ae537b796c81a526918b40ac4a7b906c7"
              }
            ]
          }
        },
        {
          "userData": {
            "userIdentifiers": [
              {
                "emailAddress": "2ef46c4214c3fc1b277a2d976d55194e12b899aa50d721f28da858c7689756e3"
              },
              {
                "emailAddress": "54e410b14fa652a4b49b43aff6eaf92ad680d4d1e5e62ed71b86cd3188385a51"
              },
              {
                "emailAddress": "e8bd3f8da6f5af73bec1ab3fbf7beb47482c4766dfdfc94e6bd89e359c139478"
              }
            ]
          }
        },
        {
          "userData": {
            "userIdentifiers": [
              {
                "emailAddress": "05bb62526f091b45d20e243d194766cca8869137421047dc53fa4876d111a6f0"
              },
              {
                "emailAddress": "f1fcde379f31f4d446b76ee8f34860eca2288adc6b6d6c0fdc56d9eee75a2fa5"
              }
            ]
          }
        },
        {
          "userData": {
            "userIdentifiers": [
              {
                "emailAddress": "83a834cc5327bc4dee7c5408988040dc5813c7662611cd93b707aff72bf7d33f"
              },
              {
                "emailAddress": "223ebda6f6889b1494551ba902d9d381daf2f642bae055888e96343d53e9f9c4"
              }
            ]
          }
        }
      ],
      "consent": {
        "adUserData": "CONSENT_GRANTED",
        "adPersonalization": "CONSENT_GRANTED"
      },
      "encoding": "HEX",
      "termsOfService": {
        "customerMatchTermsOfServiceStatus": "ACCEPTED"
      },
      "validateOnly": true
    }
    EOF
    

.NET

Instale a biblioteca de cliente

Siga as instruções no guia de instalação da biblioteca cliente .NET para adicionar uma dependência à biblioteca cliente em seu projeto.

Opcional: Obtenha a biblioteca de utilitários e exemplos de código.

  1. Baixe e extraia data-manager-dotnet.tar.gz.

  2. No seu projeto .NET, declare uma dependência ProjectReference na biblioteca de utilitários. Substitua PATH_TO_UTILITY_LIBRARY pelo local onde você extraiu o diretório data-manager-dotnet de data-manager-dotnet.tar.gz.

    <ProjectReference Include="PATH_TO_UTILITY_LIBRARY\Google.Ads.DataManager.Util\src\Google.Ads.DataManager.Util.csproj" />
    
  3. Para formatar dados, use o utilitário Formatter no seu projeto do .NET.

  4. Procure exemplos de código no subdiretório samples.

    Mude para o diretório samples e use dotnet run para receber a lista de exemplos disponíveis.

    dotnet run
    

    Transmita o argumento --help ao executar uma amostra para imprimir uma instrução de uso com os parâmetros esperados.

    dotnet run -- ingest-audience-members --help
    

    Para começar com alguns dados de amostra, use o arquivo em samples/sampledata/audience_members_1.csv.

Java

Instale a biblioteca de cliente

  1. Baixe e extraia google-cloud-ads-datamanager-v1-java.tar.gz.
  2. Navegue até o diretório google-cloud-ads-datamanager-v1-java.
  3. Execute o comando a seguir para criar e publicar a biblioteca no repositório Maven local para uso com Maven ou Gradle.

    ./gradlew install
    
  4. No seu projeto Java, declare uma dependência da biblioteca Data Manager API.

    Gradle:

    implementation 'com.google.cloud:gapic-google-cloud-ads-datamanager-v1-java:0.1.4'
    

    Maven:

    <dependency>
      <groupId>com.google.cloud</groupId>
      <artifactId>gapic-google-cloud-ads-datamanager-v1-java</artifactId>
      <version>0.1.4</version>
    </dependency>
    

Opcional: acesse a biblioteca de utilitários e os exemplos de código.

  1. Clone o repositório GitHub.

    git clone https://github.com/googleads/data-manager-java.git
    
  2. Navegue até o diretório data-manager-java.

  3. Crie e publique a biblioteca de utilitários no seu repositório Maven local.

    ./gradlew data-manager-util:install
    
  4. No seu projeto Java, declare uma dependência da biblioteca de utilitários.

    Gradle:

    implementation 'com.google.api-ads:data-manager-util:0.1.0'
    

    Maven:

    <dependency>
       <groupId>com.google.api-ads</groupId>
       <artifactId>data-manager-util</artifactId>
       <version>0.1.0</version>
    </dependency>
    
  5. Para formatar e criptografar os dados, use os utilitários UserDataFormatter e Encrypter em seu projeto Java.

  6. Navegue pelos exemplos de código no subdiretório data-manager-samples ou no GitHub. Para executar uma amostra na linha de comando, use a tarefa run do Gradle.

    Por exemplo, o comando a seguir executa a amostra IngestAudienceMembers e imprime uma declaração de uso:

    ./gradlew data-manager-samples:run \
       --args='IngestAudienceMembers --help'
    

    Para ajudar você a começar com alguns dados de exemplo, use o arquivo emdata-manager-samples/src/main/resources/sampledata/audience_members_1.csv.

Node.js

Instale a biblioteca de cliente

  1. Baixe e extraia ads-datamanager-v1-nodejs.tar.gz.
  2. Navegue até o diretório ads-datamanager-v1-nodejs.
  3. Execute o seguinte comando para compilar e empacotar a biblioteca do cliente em um arquivo .tgz para uso com npm.

    npm pack
    

    O comando gera um arquivo chamado google-cloud-datamanager-0.1.4.tgz. Anote a localização do arquivo para que você possa usá-la nas próximas etapas.

  4. No seu projeto Node.js, declare uma dependência da biblioteca cliente da API Data Manager adicionando uma entrada dependencies para o caminho completo e o nome do arquivo google-cloud-datamanager-0.1.4.tgz.

    {
       "dependencies": {
          ...
          "@google-cloud/datamanager": "file:PATH_TO_CLIENT_LIBRARY/google-cloud-datamanager-0.1.4.tgz",
          ...
       }
    }
    

Opcional: Obtenha a biblioteca de utilitários e exemplos de código.

  1. Baixe e extraia data-manager-node.tar.gz.
  2. Navegue até o diretório data-manager-node.
  3. Altere para o diretório util.

    cd util
    
  4. Execute o seguinte comando para compilar e empacotar a biblioteca de utilitários em um arquivo .tgz para uso com npm.

    npm pack
    

    O comando gera um arquivo chamado google-ads-datamanager-util-0.1.0.tgz. Anote a localização do arquivo para que você possa usá-la nas próximas etapas.

  5. No seu projeto Node.js, declare uma dependência na biblioteca utilitária da API Data Manager adicionando uma entrada dependencies para o caminho completo e o nome do arquivo google-ads-datamanager-util-0.1.0.tgz.

    {
       "dependencies": {
          ...
          "@google-ads/data-manager-util": "file:PATH_TO_UTILITY_LIBRARY/google-ads-datamanager-util-0.1.0.tgz",
          ...
       }
    }
    

    Para formatar dados, use a utilidade UserDataFormatter no projeto Node.js.

  6. Procure exemplos de código no subdiretório samples. Execute os exemplos seguindo os passos abaixo:

    1. Copie o google-cloud-datamanager-0.1.4.tgz para o diretório pai do diretório data-manager-node.

    2. Navegue até o diretório samples em data-manager-node.

    3. Execute o seguinte comando para compilar os exemplos.

      npm run compile
      
    4. Execute os exemplos, passando todos os argumentos necessários. Ao executar um exemplo, passe o argumento --help para imprimir uma declaração de uso com os parâmetros esperados.

      Por exemplo, o seguinte comando executa o exemplo ingest_audience_members e imprime uma declaração de uso:

      npx ts-node audiences/ingest_audience_members.ts --help
      

    Para começar com alguns dados de amostra, use o arquivo em samples/sampledata/audience_members_1.csv.

PHP

Instale a biblioteca de cliente

  1. Baixe e extraia google-cloud-ads-datamanager-v1-php.tar.gz.
  2. Navegue até o diretório google-cloud-ads-datamanager-v1-php.
  3. Execute o seguinte comando para resolver as dependências da biblioteca:

    composer update --prefer-dist
    
  4. No arquivo composer.json do seu projeto PHP no mesmo host, declare uma dependência da biblioteca Data Manager API seguindo os passos abaixo:

    1. Adicione uma seção repositories que aponte para a localização do diretório google-cloud-ads-datamanager-v1-php.

      "repositories" : [
         {
            "type" : "path",
            "url" : "PATH_TO_CLIENT_LIBRARY"
         }
      ]
      
    2. Declare uma dependência da biblioteca da API do Gerenciador de Dados.

      "require": {
         "googleads/data-manager": "0.1.4"
      }
      

Opcional: Obtenha a biblioteca de utilitários e exemplos de código.

  1. Baixe e extraia data-manager-php.tar.gz.
  2. Navegue até o diretório data-manager-php.
  3. Execute o seguinte comando para resolver as dependências da biblioteca:

    composer update --prefer-dist
    
  4. No arquivo composer.json do seu projeto PHP no mesmo host, declare uma dependência da biblioteca de utilitários seguindo os passos abaixo:

    1. Adicione uma entrada na seção repositories que aponte para a localização do diretório data-manager-php.

      "repositories" : [
         {
            "type" : "path",
            "url" : "PATH_TO_UTILITY_LIBRARY"
         }
      ]
      
    2. Declare uma dependência da biblioteca de utilitários.

      "require": {
         "googleads/data-manager-util": "@dev"
      }
      

    Para formatar dados, use o utilitário Formatter em seu projeto PHP.

  5. Navegue pelos exemplos de código no subdiretório samples. Execute os exemplos seguindo os passos abaixo:

    1. Navegue até o diretório samples.

    2. Defina a variável de ambiente DATA_MANAGER_PHP_LIB para o caminho onde você extraiu a biblioteca do cliente.

      export DATA_MANAGER_PHP_LIB="PATH_TO_CLIENT_LIBRARY"
      
    3. Execute o comando a seguir para resolver as dependências da biblioteca:

      composer update --prefer-dist
      
    4. Execute as amostras, transmitindo os argumentos necessários. Transmita o argumento --help ao executar uma amostra para imprimir uma instrução de uso com os parâmetros esperados.

    Para ajudar você a começar com alguns dados de exemplo, use o arquivo emsamples/sampledata/audience_members_1.csv.

Python

Instale a biblioteca de cliente

Siga as instruções emGuia de instalação da biblioteca cliente Python para adicionar uma dependência aogoogle-ads-datamanager Biblioteca cliente em seu projeto.

Opcional: Obtenha a biblioteca de utilitários e exemplos de código.

  1. Baixe e extraia data-manager-python.tar.gz.
  2. Navegue até o diretório data-manager-python.
  3. Para instalar a biblioteca de utilitários em seu ambiente Python, execute o seguinte comando:

    pip install .
    
  4. No seu projeto Python, declare uma dependência da biblioteca de utilitários. Por exemplo, se estiver usando um arquivo requirements.txt em seu projeto, adicione a seguinte linha ao arquivo:

    google-ads-data-manager-util=0.2.0
    
  5. Para formatar e criptografar os dados, use os utilitários Formatter e Encrypter no seu projeto Python.

  6. Navegue pelos exemplos de código no subdiretório samples. Para executar exemplos, instale as dependências necessárias:

    pip install .[samples]
    

    Ao executar um exemplo, passe o argumento --help para imprimir uma declaração de uso com os parâmetros esperados.

    Para ajudar você a começar com alguns dados de exemplo, use o arquivo emsamples/sampledata/audience_members_1.csv.

Ruby

Instale a biblioteca de cliente

Siga as instruções no guia de instalação da biblioteca de cliente Ruby para adicionar uma dependência a ela no seu projeto.

Próximas etapas