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
    },
    "program": string,
    "buyerCustomParameters": {
      string: 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. Допустимы и другие типы нормализации. Примеры: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30".
product.startTime

string (Timestamp format)

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

Используется формат RFC 3339. Результат всегда будет Z-нормализованным, и в нем будут использоваться цифры дробных частей 0, 3, 6 или 9. Допустимы и другие типы нормализации. Примеры: "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. Допустимы и другие типы нормализации. Примеры: "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)

Необязательное поле. Конфигурация выбора целевой аудитории, которая применяется на уровне сделки на бирже.
product.targetingCriteria

object (TargetingCriteria)

Только для вывода. Ссылки на критерии таргетинга на товары. Применимо только к сценариям мгновенных сделок.
product.forecastResult

object (ForecastResult)

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

object (ErrorDetails)

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

object (FrequencyCap)

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

string

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

map (key: string, value: string)

Только для вывода. Специальные параметры "ключ-значение", заданные покупателем в запросе мгновенной сделки. Применимо только к сценариям мгновенных сделок.

Объект содержит список из нескольких пар ("key": value). Пример: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
product.etag

string

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

string (FieldMask format)

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

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

Тело ответа

Если ответ получен успешно, его тело содержит экземпляр Product.

Области авторизации

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

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

Дополнительную информацию вы найдете в OAuth 2.0 Overview.