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 trasy produktu. Wygenerowana 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
    },
    "etag": string
  },
  "updateMask": string
}
Pola
product.displayName

string

Wyświetlana nazwa produktu.

Musi być zakodowana 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, myślniki i kropki. Musi być unikalny we wszystkich produktach. Wymagane.

product.transactionType

enum (TransactionType)

Typ transakcji produktu. Wymagane.

product.pricingType

enum (PricingType)

Typ ceny produktu. Wymagane.

product.updateTime
(deprecated)

string (Timestamp format)

Sygnatura czasowa ostatniej aktualizacji produktu.

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 stanie się aktywny. Musi być wcześniejszy niż endTime. Czas rozpoczęcia nie może być późniejszy niż 1 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 ten produkt stanie się nieaktywny. Obecnie nie może być późniejszy niż rok 2036. 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 stawki. Wymagane.

product.creativeConfig[]

object (CreativeConfig)

Wymagania dotyczące kreacji w przypadku produktu. Wymagane w przypadku produktu z zarezerwowanym typem transakcji.

product.makegood
(deprecated)

boolean

Określa, czy produkt jest produktem rekompensacyjnym.

product.makegoodDetails
(deprecated)

object (MakegoodDetails)

Szczegóły dotyczące produktu rekompensacyjnego. Wymagane, gdy produkt jest rekompensacyjny.

product.creativeSource

enum (CreativeSource)

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

product.mediumType

enum (MediumType)

Typ nośnika w przypadku produktu. Jeśli nie zostanie określony, domyślnie przyjmuje wartość DIGITAL ze względu na zgodność wsteczną. Po utworzeniu produktu nie można go zmienić.

product.audienceTargetingConfig

object (AudienceTargetingConfig)

Opcjonalnie. Wybrana konfiguracja kierowania na odbiorców stosowana na poziomie umowy w usłudze Exchange.

product.targetingCriteria

object (TargetingCriteria)

Tylko dane wyjściowe. Odniesienia do kryteriów kierowania na produkt. Dotyczy tylko scenariuszy natychmiastowych umów.

product.forecastResult

object (ForecastResult)

Wyniki prognozy produktu. Wymagane, gdy kryteria kierowania nie są puste, a prognoza nie jest podana. Dotyczy tylko scenariuszy natychmiastowych umów.

product.errorDetails

object (ErrorDetails)

Gdy nie można zaktualizować określonych pól produktu, należy podać szczegóły błędu. Wymagane, gdy nie można podać wyniku prognozy z powodu kryterium kierowania lub nie można zaktualizować produktu. Dotyczy tylko scenariuszy natychmiastowych umów.

product.frequencyCap

object (FrequencyCap)

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

product.etag

string

Tag etag, który należy podać podczas aktualizowania produktu. Należy go podać tylko w przypadku aktualizacji, jeśli pole etag nie jest puste. Dotyczy tylko scenariuszy natychmiastowych umów.

updateMask

string (FieldMask format)

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

Jest to rozdzielana przecinkami lista pełnych 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.