Configurar o acesso à API

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

Configurar a interface de linha de comando do Google Cloud

  1. Instale e inicialize a interface de linha de comando do Google Cloud.
  2. Para garantir que os componentes gcloud estejam atualizados, execute o comando a seguir.

    gcloud components update
    
  3. (Opcional) Use o comando gcloud config set para definir um projeto e uma região padrão.

Configurar a autenticação

É possível fazer a autenticação com 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 os usuários. Elas permitem que seus apps gerenciem a autenticação e a autorização. Por exemplo, se um app precisa acessar recursos do Google Cloud.

Sua integração pode usar o Application Default Credentials (ADC) para encontrar credenciais do ambiente automaticamente. 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:

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

Configurar o acesso à conta de operação

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

Configurar o SDK para sua linguagem de programação

Na máquina local, instale o SDK de sua preferência:

REST

  1. Atualize os marcadores no exemplo a seguir, como OPERATING_ACCOUNT_PRODUCT, OPERATING_ACCOUNT_ID e AUDIENCE_ID, com os valores da sua conta e do destino.
  2. Substitua PROJECT_ID pelo ID 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 operationAccount usando um link de produto estabelecido.

    #!/bin/bash
    curl -X POST "https://datamanager.googleapis.com/v1/audienceMembers:ingest" \
      --header "Authorization: Bearer $(gcloud auth application-default print-access-token --scopes=https://www.googleapis.com/auth/datamanager)" \
      --header "x-goog-user-project: PROJECT_ID" \
      --header "Content-Type: application/json" \
      --data @- <<EOF
    {
      "destinations": [
        {
          "operatingAccount": {
            "product": "OPERATING_ACCOUNT_PRODUCT",
            "accountId": "OPERATING_ACCOUNT_ID"
          },
          "loginAccount": {
            "product": "LOGIN_ACCOUNT_PRODUCT",
            "accountId": "LOGIN_ACCOUNT_ID"
          },
          "linkedAccount": {
            "product": "LINKED_ACCOUNT_PRODUCT",
            "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
    

Java

  1. Faça o download 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 abaixo para criar e publicar a biblioteca no repositório local do Maven para uso com o Maven ou o Gradle.

    ./gradlew -Pversion=0.1.0 install
    
  4. No projeto Java, declare uma dependência na biblioteca da API Data Manager.

    Gradle:

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

    Maven:

    <dependency>
      <groupId>com.google.cloud</groupId>
      <artifactId>gapic-google-cloud-ads-datamanager-v1-java</artifactId>
      <version>0.1.0</version>
    </dependency>
    
  5. Opcional. Acesse a biblioteca de utilitários e os exemplos de código.

    1. Faça o download e extraia data-manager-java.tar.gz.
    2. Navegue até o diretório data-manager-java.
    3. Para Maven ou Gradle, execute o seguinte comando. Esse comando cria e publica a biblioteca de utilitários no repositório Maven local.

      ./gradlew data-manager-util:install
      
    4. No projeto Java, declare uma dependência na 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 no projeto Java.

    6. Procure exemplos de código no subdiretório data-manager-samples. Para executar um exemplo na linha de comando, use a tarefa run do Gradle.

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

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

      Para começar com alguns dados de amostra, use o arquivo em data-manager-samples/src/main/resources/sampledata/audience_members_1.csv.

Python

  1. Faça o download de ads-datamanager-v1-py.tar.gz.
  2. Navegue até o diretório do download.
  3. Execute o comando abaixo para criar a biblioteca e disponibilizá-la para outros projetos no mesmo ambiente Python:

    pip install ./ads-datamanager-v1-py.tar.gz
    
  4. No projeto Python, declare uma dependência na biblioteca da API Data Manager. Por exemplo, se você estiver usando um arquivo requirements.txt no projeto, adicione a seguinte linha ao arquivo:

    google-ads-data-manager=0.1.0
    
  5. Opcional. Acesse a biblioteca de utilitários e os exemplos de código.

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

      pip install .
      
    4. No projeto Python, declare uma dependência na biblioteca de utilitários. Por exemplo, se você usar um arquivo requirements.txt no projeto, adicione a seguinte linha ao arquivo:

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

    6. Procure exemplos de código no subdiretório samples. Transmita o argumento --help ao executar uma amostra para imprimir uma declaração de uso com os parâmetros esperados.

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

Node.js

  1. Faça o download e extraia ads-datamanager-v1-nodejs.tar.gz.
  2. Navegue até o diretório ads-datamanager-v1-nodejs.
  3. Execute os comandos abaixo para compilar e empacotar a biblioteca em um arquivo .tgz para uso com npm.

    npm install
    npm pack
    

    Os comandos geram um arquivo chamado google-cloud-datamanager-0.1.0.tgz.

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

PHP

  1. Faça o download 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 comando a seguir para resolver as dependências da biblioteca:

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

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

     "repositories" : [
        {
           "type" : "path",
           "url" : "PATH_TO_LIBRARY"
        }
     ]
    

    b. Declare uma dependência na biblioteca da API Data Manager.

     "require": {
        "googleads/data-manager": "^0.1.0"
     }