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:
- Um projeto do Google Cloud.
- Uma Conta do Google que atenda aos dois critérios a seguir:
- Recebeu acesso à API Data Manager depois de preencher o formulário de interesse na API Data Manager. Se você conseguir acessar a página Detalhes do produto de API, você tem acesso.
- Tem a permissão
serviceusage.services.enable
no seu projeto do Google Cloud ou um papel que inclui essa permissão. Por exemplo,roles/owner
eroles/serviceusage.serviceUsageAdmin
incluem a permissãoserviceusage.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.
Se você não encontrar a API Data Manager, verifique se sua Conta do Google atende aos pré-requisitos.
Configurar a autenticação
Selecione e configure um método de autenticação. Recomendamos que você configure as credenciais padrão do aplicativo para encontrar automaticamente as credenciais do ambiente. Essa API não usa chaves de API.
O escopo https://www.googleapis.com/auth/datamanager
é obrigatório para qualquer credencial usada com a
API Data Manager. Para um exemplo de como usar escopos, consulte a documentação do comando
gcloud auth application-default
login.
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 ou de serviço acesso ao
Destination
.
Configurar o SDK para sua linguagem de programação
Na máquina local, instale o SDK de sua escolha:
REST
- 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.
- Substitua PROJECT_ID pelo ID do Google Cloud.
Copie o exemplo para a linha de comando e envie a solicitação.
Remova o atributo
linkedAccount
da entrada emdestinations
se você não estiver acessandooperationAccount
usando um link de produto estabelecido.#!/bin/bash # Uses gcloud to get an access token. DATA_MANAGER_ACCESS_TOKEN="$(gcloud auth application-default print-access-token --scopes=https://www.googleapis.com/auth/datamanager)" # 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": { "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
- Faça o download e extraia google-cloud-ads-datamanager-v1-java.tar.gz.
- Navegue até o diretório
google-cloud-ads-datamanager-v1-java
. Execute o comando a seguir para criar e publicar a biblioteca no seu repositório Maven local para uso com Maven ou Gradle.
./gradlew -Pversion=0.1.0 install
No seu 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>
Opcional. Acesse a biblioteca de utilitários e os exemplos de código.
Clone o repositório do GitHub.
git clone https://github.com/googleads/data-manager-java.git
Navegue até o diretório
data-manager-java
.Crie e publique a biblioteca de utilitários no seu repositório Maven local.
./gradlew data-manager-util:install
No seu 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>
Para formatar e criptografar os dados, use os utilitários
UserDataFormatter
eEncrypter
no seu projeto Java.Procure exemplos de código no subdiretório
data-manager-samples
ou no GitHub. Para executar uma amostra na linha de comando, use a tarefarun
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 começar com alguns dados de amostra, use o arquivo em
data-manager-samples/src/main/resources/sampledata/audience_members_1.csv
.
Python
- Faça o download de ads-datamanager-v1-py.tar.gz.
- Navegue até o diretório do download.
Execute o comando a seguir para criar a biblioteca e disponibilizá-la a outros projetos no mesmo ambiente Python:
pip install ./ads-datamanager-v1-py.tar.gz
No seu projeto Python, declare uma dependência na biblioteca da API Data Manager. Por exemplo, se você estiver usando um arquivo
requirements.txt
no seu projeto, adicione a seguinte linha ao arquivo:google-ads-data-manager=0.1.0
Opcional. Acesse a biblioteca de utilitários e os exemplos de código.
- Faça o download e extraia data-manager-python.tar.gz.
- Navegue até o diretório
data-manager-python
. Para instalar a biblioteca de utilitários no seu ambiente Python, execute o seguinte comando:
pip install .
No seu projeto Python, declare uma dependência na biblioteca de utilitários. Por exemplo, se você estiver usando um arquivo
requirements.txt
no seu projeto, adicione a seguinte linha ao arquivo:google-ads-data-manager-util=0.1.0
Para formatar e criptografar os dados, use os utilitários
Formatter
eEncrypter
no seu projeto Python.Procure exemplos de código no subdiretório
samples
. Transmita o argumento--help
ao executar uma amostra para imprimir uma instruçã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
- Baixe e extraia ads-datamanager-v1-nodejs.tar.gz.
- Navegue até o diretório
ads-datamanager-v1-nodejs
. Execute os comandos a seguir para compilar e empacotar a biblioteca em um arquivo
.tgz
para uso comnpm
.npm install npm pack
Os comandos geram um arquivo chamado
google-cloud-datamanager-0.1.0.tgz
.No seu projeto Node.js, declare uma dependência na biblioteca da API Data Manager adicionando uma entrada
dependencies
para o caminho completo e o nome do arquivo do arquivogoogle-cloud-datamanager-0.1.0.tgz
.
PHP
- Faça o download e extraia google-cloud-ads-datamanager-v1-php.tar.gz.
- Navegue até o diretório
google-cloud-ads-datamanager-v1-php
. Execute o comando a seguir para resolver as dependências da biblioteca:
composer update --prefer-dist
No arquivo
composer.json
do projeto PHP no mesmo host, declare uma dependência na biblioteca da API Data Manager seguindo estas etapas:Adicione uma seção
repositories
que aponte para o local do diretóriogoogle-cloud-ads-datamanager-v1-php
."repositories" : [ { "type" : "path", "url" : "PATH_TO_CLIENT_LIBRARY" } ]
Declare uma dependência na biblioteca da API Data Manager.
"require": { "googleads/data-manager": "^0.1.0" }
(Opcional) Acesse a biblioteca de utilitários e os exemplos de código.
- Faça o download e extraia data-manager-php.tar.gz.
- Navegue até o diretório
data-manager-php
. Execute o comando a seguir para resolver as dependências da biblioteca:
composer update --prefer-dist
No arquivo
composer.json
do projeto PHP no mesmo host, declare uma dependência na biblioteca de utilitários seguindo estas etapas:Adicione uma entrada na seção
repositories
que aponte para o local do diretóriodata-manager-php
."repositories" : [ { "type" : "path", "url" : "PATH_TO_UTILITY_LIBRARY" } ]
Declare uma dependência na biblioteca de utilitários.
"require": { "googleads/data-manager-util": "@dev" }
Para formatar dados, use a utilidade
Formatter
no projeto PHP.Procure exemplos de código no subdiretório
samples
. Execute as amostras seguindo estas etapas:Navegue até o diretório
samples
.Defina a variável de ambiente
DATA_MANAGER_PHP_LIB
para o caminho onde você extraiu a biblioteca de cliente.export DATA_MANAGER_PHP_LIB="PATH_TO_CLIENT_LIBRARY"
Execute o comando a seguir para resolver as dependências da biblioteca:
composer update --prefer-dist
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 começar com alguns dados de amostra, use o arquivo em
samples/sampledata/audience_members_1.csv
.