A continuación, se explica cómo configurar el acceso a la API de Data Manager con un SDK o REST.
Requisitos previos
Antes de usar la API de Data, asegúrate de tener lo siguiente:
- Un proyecto de Google Cloud
- Una Cuenta de Google que cumpla con los siguientes criterios:
- Se te otorgó acceso a la API de Data Manager después de que completaste el Formulario de interés en la API de Data Manager. Si puedes ver la página de detalles del producto de API, tienes acceso.
- Tiene el permiso
serviceusage.services.enable
en tu proyecto de Google Cloud o tiene un rol que incluye ese permiso. Por ejemplo,roles/owner
yroles/serviceusage.serviceUsageAdmin
incluyen el permisoserviceusage.services.enable
. Para verificar tus permisos, consulta Cómo ver el acceso actual.
Habilita la API
Si aún no lo hiciste, habilita la API de Data Manager.
Si no encuentras la API de Data Manager, verifica que tu Cuenta de Google cumpla con los requisitos previos.
Configura la autenticación
Selecciona y configura un método de autenticación. Te recomendamos que configures las credenciales predeterminadas de la aplicación para encontrar automáticamente las credenciales del entorno. Esta API no usa claves de API.
El permiso https://www.googleapis.com/auth/datamanager
es obligatorio para cualquier credencial que se use con la API de Data Manager. Para ver un ejemplo de cómo usar los alcances, consulta la documentación del comando gcloud auth application-default login.
Para obtener más información sobre la autenticación y las credenciales de tu app, consulta Métodos de autenticación en Google y Cómo funcionan las credenciales predeterminadas de la aplicación.
Configura el acceso a la cuenta operativa
Otorga acceso a la dirección de correo electrónico asociada con tu cuenta de usuario o de servicio a Destination
.
Configura el SDK para tu lenguaje de programación
En tu máquina local, instala el SDK que prefieras:
REST
- Actualiza los marcadores de posición en el siguiente ejemplo, como OPERATING_ACCOUNT_PRODUCT, OPERATING_ACCOUNT_ID y AUDIENCE_ID, con los valores de tu cuenta y destino.
- Reemplaza PROJECT_ID por el ID de tu proyecto de Google Cloud.
Copia la muestra en la línea de comandos para enviar la solicitud.
Quita el atributo
linkedAccount
de la entrada endestinations
si no accedes aoperationAccount
a través de un vínculo de producto establecido.#!/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
- Descarga y extrae google-cloud-ads-datamanager-v1-java.tar.gz.
- Navega al directorio
google-cloud-ads-datamanager-v1-java
. Ejecuta el siguiente comando para compilar y publicar la biblioteca en tu repositorio local de Maven para usarla con Maven o Gradle.
./gradlew -Pversion=0.1.0 install
En tu proyecto de Java, declara una dependencia en la biblioteca de la API de 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. Obtén la biblioteca de utilidades y las muestras de código.
- Descarga y extrae data-manager-java.tar.gz.
- Navega al directorio
data-manager-java
. Para Maven o Gradle, ejecuta el siguiente comando. Este comando compila y publica la biblioteca de utilidades en tu repositorio local de Maven.
./gradlew data-manager-util:install
En tu proyecto de Java, declara una dependencia en la biblioteca de utilidades.
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 formatear y encriptar los datos, usa las utilidades
UserDataFormatter
yEncrypter
en tu proyecto de Java.Explora las muestras de código en el subdirectorio
data-manager-samples
. Para ejecutar un ejemplo desde la línea de comandos, usa la tarearun
de Gradle.Por ejemplo, el siguiente comando ejecuta la muestra
IngestAudienceMembers
y muestra una declaración de uso:./gradlew data-manager-samples:run \ --args='IngestAudienceMembers --help'
Para ayudarte a comenzar con algunos datos de muestra, usa el archivo en
data-manager-samples/src/main/resources/sampledata/audience_members_1.csv
.
Python
- Descarga ads-datamanager-v1-py.tar.gz.
- Navega al directorio de la descarga.
Ejecuta el siguiente comando para compilar la biblioteca y hacerla disponible para otros proyectos en el mismo entorno de Python:
pip install ./ads-datamanager-v1-py.tar.gz
En tu proyecto de Python, declara una dependencia en la biblioteca de la API de Data Manager. Por ejemplo, si usas un archivo
requirements.txt
en tu proyecto, agrega la siguiente línea al archivo:google-ads-data-manager=0.1.0
Opcional. Obtén la biblioteca de utilidades y las muestras de código.
- Descarga y extrae data-manager-python.tar.gz.
- Navega al directorio
data-manager-python
. Para instalar la biblioteca de utilidades en tu entorno de Python, ejecuta el siguiente comando:
pip install .
En tu proyecto de Python, declara una dependencia en la biblioteca de utilidades. Por ejemplo, si usas un archivo
requirements.txt
en tu proyecto, agrega la siguiente línea al archivo:google-ads-data-manager-util=0.1.0
Para formatear y encriptar los datos, usa las utilidades
Formatter
yEncrypter
en tu proyecto de Python.Explora las muestras de código en el subdirectorio
samples
. Pasa el argumento--help
cuando ejecutes una muestra para imprimir una declaración de uso con los parámetros esperados.Para ayudarte a comenzar con algunos datos de muestra, usa el archivo en
samples/sampledata/audience_members_1.csv
.
Node.js
- Descarga y extrae ads-datamanager-v1-nodejs.tar.gz.
- Navega al directorio
ads-datamanager-v1-nodejs
. Ejecuta los siguientes comandos para compilar y empaquetar la biblioteca en un archivo
.tgz
para usarlo connpm
.npm install npm pack
Los comandos generan un archivo llamado
google-cloud-datamanager-0.1.0.tgz
.En tu proyecto de Node.js, declara una dependencia en la biblioteca de la API de Data Manager agregando una entrada
dependencies
para la ruta de acceso completa y el nombre de archivo del archivogoogle-cloud-datamanager-0.1.0.tgz
.
PHP
- Descarga y extrae google-cloud-ads-datamanager-v1-php.tar.gz.
- Navega al directorio
google-cloud-ads-datamanager-v1-php
. Ejecuta el siguiente comando para resolver las dependencias de la biblioteca:
composer update --prefer-dist
En el archivo
composer.json
de tu proyecto de PHP en el mismo host, declara una dependencia en la biblioteca de la API de Data Manager con los siguientes pasos:Agrega una sección
repositories
que apunte a la ubicación del directoriogoogle-cloud-ads-datamanager-v1-php
."repositories" : [ { "type" : "path", "url" : "PATH_TO_CLIENT_LIBRARY" } ]
Declara una dependencia en la biblioteca de la API de Data Manager.
"require": { "googleads/data-manager": "^0.1.0" }
(Opcional) Obtén la biblioteca de utilidades y las muestras de código.
- Descarga y extrae data-manager-php.tar.gz.
- Navega al directorio
data-manager-php
. Ejecuta el siguiente comando para resolver las dependencias de la biblioteca:
composer update --prefer-dist
En el archivo
composer.json
de tu proyecto de PHP en el mismo host, declara una dependencia en la biblioteca de utilidades con los siguientes pasos:Agrega una entrada en la sección
repositories
que apunte a la ubicación del directoriodata-manager-php
."repositories" : [ { "type" : "path", "url" : "PATH_TO_UTILITY_LIBRARY" } ]
Declara una dependencia en la biblioteca de utilidades.
"require": { "googleads/data-manager-util": "@dev" }
Para formatear datos, usa la utilidad
Formatter
en tu proyecto de PHP.Explora las muestras de código en el subdirectorio
samples
. Ejecuta las muestras con los siguientes pasos:Navega al directorio
samples
.Establece la variable de entorno
DATA_MANAGER_PHP_LIB
en la ruta de acceso en la que extrajiste la biblioteca cliente.export DATA_MANAGER_PHP_LIB="PATH_TO_CLIENT_LIBRARY"
Ejecuta el siguiente comando para resolver las dependencias de la biblioteca:
composer update --prefer-dist
Ejecuta las muestras y pasa los argumentos necesarios. Pasa el argumento
--help
cuando ejecutes una muestra para imprimir una declaración de uso con los parámetros esperados.
Para ayudarte a comenzar con algunos datos de muestra, usa el archivo en
samples/sampledata/audience_members_1.csv
.