REST Resource: exchanges.orders.products

Ressource: Produkt

Produkt

JSON-Darstellung 
{
  "name": string,
  "displayName": string,
  "externalDealId": string,
  "transactionType": enum (TransactionType),
  "pricingType": enum (PricingType),
  "updateTime": string,
  "startTime": string,
  "endTime": string,
  "rateDetails": {
    object (RateDetails)
  },
  "creativeConfig": [
    {
      object (CreativeConfig)
    }
  ],
  "makegood": boolean,
  "makegoodDetails": {
    object (MakegoodDetails)
  },
  "creativeSource": enum (CreativeSource),
  "mediumType": enum (MediumType),
  "audienceTargetingConfig": {
    object (AudienceTargetingConfig)
  },
  "targetingCriteria": {
    object (TargetingCriteria)
  },
  "forecastResult": {
    object (ForecastResult)
  },
  "errorDetails": {
    object (ErrorDetails)
  },
  "frequencyCap": {
    object (FrequencyCap)
  },
  "etag": string
}
Felder
name

string

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

string

Der Anzeigename des Produkts.

Muss UTF-8-codiert sein und darf maximal 240 Byte lang sein. Erforderlich.
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.
transactionType

enum (TransactionType)

Produkttransaktionstyp. Erforderlich.
pricingType

enum (PricingType)

Preistyp für das Produkt. Erforderlich.
updateTime
(deprecated)

string (Timestamp format)

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

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
startTime

string (Timestamp format)

Zeitpunkt, zu dem dieses Produkt aktiv wird. Muss vor „endTime“ liegen. Der Beginn darf maximal ein Jahr in der Zukunft liegen. Erforderlich.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

Zeitpunkt, zu dem dieses Produkt inaktiv wird. Derzeit darf es nicht nach dem Jahr 2036 liegen. Erforderlich.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
rateDetails

object (RateDetails)

Preisdetails. Erforderlich.
creativeConfig[]

object (CreativeConfig)

Die Creative-Anforderungen für ein Produkt. Erforderlich für Produkte mit dem reservierten Transaktionstyp.
makegood
(deprecated)

boolean

Gibt an, ob es sich bei einem Produkt um ein Makegood-Produkt handelt.
makegoodDetails
(deprecated)

object (MakegoodDetails)

Die Makegood-Details für ein Produkt. Erforderlich, wenn es sich bei dem Produkt um eine Kulanzleistung handelt.
creativeSource

enum (CreativeSource)

Creative-Quelle für ein Produkt. Optional. Der Standardwert ist CREATIVE_SOURCE_ADVERTISER. Kann nach dem Erstellen des Produkts nicht mehr geändert werden.
mediumType

enum (MediumType)

Medientyp für ein Produkt. Wenn keine Angabe erfolgt, wird aus Gründen der Abwärtskompatibilität standardmäßig DIGITAL verwendet. Kann nach dem Erstellen des Produkts nicht mehr geändert werden.
audienceTargetingConfig

object (AudienceTargetingConfig)

Optional. Die ausgewählte Konfiguration für das Zielgruppentargeting wird auf Exchange auf Dealebene angewendet.
targetingCriteria

object (TargetingCriteria)

Nur Ausgabe. Referenzen für Targeting-Kriterien für Produkte. Gilt nur für Sofortangebote.
forecastResult

object (ForecastResult)

Ergebnisse der Produktprognose. Erforderlich, wenn die Targeting-Kriterien nicht leer sind und die Prognose nicht bereitgestellt wird. Gilt nur für Sofortangebote.
errorDetails

object (ErrorDetails)

Fehlerdetails müssen angegeben werden, wenn bestimmte Produktfelder nicht aktualisiert werden können. Erforderlich, wenn das Prognoseergebnis aufgrund eines Targeting-Kriteriums nicht bereitgestellt werden kann oder das Produkt nicht aktualisiert werden kann. Gilt nur für Sofortangebote.
frequencyCap

object (FrequencyCap)

Nur Ausgabe. Vom Käufer ausgewähltes Frequency Capping. Gilt nur für Sofortangebote.
etag

string

Ein ETag, das beim Aktualisieren eines Produkts angegeben werden muss. Es muss nur für eine Aktualisierung angegeben werden, wenn das Feld „etag“ nicht leer ist. Gilt nur für Sofortangebote.

CreativeConfig

Konfiguration der Creative-Anforderungen für ein Produkt.

JSON-Darstellung 
{
  "creativeType": enum (CreativeType),
  "dimensionCreativeConfig": {
    object (DimensionCreativeConfig)
  },
  "durationCreativeConfig": {
    object (DurationCreativeConfig)
  }
}
Felder
creativeType

enum (CreativeType)

Creative-Typ. Erforderlich.
dimensionCreativeConfig

object (DimensionCreativeConfig)

Die Konfiguration für die Display-Creatives.

Dieses Feld wird für native Creatives (CREATIVE_TYPE_NATIVE) nicht unterstützt.
durationCreativeConfig

object (DurationCreativeConfig)

Die Konfiguration für die Video-Creatives.

CreativeType

Mögliche Creative-Typen.

Enums
CREATIVE_TYPE_UNSPECIFIED Creative-Typ nicht angegeben Ungültiger Eingabewert.
CREATIVE_TYPE_DISPLAY Creative-Typ für Display.
CREATIVE_TYPE_VIDEO Creative-Typ des Videos.
CREATIVE_TYPE_AUDIO Creative-Typ für Audio.
CREATIVE_TYPE_NATIVE Creative-Typ für Native-Anzeigen.

DimensionCreativeConfig

Die Abmessungen des Display-Creatives in Pixeln.

JSON-Darstellung 
{
  "width": integer,
  "height": integer
}
Felder
width

integer

Breite des Display-Creatives. Erforderlich.
height

integer

Höhe des Display-Creatives. Erforderlich.

DurationCreativeConfig

Die Konfiguration für das Creative in Bezug auf die Dauer.

JSON-Darstellung 
{
  "duration": string,
  "durationMatchType": enum (DurationMatchType),
  "skippableMatchType": enum (SkippableMatchType)
}
Felder
duration

string (Duration format)

Die Dauer des Videos in Sekunden. Erforderlich

Die Dauer in Sekunden mit bis zu neun Nachkommastellen und am Ende mit "s". Beispiel: "3.5s".
durationMatchType

enum (DurationMatchType)

Die Dauer entspricht den Kriterien.
skippableMatchType

enum (SkippableMatchType)

Der überspringbare Typ eines Video-Creatives.

DurationMatchType

Mögliche Formate für das Kriterium „Dauer“.

Enums
DURATION_MATCH_TYPE_UNSPECIFIED Das Kriterium für die Dauerübereinstimmung ist in dieser Version nicht angegeben oder unbekannt. Ungültiger Eingabewert.
DURATION_MATCH_TYPE_EQUAL_TO Die Creative-Dauer muss mit der erforderlichen Dauer übereinstimmen.
DURATION_MATCH_TYPE_LESS_THAN_OR_EQUAL_TO Die Creative-Dauer muss der erforderlichen Dauer entsprechen oder kürzer sein.

SkippableMatchType

Mögliche Formate für ein Produkt.

Enums
SKIPPABLE_MATCH_TYPE_UNSPECIFIED Der überspringbare Typ ist in dieser Version nicht angegeben oder unbekannt. Ungültiger Eingabewert.
SKIPPABLE_MATCH_TYPE_SKIPPABLE Das Creative muss überspringbar sein.
SKIPPABLE_MATCH_TYPE_NOT_SKIPPABLE Das Creative darf nicht überspringbar sein.
SKIPPABLE_MATCH_TYPE_ANY Das Creative kann überspringbar oder nicht überspringbar sein.

MakegoodDetails

Die Konfiguration für die Details zur Kulanzleistung.

JSON-Darstellung 
{
  "originalExternalDealId": string,
  "reason": string
}
Felder
originalExternalDealId

string

Die ursprüngliche ID des externen Deals, für den eine Ausgleichsbuchung angefordert wird. Max. 100 Zeichen. Zulässige Zeichen sind alphanumerische Zeichen, Unterstriche, Bindestriche und Punkte. Erforderlich.
reason

string

Grund für die vom Verkäufer initiierte Ausgleichsbuchung. Max. 250 Zeichen. Erforderlich.

CreativeSource

Creative-Quelle: Hier werden die Creatives ausgeliefert.

Enums
CREATIVE_SOURCE_UNSPECIFIED Die Creative-Quelle ist in dieser Version nicht angegeben oder unbekannt. Ungültiger Eingabewert.
CREATIVE_SOURCE_ADVERTISER Creatives werden über DV3 ausgeliefert.
CREATIVE_SOURCE_PUBLISHER Die Creatives werden vom Publisher ausgeliefert. Vom Publisher gehostete Creatives werden derzeit nicht unterstützt. Anfragen, bei denen versucht wird, die Creative-Quelle auf CREATIVE_SOURCE_PUBLISHER festzulegen, schlagen fehl.

AudienceTargetingConfig

Die Konfiguration für das Zielgruppen-Targeting.

JSON-Darstellung 
{
  "audienceType": enum (AudienceType)
}
Felder
audienceType

enum (AudienceType)

Der Zielgruppentyp. Erforderlich.

AudienceType

Zielgruppentyp

Enums
AUDIENCE_TYPE_UNSPECIFIED Nicht angegebener Zielgruppentyp. Nicht für die Eingabe gültig.
AUDIENCE_TYPE_COMMERCE Commerce-Zielgruppentyp.

TargetingCriteria

Targeting-Kriterien angegeben.

JSON-Darstellung 
{
  "selectedTargetingOptions": [
    {
      object (SelectedTargetingOption)
    }
  ]
}
Felder
selectedTargetingOptions[]

object (SelectedTargetingOption)

Ausgewählte Optionen.

SelectedTargetingOption

Die ausgewählte(n) Targeting-Option(en) für einen einzelnen Targeting-Typ.

JSON-Darstellung 
{
  "type": enum (TargetingType),

  // Union field value can be only one of the following:
  "audienceSelection": {
    object (AudienceSelection)
  },
  "targetingSelection": {
    object (TargetingSelection)
  }
  // End of list of possible types for union field value.
}
Felder
type

enum (TargetingType)

Der Ausrichtungstyp, der den ausgewählten Optionen zugeordnet ist.
Union-Feld value. Es kann nur ein Auswahltyp verwendet werden. Die ausgewählte Option muss dem TargetingType entsprechen, der für das Feld „type“ ausgewählt wurde. Für value ist nur einer der folgenden Werte zulässig:
audienceSelection

object (AudienceSelection)

Ausgewählte Zielgruppe.
targetingSelection

object (TargetingSelection)

Allgemeine Gruppe ausgewählter Options‑IDs.

TargetingType

Targeting-Typen

Enums
TARGETING_TYPE_UNSPECIFIED Der Ausrichtungstyp ist nicht angegeben und daher für die Eingabe ungültig.
TARGETING_TYPE_AUDIENCE Zielgruppe für die Ausrichtung.
TARGETING_TYPE_COUNTRY Zielland
TARGETING_TYPE_DMA Targeting-Typ „dma“
TARGETING_TYPE_PROGRAMMER Programmierer des Targeting-Typs.
TARGETING_TYPE_BRAND Marken-Targeting-Typ.
TARGETING_TYPE_CONTENT_GENRE Targeting-Typ „Inhaltsgenre“.
TARGETING_TYPE_DEVICE Targeting-Typ „Gerät“
TARGETING_TYPE_OPERATING_SYSTEM Targeting-Typ „Betriebssystem“.
TARGETING_TYPE_RATING Bewertung des Targeting-Typs.
TARGETING_TYPE_ENVIRONMENT Targeting-Typ „Umgebung“
TARGETING_TYPE_LANGUAGE Sprache des Targeting-Typs.
TARGETING_TYPE_GEO Geografisches Targeting.
TARGETING_TYPE_AGE Targeting-Typ „Alter“
TARGETING_TYPE_GENDER Ausrichtungstyp „Geschlecht“.
TARGETING_TYPE_CONTEXTUAL_SEGMENT Kontextsegment für den Targeting-Typ.
TARGETING_TYPE_REQUEST_FORMAT Anfrageformat für Targeting-Typ.
TARGETING_TYPE_PUBLISHER Targeting-Typ „Publisher“.
TARGETING_TYPE_INVENTORY_SIZE Größe des Targeting-Typs.
TARGETING_TYPE_NETWORK Netzwerk für den Targeting-Typ.
TARGETING_TYPE_PLATFORM Plattform für Targeting-Typ.
TARGETING_TYPE_VIDEO_DELIVERY_TYPE Targeting-Typ für den Video-Auslieferungstyp.
TARGETING_TYPE_VIDEO_MINIMUM_PLAYER_SIZE Targeting-Typ „Mindestgröße des Videoplayers“

AudienceSelection

Ausgewählte Optionen für die Ausrichtung auf Zielgruppen.

JSON-Darstellung 
{
  "includedOrGroups": [
    {
      object (OrGroup)
    }
  ],
  "excludedOptionIds": [
    string
  ]
}
Felder
includedOrGroups[]

object (OrGroup)

Die eingeschlossenen Optionen werden mit AND verknüpft. Jede eingeschlossene Option kann eine einzelne Option oder eine Gruppe von Optionen sein, die mit OR verknüpft sind.
excludedOptionIds[]

string (int64 format)

Ausgeschlossene Optionen werden mit ODER verknüpft.

OrGroup

Eine Gruppe ausgewählter Optionen, die durch ODER verbunden sind.

JSON-Darstellung 
{
  "optionIds": [
    string
  ]
}
Felder
optionIds[]

string (int64 format)

Ausgewählte Options-IDs.

TargetingSelection

Eine Gruppe mit einer oder mehreren ausgewählten Options-IDs, die für die meisten Targeting-Typen gilt.

JSON-Darstellung 
{
  "optionIds": [
    string
  ]
}
Felder
optionIds[]

string (int64 format)

Ausgewählte Options-IDs.

ForecastResult

Das Vorhersageergebnis wird angegeben.

JSON-Darstellung 
{
  "forecasts": [
    {
      object (Forecast)
    }
  ]
}
Felder
forecasts[]

object (Forecast)

Prognose. „forecastCategory“ muss für jedes angegebene Element eindeutig sein.

Prognose

Prognose der angegebenen Prognosekategorie.

JSON-Darstellung 
{
  "forecastCategory": enum (ForecastCategory),

  // Union field forecast_data can be only one of the following:
  "number": string,
  "percentage": integer,
  "cpmPrice": {
    object (Money)
  },
  "cpmRange": {
    object (CpmRange)
  },
  "forecastBreakdownData": {
    object (ForecastBreakdownData)
  }
  // End of list of possible types for union field forecast_data.
}
Felder
forecastCategory

enum (ForecastCategory)

Die angegebene Prognosekategorie, die die Prognosestatistik darstellt.
Union-Feld forecast_data. Es kann nur ein Typ von Statistikdaten enthalten sein. Die eingefügten Daten müssen dem Feld „forecastCategory“ entsprechen. Für forecast_data ist nur einer der folgenden Werte zulässig:
number

string (int64 format)

Zahlendaten.
percentage

integer

Prozentuale Daten.
cpmPrice

object (Money)

CPM-Preisdaten
cpmRange

object (CpmRange)

Daten zum CPM-Preisbereich.
forecastBreakdownData

object (ForecastBreakdownData)

Daten zur Prognosenaufschlüsselung.

ForecastCategory

Prognosekategorie.

Enums
FORECAST_CATEGORY_UNSPECIFIED Nicht angegebene Kategorie. Nicht für die Eingabe gültig.
FORECAST_CATEGORY_TOTAL_OPPORTUNITIES Gesamtzahl der Optimierungsmöglichkeiten. Zahlendaten.
FORECAST_CATEGORY_TOTAL_AUDIENCE Zielgruppe insgesamt Zahlendaten.
FORECAST_CATEGORY_DIGITAL_TRP Digitale Target Rating Points. Prozentuale Daten.
FORECAST_CATEGORY_SUGGESTED_CPM Vorgeschlagener CPM-Preis. CPM-Bereich oder CPM-Preisdaten.
FORECAST_CATEGORY_UNIQUE_REACH Unique Reach prognostizieren Zahlendaten.
FORECAST_CATEGORY_FORECAST_BREAKDOWN Prognosenaufschlüsselung. Daten zur Prognosenaufschlüsselung.

CpmRange

Der CPM-Bereich enthält den Mindest- und Höchst-CPM.

JSON-Darstellung 
{
  "minCpm": {
    object (Money)
  },
  "maxCpm": {
    object (Money)
  }
}
Felder
minCpm

object (Money)

Untergrenze des CPM-Bereichs.
maxCpm

object (Money)

Obergrenze des CPM-Bereichs.

ForecastBreakdownData

„Forecast breakdown data“ enthält eine Liste mit Prognoseaufschlüsselungen.

JSON-Darstellung 
{
  "forecastBreakdowns": [
    {
      object (ForecastBreakdown)
    }
  ]
}
Felder
forecastBreakdowns[]

object (ForecastBreakdown)

Eine Liste mit Prognosenaufschlüsselungen.

ForecastBreakdown

Prognoseaufschlüsselung der ausgewählten Targeting-Option.

JSON-Darstellung 
{
  "selectedTargetingOption": {
    object (SelectedTargetingOption)
  },

  // Union field breakdown_data can be only one of the following:
  "impressions": string
  // End of list of possible types for union field breakdown_data.
}
Felder
selectedTargetingOption

object (SelectedTargetingOption)

Die ausgewählte(n) Targeting-Option(en) für einen einzelnen Targeting-Typ.
Union-Feld breakdown_data. Es können nur Daten für einen Aufschlüsselungstyp enthalten sein. Für breakdown_data ist nur einer der folgenden Werte zulässig:
impressions

string (int64 format)

Impressionen prognostizieren.

ErrorDetails

Fehlerdetails, die angegeben werden, wenn beim Update Fehler auftreten.

JSON-Darstellung 
{
  "message": string,
  "instantDealErrorStatus": enum (InstantDealErrorStatus)
}
Felder
message

string

Die Meldung, die angegeben wird, wenn beim Update Fehler auftreten.
instantDealErrorStatus

enum (InstantDealErrorStatus)

Der Fehlerstatus, der angegeben wird, wenn bei der Aktualisierung von Sofortangeboten Fehler auftreten.

InstantDealErrorStatus

Fehlerstatus, der angegeben wird, wenn bei der sofortigen Aktualisierung des Angebots Fehler auftreten.

Enums
INSTANT_DEAL_ERROR_STATUS_UNSPECIFIED Nicht angegebener Fehlerstatus.
INSTANT_DEAL_ERROR_STATUS_INVENTORY_UNAVAILABLE Der Fehlerstatus gibt an, dass das Inventar nicht verfügbar ist.
INSTANT_DEAL_ERROR_STATUS_FORECAST_UNAVAILABLE Der Fehlerstatus gibt an, dass die Prognose nicht verfügbar ist.
INSTANT_DEAL_ERROR_STATUS_INVALID_INPUT Der Fehlerstatus gibt an, dass ungültige Eingabefelder vorhanden sind.

FrequencyCap

Die Häufigkeit, mit der einem Nutzer in einem bestimmten Zeitraum dieselbe Anzeige präsentiert werden darf

JSON-Darstellung 
{
  "timeUnit": enum (TimeUnit),
  "maxImpressions": string
}
Felder
timeUnit

enum (TimeUnit)

Die Zeiteinheit, in der das Frequency Capping angewendet wird.
maxImpressions

string (int64 format)

Die maximale Häufigkeit, mit der einem Nutzer dieselbe Anzeige in diesem Zeitraum präsentiert werden darf.

TimeUnit

Die Zeiteinheit, in der das Frequency Capping angewendet wird.

Enums
TIME_UNIT_UNSPECIFIED Nicht angegebene Zeiteinheit.
TIME_UNIT_LIFETIME Das Frequency Capping wird für die gesamte Laufzeit angewendet.
TIME_UNIT_MONTHS Das Frequency Capping wird über mehrere Monate hinweg angewendet.
TIME_UNIT_WEEKS Das Frequency Capping wird über mehrere Wochen hinweg angewendet.
TIME_UNIT_DAYS Das Frequency Capping wird auf eine bestimmte Anzahl von Tagen angewendet.

Methoden

create

 Erstellt ein Produkt.

get

 Ruft ein Produkt ab.

list

 Listet Produkte auf.

patch

 Aktualisiert ein Produkt.