Настройте доступ к API

Вот как настроить доступ к API диспетчера данных с помощью SDK или REST.

Предпосылки

Прежде чем использовать API данных, убедитесь, что у вас есть следующее:

  1. Проект Google Cloud .
  2. Учетная запись Google, соответствующая обоим следующим критериям:
    1. Вам был предоставлен доступ к API Data Manager после заполнения формы запроса на API Data Manager . Если вы видите страницу с подробностями продукта API , у вас есть доступ.
    2. Имеет ли ваш проект Google Cloud разрешение serviceusage.services.enable или имеет роль, включающую это разрешение. Например, roles/owner и roles/serviceusage.serviceUsageAdmin включают разрешение serviceusage.services.enable . Чтобы проверить свои разрешения, см. раздел Просмотр текущего доступа .

Включить API

Если вы еще этого не сделали, включите API диспетчера данных .

Если вы не можете найти API диспетчера данных, убедитесь, что ваша учетная запись Google соответствует предварительным требованиям .

Настроить аутентификацию

Выберите и настройте метод аутентификации . Рекомендуем настроить учётные данные приложения по умолчанию для автоматического поиска учётных данных в среде. Этот API не использует ключи API.

Область действия https://www.googleapis.com/auth/datamanager требуется для любых учётных данных, используемых с API Data Manager. Пример использования областей действия см. в документации по команде входа gcloud auth application-default .

Дополнительную информацию об аутентификации и учетных данных для вашего приложения см. в разделах Методы аутентификации в Google и Как работают учетные данные приложения по умолчанию .

Настройте доступ к операционному счету

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

Настройте SDK для вашего языка программирования

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

ОТДЫХ

  1. Обновите заполнители в следующем примере, такие как OPERATING_ACCOUNT_PRODUCT , OPERATING_ACCOUNT_ID и AUDIENCE_ID , значениями для вашей учетной записи и назначения.
  2. Замените PROJECT_ID на идентификатор вашего Google Cloud.
  3. Скопируйте образец в командную строку для отправки запроса.

    Удалите атрибут linkedAccount записи в destinations если вы не получаете доступ к operationAccount с помощью установленной ссылки на продукт.

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

Ява

  1. Загрузите и распакуйте google-cloud-ads-datamanager-v1-java.tar.gz .
  2. Перейдите в каталог google-cloud-ads-datamanager-v1-java .
  3. Выполните следующую команду, чтобы собрать и опубликовать библиотеку в локальном репозитории Maven для использования с Maven или Gradle.

    ./gradlew -Pversion=0.1.0 install
    
  4. В вашем проекте Java объявите зависимость от библиотеки API Data Manager.

    Gradle:

    implementation 'com.google.cloud:gapic-google-cloud-ads-datamanager-v1-java:0.1.0'
    

    Мейвен:

    <dependency>
      <groupId>com.google.cloud</groupId>
      <artifactId>gapic-google-cloud-ads-datamanager-v1-java</artifactId>
      <version>0.1.0</version>
    </dependency>
    
  5. Необязательно . Получите библиотеку утилит и примеры кода.

    1. Загрузите и распакуйте data-manager-java.tar.gz .
    2. Перейдите в каталог data-manager-java .
    3. Для Maven или Gradle выполните следующую команду. Эта команда соберет и опубликует библиотеку утилит в вашем локальном репозитории Maven.

      ./gradlew data-manager-util:install
      
    4. В вашем проекте Java объявите зависимость от библиотеки утилит.

      Gradle:

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

      Мейвен:

      <dependency>
         <groupId>com.google.api-ads</groupId>
         <artifactId>data-manager-util</artifactId>
         <version>0.1.0</version>
      </dependency>
      
    5. Для форматирования и шифрования данных используйте утилиты UserDataFormatter и Encrypter в вашем проекте Java.

    6. Просмотрите примеры кода в подкаталоге data-manager-samples . Чтобы запустить пример из командной строки, используйте задачу Gradle run .

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

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

      Чтобы начать работу с образцами данных, используйте файл data-manager-samples/src/main/resources/sampledata/audience_members_1.csv .

Питон

  1. Загрузитеads -datamanager-v1-py.tar.gz .
  2. Перейдите в каталог загрузки.
  3. Выполните следующую команду, чтобы собрать библиотеку и сделать ее доступной для других проектов в той же среде Python:

    pip install ./ads-datamanager-v1-py.tar.gz
    
  4. В вашем проекте Python объявите зависимость от библиотеки API Data Manager. Например, если в вашем проекте используется файл requirements.txt , добавьте в него следующую строку:

    google-ads-data-manager=0.1.0
    
  5. Необязательно . Получите библиотеку утилит и примеры кода.

    1. Загрузите и распакуйте data-manager-python.tar.gz .
    2. Перейдите в каталог data-manager-python .
    3. Чтобы установить библиотеку утилит в вашей среде Python, выполните следующую команду:

      pip install .
      
    4. В вашем проекте Python объявите зависимость от служебной библиотеки. Например, если в вашем проекте используется файл requirements.txt , добавьте в него следующую строку:

      google-ads-data-manager-util=0.1.0
      
    5. Для форматирования и шифрования данных используйте утилиты Formatter и Encrypter в вашем проекте Python.

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

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

Node.js

  1. Загрузите и распакуйте ads-datamanager-v1-nodejs.tar.gz .
  2. Перейдите в каталог ads-datamanager-v1-nodejs .
  3. Выполните следующие команды, чтобы скомпилировать и упаковать библиотеку в файл .tgz для использования с npm .

    npm install
    npm pack
    

    Команды создают архив с именем google-cloud-datamanager-0.1.0.tgz .

  4. В проекте Node.js объявите зависимость от библиотеки API Data Manager, добавив запись dependencies для полного пути и имени файла google-cloud-datamanager-0.1.0.tgz .

PHP

  1. Загрузите и распакуйте google-cloud-ads-datamanager-v1-php.tar.gz .
  2. Перейдите в каталог google-cloud-ads-datamanager-v1-php .
  3. Выполните следующую команду для разрешения зависимостей библиотеки:

    composer update --prefer-dist
    
  4. В файле composer.json вашего PHP-проекта на том же хосте объявите зависимость от библиотеки API диспетчера данных, выполнив следующие шаги:

    1. Добавьте раздел repositories , указывающий на расположение каталога google-cloud-ads-datamanager-v1-php .

      "repositories" : [
         {
            "type" : "path",
            "url" : "PATH_TO_CLIENT_LIBRARY"
         }
      ]
      
    2. Объявите зависимость от библиотеки API Data Manager.

      "require": {
         "googleads/data-manager": "^0.1.0"
      }
      
  5. (Необязательно) Получите библиотеку утилит и примеры кода.

    1. Загрузите и распакуйте data-manager-php.tar.gz .
    2. Перейдите в каталог data-manager-php .
    3. Выполните следующую команду для разрешения зависимостей библиотеки:

      composer update --prefer-dist
      
    4. В файле composer.json вашего PHP-проекта на том же хосте объявите зависимость от служебной библиотеки, выполнив следующие шаги:

      1. Добавьте в раздел repositories запись, указывающую на расположение каталога data-manager-php .

        "repositories" : [
           {
              "type" : "path",
              "url" : "PATH_TO_UTILITY_LIBRARY"
           }
        ]
        
      2. Объявите зависимость от служебной библиотеки.

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

      Для форматирования данных используйте утилиту Formatter в вашем PHP-проекте.

    5. Просмотрите примеры кода в подкаталоге samples . Запустите примеры, выполнив следующие шаги:

      1. Перейдите в каталог samples .

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

        export DATA_MANAGER_PHP_LIB="PATH_TO_CLIENT_LIBRARY"
        
      3. Выполните следующую команду для разрешения зависимостей библиотеки:

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

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