Method: exchanges.orders.products.patch

Aktualizuje produkt.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
product.name

string

Względna nazwa zasobu produktu. Generowany przez serwer. Przykład: „exchanges/1234/orders/5678/products/abc”. Tylko dane wyjściowe.

Treść żądania

Treść żądania zawiera dane o następującej strukturze:

Zapis 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
}
Pola
product.displayName

string

Wyświetlana nazwa usługi.

Musi być zakodowany w formacie UTF-8 i mieć maksymalny rozmiar 240 bajtów. Wymagane.

product.externalDealId

string

Identyfikator zewnętrzny. Jest to identyfikator umowy w systemie giełdy. Maksymalnie 100 znaków. Dozwolone znaki to znaki alfanumeryczne, podkreślenia, łączniki i kropki. Musi być unikalny wśród wszystkich produktów. Wymagane.

product.transactionType

enum (TransactionType)

Typ transakcji dotyczącej produktu. Wymagane.

product.pricingType

enum (PricingType)

Typ ceny produktu. Wymagane.

product.updateTime
(deprecated)

string (Timestamp format)

Sygnatura czasowa określająca, kiedy produkt został ostatnio zaktualizowany.

Korzysta ze standardu RFC 3339, w którym wygenerowane dane wyjściowe są zawsze znormalizowane do formatu Z i zawierają 0, 3, 6 lub 9 cyfr po przecinku. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".

product.startTime

string (Timestamp format)

Czas, kiedy ten produkt staje się aktywny. Musi być wcześniejsza niż endTime. Czas rozpoczęcia nie może przypadać później niż za rok. Wymagane.

Korzysta ze standardu RFC 3339, w którym wygenerowane dane wyjściowe są zawsze znormalizowane do formatu Z i zawierają 0, 3, 6 lub 9 cyfr po przecinku. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".

product.endTime

string (Timestamp format)

Czas, kiedy ta usługa stanie się nieaktywna. Nie może przypadać później niż w 2036 roku. Wymagane.

Korzysta ze standardu RFC 3339, w którym wygenerowane dane wyjściowe są zawsze znormalizowane do formatu Z i zawierają 0, 3, 6 lub 9 cyfr po przecinku. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".

product.rateDetails

object (RateDetails)

Szczegóły oceny. Wymagane.

product.creativeConfig[]

object (CreativeConfig)

Wymagania dotyczące kreacji dla produktu. Wymagane w przypadku typu transakcji zarezerwowanej.

product.makegood
(deprecated)

boolean

Wskazuje, czy produkt jest produktem rekompensaty.

product.makegoodDetails
(deprecated)

object (MakegoodDetails)

Szczegóły rekompensaty za produkt. Wymagane, gdy produkt jest rekompensatą.

product.creativeSource

enum (CreativeSource)

Źródło kreacji produktu. Opcjonalne, domyślnie CREATIVE_SOURCE_ADVERTISER. Po utworzeniu produktu nie można go zmienić.

product.mediumType

enum (MediumType)

Typ nośnika produktu. Jeśli nie zostanie określona, domyślnie przyjmuje wartość DIGITAL, aby zapewnić zgodność wsteczną. Po utworzeniu produktu nie można go zmienić.

product.audienceTargetingConfig

object (AudienceTargetingConfig)

Opcjonalnie: Konfiguracja kierowania na odbiorców zastosowana na poziomie umowy na giełdzie.

product.targetingCriteria

object (TargetingCriteria)

Tylko dane wyjściowe. Informacje o kryteriach kierowania na produkt. Dotyczy to tylko scenariuszy umów błyskawicznych.

product.forecastResult

object (ForecastResult)

Wyniki prognozy dotyczącej produktu. Wymagane, gdy kryteria kierowania nie są puste i nie podano prognozy. Dotyczy to tylko scenariuszy umów błyskawicznych.

product.errorDetails

object (ErrorDetails)

Jeśli nie można zaktualizować konkretnych pól usługi, należy podać szczegóły błędu. Wymagane, gdy nie można podać wyniku prognozy z powodu kryterium kierowania lub nie można zaktualizować usługi. Dotyczy to tylko scenariuszy umów błyskawicznych.

product.frequencyCap

object (FrequencyCap)

Tylko dane wyjściowe. Limit wyświetleń na użytkownika wybrany przez kupującego. Dotyczy to tylko scenariuszy umów błyskawicznych.

product.program

string

Tylko dane wyjściowe. Program, w ramach którego kupujący utworzył umowę błyskawiczną. Pozostaw puste w przypadku zwykłego przepływu wymiany. Dotyczy to tylko scenariuszy umów błyskawicznych.

product.buyerCustomParameters

map (key: string, value: string)

Tylko dane wyjściowe. Niestandardowe parametry pary klucz-wartość ustawione przez kupującego w żądaniu umowy błyskawicznej. Dotyczy to tylko scenariuszy umów błyskawicznych.

Obiekt zawierający listę par "key": value. Przykład: { "name": "wrench", "mass": "1.3kg", "count": "3" }

product.etag

string

Element etag, który należy podać podczas aktualizowania produktu. W przypadku aktualizacji należy go podać tylko wtedy, gdy pole etag nie jest puste. Dotyczy to tylko scenariuszy umów błyskawicznych.

updateMask

string (FieldMask format)

Maska określająca, które pola mają zostać zaktualizowane. Wymagane.

Jest to rozdzielona przecinkami lista pełnych i jednoznacznych nazw pól. Przykład: "user.displayName,photo".

Treść odpowiedzi

W przypadku powodzenia treść odpowiedzi obejmuje wystąpienie elementu Product.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w OAuth 2.0 Overview.