Установка клиентской библиотеки

Ниже описано, как установить и настроить клиентскую библиотеку или REST.

Требования

Прежде чем устанавливать клиентскую библиотеку, выполните действия, описанные в статье Как настроить доступ к API, в том числе настройте Application Default Credentials (ADC).

Этапы установки

Установите на локальный компьютер нужную клиентскую библиотеку:

REST

  1. Замените плейсхолдеры в примере ниже, такие как OPERATING_ACCOUNT_PRODUCT, OPERATING_ACCOUNT_ID и AUDIENCE_ID, значениями для вашего аккаунта и целевой страницы.
  2. Замените PROJECT_ID идентификатором своего проекта Google Cloud.
  3. Скопируйте пример в командную строку, чтобы отправить запрос. Используйте шаблон Партнер по обработке данных, только если вы получаете доступ к рабочему аккаунту по партнерской ссылке. В противном случае используйте пример Рекламодатель.

    Рекламодатель

    #!/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.

Как установить библиотеку утилит (необязательно)

Помимо клиентской библиотеки, вы можете установить библиотеку утилит, которая поможет вам выполнять распространенные задачи, например форматировать данные для загрузки.

  1. В проекте .NET объявите зависимость от служебной библиотеки Google.Ads.DataManager.Util.

    dotnet add package Google.Ads.DataManager.Util --version 0.4.0
    
  2. Чтобы отформатировать данные, используйте утилиту UserDataFormatter в проекте .NET.

Посмотреть примеры кода

Примеры кода можно найти в подкаталоге samples или на GitHub.

Чтобы запустить примеры, выполните следующие действия:

  1. Клонируйте хранилище GitHub с тегом v0.4.0:

    git clone --branch v0.4.0 https://github.com/googleads/data-manager-dotnet.git
    
  2. Перейдите в каталог data-manager-dotnet.

  3. Перейдите в каталог samples и используйте dotnet run, чтобы получить список доступных примеров.

    dotnet run
    

    При запуске примера передайте аргумент --help, чтобы напечатать инструкцию по использованию с ожидаемыми параметрами.

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

Чтобы вам было проще начать работу с выборкой данных, используйте файлы по адресу samples/sampledata.

Проложить маршрут

Установите клиентскую библиотеку

go get cloud.google.com/go/datamanager/apiv1@latest

Подробные инструкции приведены в руководстве по клиентской библиотеке Go.

Java

Установите клиентскую библиотеку

Чтобы добавить зависимость в клиентскую библиотеку в проекте, следуйте инструкциям в руководстве по установке клиентской библиотеки Java.

Как установить библиотеку утилит (необязательно)

Помимо клиентской библиотеки, вы можете установить служебную библиотеку, которая поможет вам выполнять распространенные задачи, такие как форматирование и шифрование данных для передачи.

  1. В проекте 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>
    
  2. Чтобы отформатировать и зашифровать данные, используйте в проекте Java утилиты UserDataFormatter и Encrypter.

Посмотреть примеры кода

Примеры кода можно найти в подкаталоге data-manager-samples или на GitHub.

Чтобы запустить примеры, выполните следующие действия:

  1. Клонируйте хранилище GitHub с тегом v0.4.0:

    git clone --branch v0.4.0 https://github.com/googleads/data-manager-java.git
    
  2. Перейдите в каталог data-manager-java.

  3. Запустите примеры из командной строки с помощью задачи 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 в своем проекте.

Как установить библиотеку утилит (необязательно)

Помимо клиентской библиотеки, вы можете установить библиотеку утилит, которая поможет вам выполнять распространенные задачи, например форматировать данные для загрузки.

  1. В проекте Node.js объявите зависимость от библиотеки утилит @google-ads/datamanager-util:

    npm install @google-ads/datamanager-util
    
  2. Чтобы отформатировать данные, используйте утилиту UserDataFormatter в проекте Node.js.

Посмотреть примеры кода

Примеры кода можно найти в подкаталоге samples или на GitHub.

Чтобы запустить примеры, выполните следующие действия:

  1. Клонируйте хранилище GitHub с тегом v0.4.1:

    git clone --branch v0.4.1 https://github.com/googleads/data-manager-node.git
    
  2. Перейдите в каталог data-manager-node.

  3. Установите зависимости для запуска примеров:

    npm install
    
  4. Запустите примеры, передав все необходимые аргументы. При запуске примера передайте аргумент --help, чтобы напечатать инструкцию по использованию с ожидаемыми параметрами.

    Например, следующая команда запускает пример ingest-audience-members и выводит инструкцию по использованию:

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

Чтобы вам было проще начать работу с выборкой данных, используйте файлы по адресу samples/sampledata.

PHP

Установите клиентскую библиотеку

Следуйте инструкциям в руководстве по установке клиентской библиотеки PHP, чтобы добавить зависимость в клиентскую библиотеку googleads/data-manager в своем проекте.

Как установить библиотеку утилит (необязательно)

Помимо клиентской библиотеки, вы можете установить библиотеку утилит, которая поможет вам выполнять распространенные задачи, например форматировать данные для загрузки.

  1. В файле composer.json проекта PHP на том же хосте объявите зависимость от библиотеки утилит:

    composer require googleads/data-manager-util
    
  2. Чтобы отформатировать данные, используйте утилиту Formatter в проекте PHP.

Посмотреть примеры кода

Примеры кода можно найти в подкаталоге samples или на GitHub.

Чтобы запустить примеры, выполните следующие действия:

  1. Клонируйте хранилище GitHub с тегом v0.4.0:

    git clone --branch v0.4.0 https://github.com/googleads/data-manager-php.git
    
  2. Перейдите в каталог data-manager-php/samples.

  3. Установите зависимости для запуска примеров:

    composer install
    
  4. Запустите примеры, передав все необходимые аргументы. При запуске примера передайте аргумент --help, чтобы напечатать инструкцию по использованию с ожидаемыми параметрами.

    Например, следующая команда запускает пример ingest_audience_members и выводит инструкцию по использованию:

    php audiences/ingest_audience_members.php --help
    

Чтобы вам было проще начать работу с выборкой данных, используйте файлы по адресу samples/sampledata.

Python

Установите клиентскую библиотеку

Следуйте инструкциям в руководстве по установке клиентской библиотеки Python, чтобы добавить зависимость в клиентскую библиотеку google-ads-datamanager в своем проекте.

Как установить библиотеку утилит (необязательно)

Помимо клиентской библиотеки, вы можете установить служебную библиотеку, которая поможет вам выполнять распространенные задачи, такие как форматирование и шифрование данных для передачи.

  1. В проекте Python объявите зависимость от служебной библиотеки google-ads-datamanager-util.

    Например, если вы используете в проекте файл requirements.txt, добавьте в него следующую строку:

    google-ads-datamanager-util==0.4.0
    

    Или установите библиотеку утилит напрямую:

    pip install google-ads-datamanager-util==0.4.0
    
  2. Чтобы отформатировать и зашифровать данные, используйте утилиты Formatter и Encrypter в проекте Python.

Посмотреть примеры кода

  1. Клонируйте хранилище GitHub с тегом v0.4.0:

    git clone --branch v0.4.0 https://github.com/googleads/data-manager-python.git
    
  2. Перейдите в каталог data-manager-python.

  3. Установите зависимости для запуска примеров:

    pip install -r samples/requirements.txt
    
  4. Запустите примеры, передав все необходимые аргументы. При запуске примера передайте аргумент --help, чтобы напечатать инструкцию по использованию с ожидаемыми параметрами.

    Например, следующая команда запускает пример ingest_audience_members и выводит инструкцию по использованию:

    python3 samples/audiences/ingest_audience_members.py --help
    

Чтобы вам было проще начать работу с выборкой данных, используйте файлы по адресу samples/sampledata.

Ruby

Установите клиентскую библиотеку

Чтобы добавить зависимость в клиентскую библиотеку в проекте, следуйте инструкциям в руководстве по установке клиентской библиотеки Ruby.

Дальнейшие действия