下面介绍了如何安装和配置客户端库或 REST。
前提条件
在安装客户端库之前,请完成设置 API 访问权限中的步骤,包括配置应用默认凭证 (ADC)。
安装步骤
在本地机器上,安装您选择的客户端库:
REST
- 将以下示例中的占位符(例如 OPERATING_ACCOUNT_PRODUCT、OPERATING_ACCOUNT_ID 和 AUDIENCE_ID)替换为您的账号和目的地的相应值。
- 将 PROJECT_ID 替换为您的 Google Cloud ID。
将示例复制到命令行中以发送请求。如果您是通过合作伙伴链接访问运营账号,请仅使用数据合作伙伴示例。否则,请使用 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数据合作伙伴
#!/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
安装客户端库
按照 .NET 客户端库安装指南中的说明,在您的项目中添加对客户端库的依赖项。
可选:获取实用程序库和代码示例。
克隆 GitHub 代码库。
git clone https://github.com/googleads/data-manager-dotnet.git在 .NET 项目中,声明对实用程序库的
ProjectReference依赖项。将 PATH_TO_UTILITY_LIBRARY 替换为克隆data-manager-dotnet代码库的位置。<ProjectReference Include="PATH_TO_UTILITY_LIBRARY\Google.Ads.DataManager.Util\src\Google.Ads.DataManager.Util.csproj" />如需格式化数据,请使用 .NET 项目中的
Formatter实用程序。浏览
samples子目录中的代码示例或 GitHub 上的代码示例。切换到
samples目录,并使用dotnet run获取可用示例的列表。dotnet run运行示例时传递
--help实参,以打印包含预期形参的用法语句。dotnet run -- ingest-audience-members --help如需帮助您开始使用一些示例数据,请使用
samples/sampledata中的文件。
Go
安装客户端库
go get cloud.google.com/go/datamanager/apiv1@latest
如需了解详情,请参阅 Go 客户端库指南。
Java
安装客户端库
按照 Java 客户端库安装指南中的说明,在项目中添加对客户端库的依赖项。
可选:安装实用程序库
除了客户端库之外,您还可以安装实用程序库,以帮助完成常见任务,例如格式化和加密数据以进行注入。
在 Java 项目中,声明对
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>如需格式化和加密数据,请在 Java 项目中使用
UserDataFormatter和Encrypter实用程序。
浏览代码示例
浏览 data-manager-samples 子目录中的代码示例或 GitHub 上的代码示例。
如需运行示例,请执行以下操作:
克隆
v0.4.0标记处的 GitHub 代码库:git clone --branch v0.4.0 https://github.com/googleads/data-manager-java.git进入
data-manager-java目录。使用 Gradle
run任务从命令行运行示例,并传递任何必需的实参。运行示例时传递--help实参,以打印包含预期形参的用法语句。例如,以下命令会运行
IngestAudienceMembers示例并输出使用情况语句:./gradlew data-manager-samples:run \ --args='IngestAudienceMembers --help'
为了帮助您开始使用一些示例数据,请使用 data-manager-samples/src/main/resources/sampledata 中的文件。
Node.js
安装客户端库
按照 Node.js 客户端库安装指南中的说明,在项目中添加对 @google-ads/datamanager 客户端库的依赖项。
可选:安装实用程序库
除了客户端库之外,您还可以安装实用程序库,以帮助完成常见任务,例如格式化要注入的数据。
在 Node.js 项目中,声明对
@google-ads/datamanager-util实用程序库的依赖项:npm install @google-ads/datamanager-util如需格式化数据,请在 Node.js 项目中使用
UserDataFormatter实用程序。
浏览代码示例
浏览 samples 子目录中的代码示例或 GitHub 上的代码示例。
如需运行示例,请执行以下操作:
克隆
v0.4.1标记处的 GitHub 代码库:git clone --branch v0.4.1 https://github.com/googleads/data-manager-node.git进入
data-manager-node目录。安装运行示例所需的依赖项:
npm install运行示例,并传递所有必需的实参。运行示例时传递
--help实参,以打印包含预期形参的用法语句。例如,以下命令会运行
ingest-audience-members示例并输出使用情况声明:npm run ingest-audience-members -w samples -- --help
为了帮助您开始使用一些示例数据,请使用 samples/sampledata 中的文件。
PHP
安装客户端库
按照 PHP 客户端库安装指南中的说明,在您的项目中为 googleads/data-manager 客户端库添加依赖项。
可选:安装实用程序库
除了客户端库之外,您还可以安装实用程序库,以帮助完成常见任务,例如格式化要注入的数据。
在同一主机上 PHP 项目的
composer.json文件中,声明对实用程序库的依赖项:composer require googleads/data-manager-util如需格式化数据,请在 PHP 项目中使用
Formatter实用程序。
浏览代码示例
浏览 samples 子目录中的代码示例或 GitHub 上的代码示例。
如需运行示例,请执行以下操作:
克隆
v0.4.0标记处的 GitHub 代码库:git clone --branch v0.4.0 https://github.com/googleads/data-manager-php.git进入
data-manager-php/samples目录。安装运行示例所需的依赖项:
composer install运行示例,并传递所有必需的实参。运行示例时传递
--help实参,以打印包含预期形参的用法语句。例如,以下命令会运行
ingest_audience_members示例并输出使用情况声明:php audiences/ingest_audience_members.php --help
为了帮助您开始使用一些示例数据,请使用 samples/sampledata 中的文件。
Python
安装客户端库
按照 Python 客户端库安装指南中的说明,在您的项目中为 google-ads-datamanager 客户端库添加依赖项。
可选:安装实用程序库
除了客户端库之外,您还可以安装实用程序库,以帮助完成常见任务,例如格式化和加密数据以进行注入。
在 Python 项目中,声明对
google-ads-datamanager-util实用程序库的依赖项。例如,如果您在项目中使用
requirements.txt文件,请将以下行添加到该文件中:google-ads-datamanager-util==0.4.0或者,直接安装实用程序库:
pip install google-ads-datamanager-util==0.4.0如需格式化和加密数据,请使用 Python 项目中的
Formatter和Encrypter实用程序。
浏览代码示例
克隆
v0.4.0标记处的 GitHub 代码库:git clone --branch v0.4.0 https://github.com/googleads/data-manager-python.git进入
data-manager-python目录。安装运行示例所需的依赖项:
pip install -r samples/requirements.txt运行示例,并传递所有必需的实参。运行示例时传递
--help实参,以打印包含预期形参的用法语句。例如,以下命令会运行
ingest_audience_members示例并输出使用情况语句:python3 samples/audiences/ingest_audience_members.py --help
如需帮助您开始使用一些示例数据,请使用 samples/sampledata 中的文件。
Ruby
安装客户端库
按照 Ruby 客户端库安装指南中的说明,在您的项目中添加对客户端库的依赖项。