REST Resource: products

Ressource: Produkt

Ein einzelnes Produkt.

JSON-Darstellung
{
  "name": string,
  "externalId": string,
  "displayName": string,
  "description": string,
  "labels": {
    string: string,
    ...
  },
  "creativeSpecifications": [
    {
      object (CreativeSpecification)
    }
  ],
  "bookingLeadTime": string,
  "assignmentLeadTime": string,
  "minFlightDuration": string,
  "maxFlightDuration": string,
  "slotDuration": string,
  "createTime": string,
  "updateTime": string,
  "currencyCode": string
}
Felder
name

string

Der Ressourcenname des Produkts im Format products/{id}. z. B. products/product123.

externalId

string

Optional. Eine ID, mit der diese Entität externen Quellen zugeordnet wird.

displayName

string

Erforderlich. Der Anzeigename des Produkts.

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

description

string

Optional. Zusätzliches freies Feld zur Beschreibung des Produkts.

labels

map (key: string, value: string)

Optional. Die frei definierbaren Labels zur Beschreibung des Produkts.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

creativeSpecifications[]

object (CreativeSpecification)

Erforderlich. Liste der zulässigen Creatives, die für dieses Produkt ausgeliefert werden können.

bookingLeadTime

string (Duration format)

Erforderlich. Erforderliche Vorlaufzeit für die Buchung des Produkts. „Now“ + „BookingLeadTime“ muss nach dem Flugstart liegen.

Dauer in Sekunden mit bis zu neun Nachkommastellen und einem 's' an letzter Stelle. Beispiel: "3.5s".

assignmentLeadTime

string (Duration format)

Erforderlich. Für die Zuweisung von Creatives ist eine Vorlaufzeit erforderlich.

Dauer in Sekunden mit bis zu neun Nachkommastellen und einem 's' an letzter Stelle. Beispiel: "3.5s".

minFlightDuration

string (Duration format)

Optional. Minimale Flight-Dauer für dieses Produkt.

Dauer in Sekunden mit bis zu neun Nachkommastellen und einem 's' an letzter Stelle. Beispiel: "3.5s".

maxFlightDuration

string (Duration format)

Erforderlich. Maximale Flight-Dauer für dieses Produkt.

Dauer in Sekunden mit bis zu neun Nachkommastellen und einem 's' an letzter Stelle. Beispiel: "3.5s".

slotDuration

string (Duration format)

Erforderlich. Slotdauer für dieses Produkt.

Dauer in Sekunden mit bis zu neun Nachkommastellen und einem 's' an letzter Stelle. Beispiel: "3.5s".

createTime

string (Timestamp format)

Nur Ausgabe. Zeitstempel der Erstellung des Produkts.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Nur Ausgabe. Zeitstempel der letzten Aktualisierung für das Produkt.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".

currencyCode

string

Der in ISO 4217 festgelegte Währungscode aus drei Großbuchstaben.

Methoden

create

Erstellt ein neues Produkt.

get

Ruft ein einzelnes Produkt ab.

list

Listet Produkte auf.

patch

Aktualisiert ein vorhandenes Produkt.