Миграция с версии 1 на версию 2

Последнее обновление: 6 декабря 2022 г.

Перенесите свое приложение

Для перехода с версии 1 на версию 2 необходимо обновить URL-адреса конечных точек для вызова версии 2 и обновить приложение для учета критических изменений.

Обновите вызовы API с версии 1 на версию 2.

Чтобы использовать версию 2 вместо версии 1, вам необходимо обновить свои запросы для использования новых конечных точек версии 2.

Например, чтобы вызвать метод advertisers.get с версией v1, вы должны использовать следующий URL-адрес:

GET https://displayvideo.googleapis.com/v1/advertisers/advertiserId

Для версии 2 обновите URL-адрес следующим образом:

GET https://displayvideo.googleapis.com/v2/advertisers/advertiserId

Если вы используете клиентскую библиотеку для отправки запросов к API, используйте самую последнюю версию клиентской библиотеки и обновите свою конфигурацию, чтобы использовать версию v2.

Внесите необходимые изменения

Мы вносим ряд серьезных изменений в v2. Прочтите следующие инструкции и внесите необходимые изменения, соответствующие вашему текущему использованию API Display & Video 360.

Обновить вызовы методов таргетинга

Обновление вызовов службы advertisers.lineItems

  • Поле inventorySourceIds было удалено. Управляйте назначением источника инвентаря с помощью ресурсов AssignedTargetingOption TARGETING_TYPE_INVENTORY_SOURCE .

  • Следующие значения перечисления LineItemWarningMessage устарели в версии 2 и больше не будут отображаться в LineItem.warningMessages :

    • NO_POSITIVE_AUDIENCE_LIST_TARGETED
    • APP_INSTALL_NO_CONVERSION_PIXEL
    • TARGETING_REVOKED_OR_CLOSED_USER_LIST
    • APP_INSTALL_NO_OPTIMAL_BIDDING_STRATEGY
    • CREATIVE_SIZE_NOT_IN_USE_FOR_TARGETED_DEALS
    • NO_CREATIVE_FOR_TARGETED_DEALS
    • TARGETING_DEPRECATED_GEO_TARGET

  • Поле triggerId было удалено из объекта LineItemFlight , а значение LINE_ITEM_FLIGHT_DATE_TYPE_TRIGGER было удалено из перечислимого типа LineItemFlightDateType . Версия 2 не поддерживает настройку расхода позиций на основе активации триггеров вручную.

Обновление вызовов службы customBiddingAlgorithms

Поля customBiddingAlgorithmState и modelReadiness были заменены полем modelDetails , которое предоставляет состояния готовности и приостановки существующей модели алгоритма для каждого рекламодателя, имеющего доступ через список объектов CustomBiddingModelDetails .

Дополнительные изменения

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

Функции, добавленные в версию 2 после первого запуска, можно найти в наших примечаниях к выпуску .

Доступ только для чтения к позициям YouTube

В версии 2 позиции YouTube и их настройки таргетинга можно получить с помощью сервисов advertisers.lineItems и advertisers.lineItems.targetingTypes.assignedTargetingOptions соответственно. API предоставляет доступ только для чтения. Это означает, что любые попытки записи запросов к этим позициям вернут ошибку. Позиции YouTube будут иметь одно из следующих значений LineItemType :

Новые методы, обеспечивающие лучшую производительность

В версии 2 служба advertisers.lineItems предоставляет новые методы, которые можно использовать вместо пакетных запросов для повышения производительности и снижения потребления квоты:

  • Вы можете использовать advertisers.lineItems.bulkUpdate , чтобы установить одинаковые значения полей для нескольких позиций. В настоящее время поддерживаются только обновления entityStatus .
  • Вы можете использовать advertisers.lineItems.bulkEditAssignedTargetingOptions , чтобы добавлять или удалять одни и те же назначенные параметры таргетинга для нескольких позиций.
  • Вы можете использовать advertisers.lineItems.bulkListAssignedTargetingOptions для получения списка назначенных параметров таргетинга для нескольких позиций.
  • Вы можете использовать advertisers.lineItems.duplicate , чтобы создать дубликат существующей позиции в том же заказе на размещение, скопировав все конфигурации и настройки таргетинга.

Частичный доступ для записи для таргетинга заказа на размещение

В версии 2 вы можете редактировать настройки таргетинга подмножества для ресурсов InsertionOrder , используя новые методы create и delete в службе advertisers.insertionOrders.targetingTypes.assignedTargetingOptions . На уровне заказа на размещение можно полностью управлять следующими типами таргетинга:

  • TARGETING_TYPE_AGE_RANGE
  • TARGETING_TYPE_BROWSER
  • TARGETING_TYPE_CATEGORY
  • TARGETING_TYPE_CHANNEL
  • TARGETING_TYPE_DEVICE_MAKE_MODEL
  • TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION
  • TARGETING_TYPE_ENVIRONMENT
  • TARGETING_TYPE_GENDER
  • TARGETING_TYPE_KEYWORD
  • TARGETING_TYPE_LANGUAGE
  • TARGETING_TYPE_NEGATIVE_KEYWORD_LIST
  • TARGETING_TYPE_OPERATING_SYSTEM
  • TARGETING_TYPE_PARENTAL_STATUS
  • TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION
  • TARGETING_TYPE_VIEWABILITY