安装客户端库

下面介绍了如何安装和配置客户端库或 REST。

前提条件

在安装客户端库之前,请完成设置 API 访问权限中的步骤,包括配置应用默认凭据 (ADC)

安装库

在本地机器上,安装您选择的客户端库:

REST

选择要遵循的设置流程类型:

  1. 将以下示例中的占位符(例如 OPERATING_ACCOUNT_PRODUCTOPERATING_ACCOUNT_IDAUDIENCE_ID)替换为您的账号和目的地的相应值。
  2. PROJECT_ID 替换为您的 Google Cloud ID。
  3. 将示例复制到命令行中以发送请求。

    #!/bin/bash
    
    # Uses gcloud to get an access token. If the Application Default
    # Credentials aren't for a service account, the command that specifies
    # --scopes fails. 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": [
        {
          "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
    

.NET

安装客户端库

按照 .NET 客户端库安装指南中的说明,在您的项目中添加对客户端库的依赖项。

可选:获取实用程序库和代码示例。

  1. 克隆 GitHub 代码库

    git clone https://github.com/googleads/data-manager-dotnet.git
    
  2. 在您的 .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" />
    
  3. 如需格式化数据,请使用 .NET 项目中的 Formatter 实用程序。

  4. 浏览 samples 子目录中的代码示例或 GitHub 上的代码示例

    切换到 samples 目录,并使用 dotnet run 获取可用示例的列表。

    dotnet run
    

    运行示例时传递 --help 实参,以打印包含预期形参的用法语句。

    dotnet run -- ingest-audience-members --help
    

    为了帮助您开始使用一些示例数据,请使用 samples/sampledata/audience_members_1.csv 中的文件。

Java

安装客户端库

按照 Java 客户端库安装指南中的说明,在项目中添加对客户端库的依赖项。

可选:获取实用程序库和代码示例。

  1. 克隆 GitHub 代码库

    git clone https://github.com/googleads/data-manager-java.git
    
  2. 进入 data-manager-java 目录。

  3. 构建实用程序库并将其发布到本地 Maven 代码库。

    ./gradlew data-manager-util:install
    
  4. 在 Java 项目中,声明对实用程序库的依赖项。

    Gradle:

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

    Maven:

    <dependency>
       <groupId>com.google.api-ads</groupId>
       <artifactId>data-manager-util</artifactId>
       <version>0.2.0</version>
    </dependency>
    
  5. 如需格式化和加密数据,请在 Java 项目中使用 UserDataFormatterEncrypter 实用程序。

  6. 浏览 data-manager-samples 子目录中的代码示例或 GitHub 上的代码示例。 如需从命令行运行示例,请使用 Gradle run 任务。

    例如,以下命令会运行 IngestAudienceMembers 示例并输出使用情况语句:

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

    为了帮助您开始使用一些示例数据,请使用 data-manager-samples/src/main/resources/sampledata/audience_members_1.csv 中的文件。

Node.js

安装客户端库

按照 Node.js 客户端库安装指南中的说明,在项目中添加对 @google-ads/datamanager 客户端库的依赖项。

可选:获取实用程序库和代码示例。

  1. 克隆 GitHub 代码库

    git clone https://github.com/googleads/data-manager-node.git
    
  2. 进入 data-manager-node 目录。

  3. 运行以下命令以安装依赖项。

    npm install
    
  4. 切换到 util 目录:

    cd util
    
  5. 运行以下命令,将实用程序库编译并打包到 .tgz 文件中,以便与 npm 搭配使用。

    npm pack
    

    该命令会生成一个名为 google-ads-datamanager-util-0.2.0.tgz 的归档文件。记下文件位置,以便在后续步骤中使用。

  6. 在 Node.js 项目中,通过添加 dependencies 条目(包含 google-ads-datamanager-util-0.2.0.tgz 文件的完整路径和文件名),声明对 Data Manager API 实用程序库的依赖项。

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

    如需格式化数据,请在 Node.js 项目中使用 UserDataFormatter 实用程序。

  7. 浏览 samples 子目录中的代码示例或 GitHub 上的代码示例。 按照以下步骤运行示例:

    1. 进入 data-manager-node 目录。

    2. 运行示例,并传递所有必需的实参。运行示例时传递 --help 实参,以打印包含预期形参的用法语句。

      例如,以下命令会运行 ingest_audience_members 示例并输出使用情况声明:

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

    为了帮助您开始使用一些示例数据,请使用 samples/sampledata/audience_members_1.csv 中的文件。

PHP

安装客户端库

按照 PHP 客户端库安装指南中的说明,在您的项目中为 googleads/data-manager 客户端库添加依赖项。

可选:获取实用程序库和代码示例。

  1. 克隆 GitHub 代码库

    git clone https://github.com/googleads/data-manager-php.git
    
  2. 进入 data-manager-php 目录。

  3. 运行以下命令以解析库的依赖项:

    composer update --prefer-dist
    
  4. 在同一主机上 PHP 项目的 composer.json 文件中,按照以下步骤声明对实用程序库的依赖项:

    1. repositories 部分中添加一个指向 data-manager-php 目录位置的条目。

      "repositories" : [
         {
            "type" : "path",
            "url" : "PATH_TO_UTILITY_LIBRARY"
         }
      ]
      
    2. 声明对实用程序库的依赖项。

      "require": {
         "googleads/data-manager-util": "@dev"
      }
      

    如需格式化数据,请在 PHP 项目中使用 Formatter 实用程序。

  5. 浏览 samples 子目录中的代码示例或 GitHub 上的代码示例。按照以下步骤运行示例:

    1. 进入 samples 目录。

    2. 运行以下命令以解析库的依赖项:

      composer update --prefer-dist
      
    3. 运行示例,并传递所有必需的实参。运行示例时传递 --help 实参,以打印包含预期形参的用法语句。

    为了帮助您开始使用一些示例数据,请使用 samples/sampledata/audience_members_1.csv 中的文件。

Python

安装客户端库

按照 Python 客户端库安装指南中的说明,在项目中为 google-ads-datamanager 客户端库添加依赖项。

可选:获取实用程序库和代码示例。

  1. 克隆 GitHub 代码库

    git clone https://github.com/googleads/data-manager-python.git
    
  2. 进入 data-manager-python 目录。

  3. 如需在 Python 环境中安装实用程序库,请运行以下命令:

    pip install .
    
  4. 在 Python 项目中,声明对实用程序库的依赖项。例如,如果您在项目中使用 requirements.txt 文件,请将以下行添加到该文件中:

    google-ads-data-manager-util=0.2.0
    
  5. 如需格式化和加密数据,请使用 Python 项目中的 FormatterEncrypter 实用程序。

  6. 浏览 samples 子目录中的代码示例或 GitHub 上的代码示例。如需运行示例,请安装必要的依赖项:

    pip install .[samples]
    

    运行示例时传递 --help 实参,以打印包含预期形参的用法语句。

    为了帮助您开始使用一些示例数据,请使用 samples/sampledata/audience_members_1.csv 中的文件。

Ruby

安装客户端库

按照 Ruby 客户端库安装指南中的说明,在您的项目中添加对客户端库的依赖项。

后续步骤