Method: exchanges.orders.products.patch

Обновляет продукт.

HTTP-запрос

PATCH https://dv360seller.googleapis.com/v1beta1/{product.name=exchanges/*/orders/*/products/*}

URL-адрес использует синтаксис gRPC Transcoding .

Параметры пути

Параметры
product.name

string

Относительное имя маршрута для продукта. Сгенерировано сервером. Пример: "exchanges/1234/orders/5678/products/abc". Только вывод.

Текст запроса

Тело запроса содержит данные со следующей структурой:

JSON-представление 
{
  "product": {
    "name": string,
    "displayName": string,
    "externalDealId": string,
    "transactionType": enum (TransactionType),
    "pricingType": enum (PricingType),
    "updateTime": string,
    "startTime": string,
    "endTime": string,
    "rateDetails": {
      "rateType": enum (RateType),
      "rate": {
        object (Money)
      },
      "unitsPurchasedCount": string
    },
    "creativeConfig": [
      {
        "creativeType": enum (CreativeType),
        "dimensionCreativeConfig": {
          object (DimensionCreativeConfig)
        },
        "durationCreativeConfig": {
          object (DurationCreativeConfig)
        }
      }
    ],
    "makegood": boolean,
    "makegoodDetails": {
      "originalExternalDealId": string,
      "reason": string
    },
    "creativeSource": enum (CreativeSource),
    "mediumType": enum (MediumType),
    "audienceTargetingConfig": {
      "audienceType": enum (AudienceType)
    },
    "targetingCriteria": {
      "selectedTargetingOptions": [
        {
          object (SelectedTargetingOption)
        }
      ]
    },
    "forecastResult": {
      "forecasts": [
        {
          object (Forecast)
        }
      ]
    },
    "errorDetails": {
      "message": string,
      "instantDealErrorStatus": enum (InstantDealErrorStatus)
    },
    "frequencyCap": {
      "timeUnit": enum (TimeUnit),
      "maxImpressions": string
    },
    "etag": string
  },
  "updateMask": string
}
Поля
product.displayName

string

Отображаемое название продукта.

Должен быть в кодировке UTF-8 с максимальным размером 240 байт. Обязательно.

product.externalDealId

string

Внешний идентификатор. Это идентификатор сделки в системе обмена. Макс. 100 символов. Допустимые символы: буквы, цифры, подчеркивание, тире и точка. Должен быть уникальным для всех продуктов. Обязательно.

product.transactionType

enum ( TransactionType )

Тип транзакции продукта. Обязательно.

product.pricingType

enum ( PricingType )

Тип цены на продукт. Обязательно.

product.updateTime
(deprecated)

string ( Timestamp format)

Временная метка последнего обновления продукта.

Использует RFC 3339, где сгенерированный вывод всегда будет Z-нормализованным и использует 0, 3, 6 или 9 дробных цифр. Смещения, отличные от "Z", также принимаются. Примеры: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30" .

product.startTime

string ( Timestamp format)

Время, когда этот продукт станет активным. Должно быть раньше endTime. Время начала не может быть позже, чем 1 год. Обязательно.

Использует RFC 3339, где сгенерированный вывод всегда будет Z-нормализованным и использует 0, 3, 6 или 9 дробных цифр. Смещения, отличные от "Z", также принимаются. Примеры: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30" .

product.endTime

string ( Timestamp format)

Время, когда этот продукт станет неактивным. В настоящее время не может быть позже 2036 года. Обязательно.

Использует RFC 3339, где сгенерированный вывод всегда будет Z-нормализованным и использует 0, 3, 6 или 9 дробных цифр. Смещения, отличные от "Z", также принимаются. Примеры: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30" .

product.rateDetails

object ( RateDetails )

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

product.creativeConfig[]

object ( CreativeConfig )

Творческие требования к продукту. Требуется для продукта типа зарезервированной транзакции.

product.makegood
(deprecated)

boolean

Указывает, является ли продукт компенсационным продуктом.

product.makegoodDetails
(deprecated)

object ( MakegoodDetails )

Детали компенсации за продукт. Требуется, когда продукт является компенсацией.

product.creativeSource

enum ( CreativeSource )

Источник креатива для продукта. Необязательно, по умолчанию CREATIVE_SOURCE_ADVERTISER. Не может быть изменен после создания продукта.

product.mediumType

enum ( MediumType )

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

product.audienceTargetingConfig

object ( AudienceTargetingConfig )

Необязательно. Выбранная конфигурация таргетинга аудитории применяется на уровне сделки на Exchange.

product.targetingCriteria

object ( TargetingCriteria )

Только вывод. Ссылки на критерии таргетинга продукта. Применимо только к сценариям мгновенной сделки.

product.forecastResult

object ( ForecastResult )

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

product.errorDetails

object ( ErrorDetails )

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

product.frequencyCap

object ( FrequencyCap )

Только вывод. Ограничение частоты выбирается покупателем. Применимо только к сценариям мгновенной сделки.

product.etag

string

etag, который необходимо указать при обновлении продукта. Его необходимо указать только для обновления, если поле etag не пустое. Применимо только к сценариям мгновенных сделок.

updateMask

string ( FieldMask format)

Маска для управления тем, какие поля обновлять. Обязательно.

Это список полностью определенных имен полей, разделенных запятыми. Пример: "user.displayName,photo" .

Тело ответа

В случае успеха тело ответа содержит экземпляр Product .

Области действия авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/doubleclickbidmanager

Для получения более подробной информации см.OAuth 2.0 Overview .