Method: exchanges.orders.products.patch

Aktualisiert ein Produkt.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
product.name

string

Relativer Routenname für das Produkt. Vom Server generiert. Beispiel: „exchanges/1234/orders/5678/products/abc“. Nur Ausgabe.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung
{
  "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
}
Felder
product.displayName

string

Der Anzeigename des Produkts.

Muss UTF-8-codiert sein und darf maximal 240 Byte groß sein. Erforderlich.

product.externalDealId

string

Externe ID. Das ist die Deal-ID im Anzeigenplattformsystem. Max. 100 Zeichen. Zulässige Zeichen sind alphanumerische Zeichen, Unterstriche, Bindestriche und Punkte. Muss für alle Produkte eindeutig sein. Erforderlich.

product.transactionType

enum (TransactionType)

Produkttransaktionstyp. Erforderlich.

product.pricingType

enum (PricingType)

Preistyp für das Produkt. Erforderlich.

product.updateTime
(deprecated)

string (Timestamp format)

Der Zeitstempel, der angibt, wann das Produkt zuletzt aktualisiert wurde.

Es wird RFC 3339 verwendet, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Glieder mit Dezimalstellen enthält. Andere Achsenbezeichnungen als „Z“ sind ebenfalls zulässig. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

product.startTime

string (Timestamp format)

Zeitpunkt, zu dem dieses Produkt aktiv wird. Muss vor endTime liegen. Der Beginn darf nicht mehr als ein Jahr in der Zukunft liegen. Erforderlich.

Es wird RFC 3339 verwendet, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Glieder mit Dezimalstellen enthält. Andere Achsenbezeichnungen als „Z“ sind ebenfalls zulässig. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

product.endTime

string (Timestamp format)

Zeitpunkt, zu dem dieses Produkt inaktiv wird. Derzeit darf das Jahr nicht später als 2036 sein. Erforderlich.

Es wird RFC 3339 verwendet, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Glieder mit Dezimalstellen enthält. Andere Achsenbezeichnungen als „Z“ sind ebenfalls zulässig. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

product.rateDetails

object (RateDetails)

Preisdetails Erforderlich.

product.creativeConfig[]

object (CreativeConfig)

Die Creative-Anforderungen für ein Produkt. Erforderlich für Produkte mit reserviertem Transaktionstyp.

product.makegood
(deprecated)

boolean

Gibt an, ob es sich bei einem Produkt um ein Kulanzprodukt handelt.

product.makegoodDetails
(deprecated)

object (MakegoodDetails)

Die Details zum Kulanzzeitraum für ein Produkt. Erforderlich, wenn es sich bei dem Produkt um ein Kulanzzertifikat handelt.

product.creativeSource

enum (CreativeSource)

Creative-Quelle für ein Produkt. Optional. Standardmäßig wird CREATIVE_SOURCE_ADVERTISER verwendet. Kann nach dem Erstellen des Produkts nicht mehr geändert werden.

product.mediumType

enum (MediumType)

Medientyp für ein Produkt. Wenn keine Angabe erfolgt, ist der Standardwert DIGITAL. Kann nach dem Erstellen des Produkts nicht mehr geändert werden.

product.audienceTargetingConfig

object (AudienceTargetingConfig)

Optional. Die ausgewählte Konfiguration für das Zielgruppen-Targeting wird auf Dealebene auf der Anzeigenplattform angewendet.

product.targetingCriteria

object (TargetingCriteria)

Nur Ausgabe. Verweise auf Kriterien für die Produktausrichtung Gilt nur für Instant-Deal-Szenarien.

product.forecastResult

object (ForecastResult)

Ergebnisse der Produktprognose Erforderlich, wenn die Targeting-Kriterien nicht leer sind und keine Prognose angegeben wurde. Gilt nur für Instant-Deal-Szenarien.

product.errorDetails

object (ErrorDetails)

Fehlerdetails müssen angegeben werden, wenn bestimmte Produktfelder nicht aktualisiert werden können. Erforderlich, wenn das Prognoseergebnis aufgrund eines Targeting-Kriteriens nicht angegeben werden kann oder das Produkt nicht aktualisiert werden kann. Gilt nur für Instant-Deal-Szenarien.

product.frequencyCap

object (FrequencyCap)

Nur Ausgabe. Vom Käufer ausgewähltes Frequency Capping. Gilt nur für Instant-Deal-Szenarien.

product.etag

string

Ein etag, das beim Aktualisieren eines Produkts angegeben werden muss. Es muss nur für eine Aktualisierung angegeben werden, wenn das etag-Feld nicht leer ist. Gilt nur für Instant-Deal-Szenarien.

updateMask

string (FieldMask format)

Die Maske, um zu steuern, welche Felder aktualisiert werden. Erforderlich.

Dies ist eine durch Kommas getrennte Liste vollständig qualifizierter Feldnamen. Beispiel: "user.displayName,photo".

Antworttext

Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von Product.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie unter OAuth 2.0 Overview.