Рабочие процессы API

В этом руководстве описаны распространенные рабочие процессы API для создания, отмены, получения, обновления и согласования сделок с использованием API Deal Sync.

Создать сделку

  1. Проверьте, был ли товар уже создан, вызвав команду LIST products с фильтром externalDealId . Обратите внимание, что в строке фильтра поддерживаются как camelCase externalDealId , так и snake_case external_deal_id . external_deal_id должен быть уникальным для всех товаров.

    GET https://dv360seller.googleapis.com/v1beta1/{parent=exchanges/*/orders/*}/products?filter=externalDealId="{external_deal_id}"
    
  2. Создать заказ . Название заказа генерируется системой DV360, и мы рекомендуем сохранить этот идентификатор в вашей системе для последующего использования.

  3. Создайте товар в заказе . Название товара генерируется системой DV360, и мы рекомендуем сохранить этот идентификатор в вашей системе для последующего использования.

В качестве альтернативы вы можете вызвать LIST с external_deal_id . Имя ресурса содержит как идентификатор заказа, так и идентификатор продукта, что позволяет идентифицировать родительский заказ.

Отменить сделку

  1. Обновите статус заказа на «ОТМЕНЕНО» . Отмена поддерживается только в том случае, если заказ еще не был принят. Отмена — это конечное состояние; заказ нельзя повторно активировать после отмены. Если заказ содержал какие-либо товары, их external_deal_id нельзя использовать повторно.

Получите подробную информацию о предложении.

  1. Получите подробную информацию о заказе . Статус обновляется после того, как пользователь принимает, архивирует или отменяет заказ.
  2. Получить подробную информацию о товаре .

Получите список предложений

  1. Список заказов с фильтром по статусу позволяет получить все принятые или ожидающие принятия заказы.
  2. Список товаров, соответствующих фильтру external_deal_id .
  3. Перечислите все товары в заказе.

Обновить предложение

  1. Обновите порядок для указания контактной информации издателя.
    1. name нельзя обновить (его нельзя установить в updateMask ). Статус можно установить только в CANCELED с помощью API.
    2. Невозможно обновить partner_id .
  2. Обновите продукт для обновления условий конкретного предложения.
    1. name , externalDealId , transactionType , pricingType и updateTime не могут быть обновлены.
    2. Для обновления displayName повторное подтверждение пользователем не требуется.
    3. Обновление rateDetails или creativeConfig изменяет статус родительского заказа на PENDING_ACCEPTANCE . Рекламодателям DV360 будет предложено принять новые условия на странице «Переговоры», независимо от того, был ли предыдущий заказ уже принят.

Проверьте, принял ли пользователь предложение.

  1. Получите заказ, если вам известно его название. Проверьте поле status .
  2. Если название заказа не отслеживалось: отобразите список товаров с фильтром external_deal_id , определите название заказа по названию товара , а затем вызовите функцию Get Order . Проверьте поле status .

Проверьте, настроил ли пользователь сделку (только для программно-гарантированных предложений).

  1. Получить источник инвентаризации . Имя ресурса: exchanges/{exchangeId}/inventorysources/{external_deal_id} . Проверить статус покупателя .
    1. Предложения по бронированию:
      1. BUYER_STATUS_ACTIVE : Сделка принята и настроена. Расходы начнутся после того, как DV360 получит запросы на предложения, соответствующие условиям сделки. В процессе настройки сделки автоматически создается позиция. Подробности см. в разделе «Настройка сделки» .
      2. BUYER_STATUS_PENDING : Заказ принят, но сделка еще не настроена. В этом состоянии никаких расходов не производится.
      3. BUYER_STATUS_PAUSED : Сделка приостановлена ​​рекламодателем. В этом состоянии никаких расходов не производится.
    2. Предложения без предварительного бронирования:
      1. BUYER_STATUS_ACTIVE : Сделка принята. Расходы по сделке начнутся, когда DV360 получит соответствующие запросы на ставки, активный пункт сделки будет нацелен на эту сделку, и запросы на ставки будут соответствовать критериям таргетинга пунктов сделки. Подробнее см. в разделе «Пункты сделки» . (Примечание: API продавца для запроса информации о том, нацелена ли сделка на определенные пункты сделки, отсутствует).
      2. BUYER_STATUS_PENDING : Не применяется для сделок, не связанных с бронированием.
      3. BUYER_STATUS_PAUSED : Сделка была явно приостановлена ​​рекламодателем. В этом состоянии никаких расходов не производится.

Приостановить и возобновить сделку после её принятия.

  1. Обновить статус продавца-поставщика товаров на складе.
    1. Приостановка или возобновление показа не прекращает показ предложений. Продавец, приостановивший показ предложения, отображает информационное сообщение рекламодателям в пользовательском интерфейсе DV360, чтобы помочь в решении проблем, связанных с неэффективными предложениями.

Пересмотр условий сделки (обновление условий после их принятия).

Пересмотр условий сделки подразумевает внесение изменений в соглашение после его принятия покупателем. Это позволяет биржам и покупателям корректировать условия существующих сделок. Например, биржа может обнаружить, что время окончания полета по принятой сделке указано неверно; биржа может использовать Product Patch для отправки обновлений покупателям DV360 до начала обслуживания по данной сделке.

Разрешенные и запрещенные изменения

Полный обзор правил ведения переговоров и пересмотра условий сделки можно найти в статьях Справочного центра Display & Video 360: