Instalar uma biblioteca de cliente

Saiba como instalar e configurar uma biblioteca de cliente ou REST.

Pré-requisitos

Antes de instalar uma biblioteca de cliente, conclua as etapas em Configurar o acesso à API, incluindo a configuração das Application Default Credentials (ADC).

Etapas da instalação

Na máquina local, instale a biblioteca de cliente de sua escolha:

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 destino.
  2. Substitua PROJECT_ID pelo ID do Google Cloud.
  3. Copie o exemplo para a linha de comando e envie a solicitação. Use apenas o exemplo de parceiro de dados se estiver acessando a conta operacional por um link de parceiro. Caso contrário, use o exemplo Anunciante.

    Advertiser

    #!/bin/bash
    
    # Uses gcloud to get an access token. If the Application Default
    # Credentials aren't for a service account then the command that
    # specifies --scopes fails, so 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"
          },
          "productDestinationId": "AUDIENCE_ID"
        }
      ],
      "audienceMembers": [
        {
          "compositeData": {
            "userData": {
              "userIdentifiers": [
                {
                  "emailAddress": "07e2f1394b0ea80e2adca010ea8318df697001a005ba7452720edda4b0ce57b3"
                },
                {
                  "emailAddress": "1df6b43bc68dd38eca94e6a65b4f466ae537b796c81a526918b40ac4a7b906c7"
                }
              ]
            }
          }
        },
        {
          "compositeData": {
            "userData": {
              "userIdentifiers": [
                {
                  "emailAddress": "2ef46c4214c3fc1b277a2d976d55194e12b899aa50d721f28da858c7689756e3"
                },
                {
                  "emailAddress": "54e410b14fa652a4b49b43aff6eaf92ad680d4d1e5e62ed71b86cd3188385a51"
                },
                {
                  "emailAddress": "e8bd3f8da6f5af73bec1ab3fbf7beb47482c4766dfdfc94e6bd89e359c139478"
                }
              ]
            }
          }
        },
        {
          "compositeData": {
            "userData": {
              "userIdentifiers": [
                {
                  "emailAddress": "05bb62526f091b45d20e243d194766cca8869137421047dc53fa4876d111a6f0"
                },
                {
                  "emailAddress": "f1fcde379f31f4d446b76ee8f34860eca2288adc6b6d6c0fdc56d9eee75a2fa5"
                }
              ]
            }
          }
        },
        {
          "compositeData": {
            "userData": {
              "userIdentifiers": [
                {
                  "emailAddress": "83a834cc5327bc4dee7c5408988040dc5813c7662611cd93b707aff72bf7d33f"
                },
                {
                  "emailAddress": "223ebda6f6889b1494551ba902d9d381daf2f642bae055888e96343d53e9f9c4"
                }
              ]
            }
          }
        }
      ],
      "consent": {
        "adUserData": "CONSENT_GRANTED",
        "adPersonalization": "CONSENT_GRANTED"
      },
      "encoding": "HEX",
      "termsOfService": {
        "customerMatchTermsOfServiceStatus": "ACCEPTED"
      },
      "validateOnly": true
    }
    EOF
    

    Parceiro de dados

    #!/bin/bash
    
    # Uses gcloud to get an access token. If the Application Default
    # Credentials aren't for a service account then the command that
    # specifies --scopes fails, so 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": [
        {
          "compositeData": {
            "userData": {
              "userIdentifiers": [
                {
                  "emailAddress": "07e2f1394b0ea80e2adca010ea8318df697001a005ba7452720edda4b0ce57b3"
                },
                {
                  "emailAddress": "1df6b43bc68dd38eca94e6a65b4f466ae537b796c81a526918b40ac4a7b906c7"
                }
              ]
            }
          }
        },
        {
          "compositeData": {
            "userData": {
              "userIdentifiers": [
                {
                  "emailAddress": "2ef46c4214c3fc1b277a2d976d55194e12b899aa50d721f28da858c7689756e3"
                },
                {
                  "emailAddress": "54e410b14fa652a4b49b43aff6eaf92ad680d4d1e5e62ed71b86cd3188385a51"
                },
                {
                  "emailAddress": "e8bd3f8da6f5af73bec1ab3fbf7beb47482c4766dfdfc94e6bd89e359c139478"
                }
              ]
            }
          }
        },
        {
          "compositeData": {
            "userData": {
              "userIdentifiers": [
                {
                  "emailAddress": "05bb62526f091b45d20e243d194766cca8869137421047dc53fa4876d111a6f0"
                },
                {
                  "emailAddress": "f1fcde379f31f4d446b76ee8f34860eca2288adc6b6d6c0fdc56d9eee75a2fa5"
                }
              ]
            }
          }
        },
        {
          "compositeData": {
            "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 de cliente.NET para adicionar uma dependência à biblioteca de cliente no seu projeto.

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

  1. Clone o repositório do GitHub.

    git clone https://github.com/googleads/data-manager-dotnet.git
    
  2. No seu projeto .NET, declare uma dependência ProjectReference na biblioteca de utilitários. Substitua PATH_TO_UTILITY_LIBRARY pelo local em que você clonou o repositório data-manager-dotnet.

    <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 ou no GitHub.

    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.json.

Go

Instale a biblioteca de cliente

go get cloud.google.com/go/datamanager/apiv1@latest

Siga as instruções no guia da biblioteca de cliente do Go para mais informações.

Java

Instale a biblioteca de cliente

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

Opcional: instalar a biblioteca de utilitários

Além da biblioteca de cliente, é possível instalar a biblioteca de utilitários para ajudar com tarefas comuns, como formatação e criptografia de dados para ingestão.

  1. No seu projeto Java, declare uma dependência na biblioteca de utilitários data-manager-util.

    Gradle:

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

    Maven:

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

Procurar amostras de código

  1. Procure exemplos de código no subdiretório data-manager-samples ou no GitHub. Para executar amostras:

    1. Clone o repositório do GitHub na tag v0.4.0:

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

    3. Execute as amostras na linha de comando usando a tarefa run do Gradle, transmitindo os argumentos necessários. Transmita o argumento --help ao executar uma amostra para imprimir uma declaração de uso com os parâmetros esperados.

      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 começar com alguns dados de amostra, use o arquivo em data-manager-samples/src/main/resources/sampledata/audience_members_1.json.

Node.js

Instale a biblioteca de cliente

Siga as instruções no guia de instalação da biblioteca de cliente do Node.js para adicionar uma dependência à biblioteca de cliente @google-ads/datamanager no seu projeto.

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

  1. Clone o repositório do GitHub.

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

  3. Execute o comando a seguir para instalar as dependências:

    npm install
    
  4. Altere para o diretório util.

    cd util
    
  5. Execute o comando a seguir 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.2.0.tgz. Anote o local do arquivo para usá-lo nas próximas etapas.

  6. 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.2.0.tgz.

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

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

  7. Procure exemplos de código no subdiretório samples ou no GitHub. Siga estas etapas para executar as amostras:

    1. Navegue até o diretório data-manager-node.

    2. Execute as amostras, transmitindo os argumentos necessários. Transmita o argumento --help ao executar uma amostra para imprimir uma declaração de uso com os parâmetros esperados.

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

      npm run ingest-audience-members -w samples -- --help
      

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

PHP

Instale a biblioteca de cliente

Siga as instruções no guia de instalação da biblioteca de cliente PHP para adicionar uma dependência à biblioteca de cliente googleads/data-manager no seu projeto.

Opcional: instalar a biblioteca de utilitários

Além da biblioteca de cliente, você pode instalar a biblioteca de utilitários para ajudar com tarefas comuns, como formatação de dados para ingestão.

No arquivo composer.json do seu projeto PHP no mesmo host, declare uma dependência na biblioteca de utilitários:

composer require googleads/data-manager-util

Para formatar dados, use a utilidade Formatter no projeto PHP.

Procurar amostras de código

  1. Clone o repositório do GitHub.

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

  3. Execute o comando a seguir para resolver as dependências da biblioteca:

     composer update --prefer-dist
     ```
    
  4. Procure exemplos de código no subdiretório samples ou no GitHub. Execute as amostras seguindo estas etapas:

    1. Navegue até o diretório samples.

    2. Execute o comando a seguir para resolver as dependências da biblioteca:

      composer update --prefer-dist
      
    3. Execute as amostras, transmitindo os argumentos necessários. 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.json

Python

Instale a biblioteca de cliente

Siga as instruções no guia de instalação da biblioteca de cliente Python para adicionar uma dependência à biblioteca de cliente google-ads-datamanager no seu projeto.

Opcional: instalar a biblioteca de utilitários

Além da biblioteca de cliente, é possível instalar a biblioteca de utilitários para ajudar com tarefas comuns, como formatação e criptografia de dados para ingestão.

  1. No seu projeto Python, declare uma dependência na biblioteca de utilitários google-ads-datamanager-util.

    Por exemplo, se você estiver usando um arquivo requirements.txt no seu projeto, adicione a seguinte linha ao arquivo:

    google-ads-datamanager-util==0.4.0
    

    Ou instale a biblioteca de utilitários diretamente:

    pip install google-ads-datamanager-util==0.4.0
    
  2. Para formatar e criptografar os dados, use os utilitários Formatter e Encrypter no seu projeto Python.

  3. Procure exemplos de código no subdiretório samples ou no GitHub. Para executar exemplos, instale as dependências deles:

Procurar amostras de código

  1. Clone o repositório do GitHub na tag v0.4.0:

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

  3. Instale as dependências para executar os exemplos:

     pip install -r samples/requirements.txt
    
  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.

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

     python3 samples/events/ingest_events.py --help
    

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

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