Instalar uma biblioteca de cliente

Veja 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 do 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 de posição 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. Use o exemplo de parceiro de dados somente se você estiver acessando a conta operacional por um link de parceiro. Caso contrário, use o exemplo Advertiser.

    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 do.NET 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 de dados para ingestão.

  1. No projeto .NET, declare uma dependência na biblioteca de utilitários Google.Ads.DataManager.Util.

    dotnet add package Google.Ads.DataManager.Util --version 0.4.0
    
  2. Para formatar dados, use o utilitário UserDataFormatter no projeto .NET.

Procurar amostras de código

Procure exemplos de código no subdiretório 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-dotnet.git
    
  2. Navegue até o diretório data-manager-dotnet.

  3. Mude para o diretório samples e use dotnet run para ver 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 ajudar você a começar com alguns dados de amostra, use os arquivos em samples/sampledata.

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 projeto Java, declare uma dependência da 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 projeto Java.

Procurar amostras de código

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 todos 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 o exemplo IngestAudienceMembers e mostra uma declaração de uso:

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

Para ajudar você a começar com alguns dados de amostra, use os arquivos em data-manager-samples/src/main/resources/sampledata.

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: 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 de dados para ingestão.

  1. No projeto do Node.js, declare uma dependência da biblioteca de utilitários @google-ads/datamanager-util:

    npm install @google-ads/datamanager-util
    
  2. Para formatar dados, use o utilitário UserDataFormatter no projeto do Node.js.

Procurar amostras de código

Procure exemplos de código no subdiretório samples ou no GitHub.

Para executar amostras:

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

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

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

    npm install
    
  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 o exemplo ingest-audience-members e mostra uma declaração de uso:

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

Para ajudar você a começar com alguns dados de amostra, use os arquivos em samples/sampledata.

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, é possível instalar a biblioteca de utilitários para ajudar com tarefas comuns, como formatação de dados para ingestão.

  1. 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
    
  2. Para formatar dados, use o utilitário Formatter no seu projeto PHP.

Procurar amostras de código

Procure exemplos de código no subdiretório 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-php.git
    
  2. Navegue até o diretório data-manager-php/samples.

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

    composer install
    
  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 o exemplo ingest_audience_members e imprime uma instrução de uso:

    php audiences/ingest_audience_members.php --help
    

Para ajudar você a começar com alguns dados de amostra, use os arquivos em samples/sampledata.

Python

Instale a biblioteca de cliente

Siga as instruções no guia de instalação da biblioteca de cliente do 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 projeto em Python, declare uma dependência da biblioteca de utilitários google-ads-datamanager-util.

    Por exemplo, se você estiver usando um arquivo requirements.txt no 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 em Python.

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 o exemplo ingest_audience_members e mostra uma declaração de uso:

    python3 samples/audiences/ingest_audience_members.py --help
    

Para ajudar você a começar com alguns dados de amostra, use os arquivos em samples/sampledata.

Ruby

Instale a biblioteca de cliente

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

Próximas etapas