- Ressource: Product
- CreativeConfig
- CreativeType
- DimensionCreativeConfig
- DurationCreativeConfig
- DurationMatchType
- SkippableMatchType
- MakegoodDetails
- CreativeSource
- AudienceTargetingConfig
- AudienceType
- TargetingCriteria
- SelectedTargetingOption
- TargetingType
- AudienceSelection
- OrGroup
- TargetingSelection
- ForecastResult
- Prognose
- ForecastCategory
- CpmRange
- ForecastBreakdownData
- ForecastBreakdown
- ErrorDetails
- InstantDealErrorStatus
- FrequencyCap
- TimeUnit
- Methoden
Ressource: Produkt
Produkt
| JSON-Darstellung |
|---|
{ "name": string, "displayName": string, "externalDealId": string, "transactionType": enum ( |
| Felder | |
|---|---|
name |
Relativer Ressourcenname für das Produkt. Vom Server generiert. Beispiel: „exchanges/1234/orders/5678/products/abc“. Nur Ausgabe. |
displayName |
Der Anzeigename des Produkts. Muss UTF-8-codiert sein und darf maximal 240 Byte groß sein. Erforderlich. |
externalDealId |
Externe ID. Dies ist die Deal-ID im Anzeigenplattform-System. Max. 100 Zeichen. Zulässige Zeichen sind alphanumerische Zeichen, Unterstriche, Bindestriche und Punkte. Muss für alle Produkte eindeutig sein. Erforderlich. |
transactionType |
Produktransaktionstyp. Erforderlich. |
pricingType |
Preistyp für das Produkt. Erforderlich. |
updateTime |
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: |
startTime |
Zeitpunkt, zu dem dieses Produkt aktiv wird. Muss vor „endTime“ liegen. Der Beginn darf nicht mehr als 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: |
endTime |
Zeitpunkt, zu dem dieses Produkt inaktiv wird. Darf nicht nach 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: |
rateDetails |
Preisdetails. Erforderlich. |
creativeConfig[] |
Die Creative-Anforderungen für ein Produkt. Erforderlich für reservierte Transaktionstypen. |
makegood |
Gibt an, ob es sich bei einem Produkt um ein Kulanzprodukt handelt. |
makegoodDetails |
Die Details zur Ausgleichsbuchung für ein Produkt. Erforderlich, wenn es sich bei dem Produkt um eine Ausgleichsbuchung handelt. |
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 |
Medientyp für ein Produkt. Wenn keine Angabe gemacht wird, ist der Standardwert DIGITAL (aus Gründen der Abwärtskompatibilität). Kann nach dem Erstellen des Produkts nicht mehr geändert werden. |
audienceTargetingConfig |
Optional. Die Konfiguration des Zielgruppen-Targetings wird auf Deal-Ebene in der Anzeigenplattform angewendet. |
targetingCriteria |
Nur Ausgabe. Referenzen für Produkt-Targeting-Kriterien. Gilt nur für Szenarien mit Instant-Deals. |
forecastResult |
Ergebnisse der Produktprognose. Erforderlich, wenn die Targeting-Kriterien nicht leer sind und die Prognose nicht angegeben ist. Gilt nur für Szenarien mit Instant-Deals. |
errorDetails |
Wenn bestimmte Produktfelder nicht aktualisiert werden können, müssen Fehlerdetails angegeben werden. Erforderlich, wenn das Prognoseergebnis aufgrund eines Targeting-Kriteriums nicht bereitgestellt werden kann oder das Produkt nicht aktualisiert werden kann. Gilt nur für Szenarien mit Instant-Deals. |
frequencyCap |
Nur Ausgabe. Vom Käufer ausgewähltes Frequency Capping. Gilt nur für Szenarien mit Instant-Deals. |
program |
Nur Ausgabe. Das Programm, unter dem der Käufer den Instant-Deal erstellt hat. Leer für den regulären Ablauf des Austauschs. Gilt nur für Szenarien mit Instant-Deals. |
buyerCustomParameters |
Nur Ausgabe. Benutzerdefinierte Parameter für Schlüssel/Wert-Paare, die vom Käufer in der Anfrage für einen Instant-Deal festgelegt wurden. Gilt nur für Szenarien mit Instant-Deals. Ein Objekt, das eine Liste von |
etag |
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 Szenarien mit Instant-Deals. |
CreativeConfig
Konfiguration der Creative-Anforderungen für ein Produkt.
| JSON-Darstellung |
|---|
{ "creativeType": enum ( |
| Felder | |
|---|---|
creativeType |
Creative-Typ. Erforderlich. |
dimensionCreativeConfig |
Die Konfiguration für die Display-Creatives. Dieses Feld wird für native Creatives (CREATIVE_TYPE_NATIVE) nicht unterstützt. |
durationCreativeConfig |
Die Konfiguration für die Video-Creatives. |
CreativeType
Mögliche Creative-Typen.
| Enums | |
|---|---|
CREATIVE_TYPE_UNSPECIFIED |
Creative-Typ nicht angegeben. Kein gültiger Eingabewert. |
CREATIVE_TYPE_DISPLAY |
Creative-Typ „Display“. |
CREATIVE_TYPE_VIDEO |
Creative-Typ „Video“. |
CREATIVE_TYPE_AUDIO |
Creative-Typ „Audio“. |
CREATIVE_TYPE_NATIVE |
Creative-Typ „Nativ“. Dies wird für Produkte des Transaktionstyps „RESERVED“ nicht unterstützt. |
DimensionCreativeConfig
Die Abmessungen des Display-Creatives in Pixeln.
| JSON-Darstellung |
|---|
{ "width": integer, "height": integer } |
| Felder | |
|---|---|
width |
Breite des Display-Creatives. Erforderlich. |
height |
Höhe des Display-Creatives. Erforderlich. |
DurationCreativeConfig
Die Konfiguration für das Creative in der Dauer.
| JSON-Darstellung |
|---|
{ "duration": string, "durationMatchType": enum ( |
| Felder | |
|---|---|
duration |
Die Dauer des Videos in Sekunden. Erforderlich Die Dauer in Sekunden mit bis zu neun Nachkommastellen und am Ende mit „ |
durationMatchType |
Die Übereinstimmungskriterien für die Dauer. |
skippableMatchType |
Der Typ des überspringbaren Video-Creatives. |
DurationMatchType
Übereinstimmungskriterien für die Dauer von Video-Creatives.
| Enums | |
|---|---|
DURATION_MATCH_TYPE_UNSPECIFIED |
Das Kriterium für die Übereinstimmung der Dauer ist in dieser Version nicht angegeben oder unbekannt. Kein gü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
Übereinstimmungskriterien dafür, ob ein Video-Creative überspringbar ist.
| Enums | |
|---|---|
SKIPPABLE_MATCH_TYPE_UNSPECIFIED |
Der Typ „Überspringbar“ ist nicht angegeben oder in dieser Version unbekannt. Kein gü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 |
Die ursprüngliche externe Deal-ID, für die eine Ausgleichsbuchung angefordert wird. Max. 100 Zeichen. Zulässige Zeichen sind alphanumerische Zeichen, Unterstriche, Bindestriche und Punkte. Erforderlich. |
reason |
Grund für die vom Verkäufer initiierte Ausgleichsbuchung. Max. 250 Zeichen. Erforderlich. |
CreativeSource
Creative-Quelle, von der die Creatives ausgeliefert werden.
| Enums | |
|---|---|
CREATIVE_SOURCE_UNSPECIFIED |
Die Creative-Quelle ist in dieser Version nicht angegeben oder unbekannt. Kein gültiger Eingabewert. |
CREATIVE_SOURCE_ADVERTISER |
Creatives werden über DV360 ausgeliefert. |
CREATIVE_SOURCE_PUBLISHER |
Creatives werden vom Publisher ausgeliefert. Vom Publisher gehostete Creatives werden derzeit nicht unterstützt. Jede Anfrage, bei der versucht wird, die Creative-Quelle auf CREATIVE_SOURCE_PUBLISHER festzulegen, schlägt fehl. |
AudienceTargetingConfig
Die Konfiguration für das Zielgruppen-Targeting.
| JSON-Darstellung |
|---|
{
"audienceType": enum ( |
| Felder | |
|---|---|
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 ( |
| Felder | |
|---|---|
selectedTargetingOptions[] |
Ausgewählte Optionen. |
SelectedTargetingOption
Die ausgewählte(n) Targeting-Option(en) für einen einzelnen Targeting-Typ.
| JSON-Darstellung |
|---|
{ "type": enum ( |
| Felder | |
|---|---|
type |
Targeting-Typ, der den ausgewählten Optionen zugeordnet ist. |
Es kann nur ein Auswahltyp einbezogen werden. Die Auswahl muss dem TargetingType entsprechen, der für das Feld type ausgewählt wurde. Im Folgenden finden Sie eine Liste der Felder, die sich gegenseitig ausschließen. In einer Antwort wird höchstens eines der Felder festgelegt: |
|
audienceSelection |
Ausgewählte Zielgruppe. |
targetingSelection |
Generischer Satz ausgewählter Options-IDs. |
| Ende der sich gegenseitig ausschließenden Felder. | |
TargetingType
Targeting-Typen
| Enums | |
|---|---|
TARGETING_TYPE_UNSPECIFIED |
Nicht angegebener Targeting-Typ, ungültig für die Eingabe. |
TARGETING_TYPE_AUDIENCE |
Targeting-Typ „Zielgruppe“. |
TARGETING_TYPE_COUNTRY |
Targeting-Typ „Land“. |
TARGETING_TYPE_DMA |
Targeting-Typ „DMA“. |
TARGETING_TYPE_PROGRAMMER |
Programmierer für Targeting-Typen. |
TARGETING_TYPE_BRAND |
Targeting-Typ „Marke“. |
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 „Web-/App-Umgebung“ |
TARGETING_TYPE_LANGUAGE |
Targeting-Typ: Sprache. |
TARGETING_TYPE_GEO |
Targeting-Typ „Geografie“. |
TARGETING_TYPE_AGE |
Targeting-Typ „Alter“. |
TARGETING_TYPE_GENDER |
Targeting-Typ „Geschlecht“. |
TARGETING_TYPE_CONTEXTUAL_SEGMENT |
Targeting-Typ „Kontextsegment“. |
TARGETING_TYPE_REQUEST_FORMAT |
Anfrageformat für den Targeting-Typ. |
TARGETING_TYPE_PUBLISHER |
Targeting-Typ: Publisher. |
TARGETING_TYPE_INVENTORY_SIZE |
Größe des Targeting-Typs. |
TARGETING_TYPE_NETWORK |
Targeting-Typ „Netzwerk“. |
TARGETING_TYPE_PLATFORM |
Targeting-Typ-Plattform. |
TARGETING_TYPE_VIDEO_DELIVERY_TYPE |
Targeting-Typ „Video-Auslieferungstyp“. |
TARGETING_TYPE_VIDEO_MINIMUM_PLAYER_SIZE |
Targeting-Typ „Mindestgröße des Videoplayers“ |
TARGETING_TYPE_VIDEO_COMPLETION |
Targeting-Typ „Video-Placement“. |
TARGETING_TYPE_VIEWABILITY |
Sichtbarkeit des Targeting-Typs. |
TARGETING_TYPE_REWARDED |
Targeting-Typ „Mit Prämie“. |
TARGETING_TYPE_VIDEO_AD_DURATION_THRESHOLD_SEC |
Targeting-Typ: Schwellenwert für die Dauer der Videoanzeige in Sekunden |
TARGETING_TYPE_VIDEO_PLACEMENT |
Targeting-Typ „Video-Placement“. |
TARGETING_TYPE_VIDEO_PLAYBACK_METHOD |
Targeting-Typ „Videowiedergabe-Methode“. |
TARGETING_TYPE_APP_ID |
Targeting-Typ-App-ID. |
TARGETING_TYPE_DOMAIN_URL |
Targeting-Typ: Domain-URL. |
TARGETING_TYPE_CTR |
Klickrate für Targeting-Typ. |
TARGETING_TYPE_DEMOGRAPHICS |
Targeting-Typ „Demografische Merkmale“. |
TARGETING_TYPE_RESTRICTED_CATEGORY |
Targeting-Typ: eingeschränkte Kategorie. |
TARGETING_TYPE_AD_POSITION |
Anzeigenposition des Targeting-Typs. |
TARGETING_TYPE_DAY_AND_TIME |
Targeting-Typ „Tag und Uhrzeit“ |
TARGETING_TYPE_RETAIL_MEDIA_AUDIENCE |
Targeting-Typ „Retail Media-Zielgruppe“. |
AudienceSelection
Ausgewählte Optionen für das Zielgruppen-Targeting.
| JSON-Darstellung |
|---|
{
"includedOrGroups": [
{
object ( |
| Felder | |
|---|---|
includedOrGroups[] |
Eingeschlossene Optionen werden mit UND verknüpft. Jede eingeschlossene Option kann eine einzelne Option oder eine Gruppe von Optionen sein, die mit ODER verknüpft sind. |
excludedOptionIds[] |
Ausgeschlossene Optionen werden mit ODER verknüpft. |
OrGroup
Eine Gruppe ausgewählter Optionen, die durch ODER verbunden sind.
| JSON-Darstellung |
|---|
{ "optionIds": [ string ] } |
| Felder | |
|---|---|
optionIds[] |
Ausgewählte Options-IDs. |
TargetingSelection
Ausgewählte und ausgeschlossene Targeting-Optionen, die für die meisten Targeting-Typen gelten.
| JSON-Darstellung |
|---|
{ "optionIds": [ string ], "externalIds": [ string ], "excludedOptionIds": [ string ], "excludedExternalIds": [ string ] } |
| Felder | |
|---|---|
optionIds[] |
Nur Ausgabe. Ausgewählte DV3-Targeting-Options-IDs, die mit der Anzeigenplattform geteilt werden. Kann zusammen mit |
externalIds[] |
Nur Ausgabe. IDs der ausgewählten Targeting-Optionen, die von der Anzeigenplattform bereitgestellt werden. Kann zusammen mit |
excludedOptionIds[] |
Nur Ausgabe. Ausgeschlossene DV3-Targeting-Options-IDs, die mit der Anzeigenplattform geteilt werden. Kann zusammen mit |
excludedExternalIds[] |
Nur Ausgabe. IDs der ausgeschlossenen Targeting-Optionen, die von der Anzeigenplattform bereitgestellt werden. Kann zusammen mit |
ForecastResult
Prognoseergebnis angegeben.
| JSON-Darstellung |
|---|
{
"forecasts": [
{
object ( |
| Felder | |
|---|---|
forecasts[] |
Prognose. |
Prognose
Prognose der angegebenen Prognosekategorie.
| JSON-Darstellung |
|---|
{ "forecastCategory": enum ( |
| Felder | |
|---|---|
forecastCategory |
Die angegebene Prognosekategorie, die durch die Prognosestatistik dargestellt wird. |
Es kann nur ein Typ von Statistikdaten enthalten sein. Die eingegebenen Daten müssen dem Feld forecastCategory entsprechen. Im Folgenden finden Sie eine Liste der Felder, die sich gegenseitig ausschließen. In einer Antwort wird höchstens eines der Felder festgelegt: |
|
number |
Zahlendaten. |
percentage |
Prozentuale Daten. |
cpmPrice |
CPM-Preisdaten. |
cpmRange |
Daten zur CPM-Preisspanne. |
forecastBreakdownData |
Daten zur Prognoseaufschlüsselung. |
| Ende der sich gegenseitig ausschließenden Felder. | |
ForecastCategory
Prognosekategorie.
| Enums | |
|---|---|
FORECAST_CATEGORY_UNSPECIFIED |
Kategorie nicht angegeben. Nicht für die Eingabe gültig. |
FORECAST_CATEGORY_TOTAL_OPPORTUNITIES |
Optimierungsmöglichkeiten insgesamt. Zahlendaten. |
FORECAST_CATEGORY_TOTAL_AUDIENCE |
Gesamtes Publikum: Zahlendaten. |
FORECAST_CATEGORY_DIGITAL_TRP |
Digital 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 Prognoseaufschlüsselung. |
CpmRange
Der CPM-Bereich enthält den Mindest- und den Höchstwert des CPM.
| JSON-Darstellung |
|---|
{ "minCpm": { object ( |
| Felder | |
|---|---|
minCpm |
Untergrenze des CPM-Bereichs. |
maxCpm |
Obergrenze des CPM-Bereichs. |
ForecastBreakdownData
Die Daten zur Prognoseaufschlüsselung enthalten eine Liste der Prognoseaufschlüsselungen.
| JSON-Darstellung |
|---|
{
"forecastBreakdowns": [
{
object ( |
| Felder | |
|---|---|
forecastBreakdowns[] |
Eine Liste der Prognoseaufschlüsselungen. |
ForecastBreakdown
Prognoseaufschlüsselung der ausgewählten Targeting-Option.
| JSON-Darstellung |
|---|
{
"selectedTargetingOption": {
object ( |
| Felder | |
|---|---|
selectedTargetingOption |
Die ausgewählte(n) Targeting-Option(en) für einen einzelnen Targeting-Typ. |
| Es kann nur ein Typ von Aufschlüsselungsdaten einbezogen werden. Im Folgenden finden Sie eine Liste der Felder, die sich gegenseitig ausschließen. In einer Antwort wird höchstens eines der Felder festgelegt: | |
impressions |
Prognostizierte Impressionen |
| Ende der sich gegenseitig ausschließenden Felder. | |
ErrorDetails
Fehlerdetails, die angegeben werden, wenn bei der Aktualisierung Fehler auftreten.
| JSON-Darstellung |
|---|
{
"message": string,
"instantDealErrorStatus": enum ( |
| Felder | |
|---|---|
message |
Die Nachricht, die angegeben wird, wenn bei der Aktualisierung Fehler auftreten. |
instantDealErrorStatus |
Der Fehlerstatus, der angegeben wird, wenn bei der Aktualisierung Fehler für die Sofort-Deals auftreten. |
InstantDealErrorStatus
Fehlerstatus, der angegeben wird, wenn bei der Aktualisierung des Sofortdeals Fehler auftreten.
| Enums | |
|---|---|
INSTANT_DEAL_ERROR_STATUS_UNSPECIFIED |
Status unbekannter Fehler. |
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 weist darauf hin, dass ungültige Eingabefelder vorhanden sind. |
FrequencyCap
Die Häufigkeit, mit der einem Nutzer in einem bestimmten Zeitraum dieselbe Anzeige präsentiert werden kann
| JSON-Darstellung |
|---|
{
"timeUnit": enum ( |
| Felder | |
|---|---|
timeUnit |
Die Zeiteinheit, in der das Frequency Capping angewendet wird. |
maxImpressions |
Die maximale Häufigkeit, mit der einem Nutzer in diesem Zeitraum dieselbe Anzeige 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 auf die gesamte Laufzeit angewendet. |
TIME_UNIT_MONTHS |
Das Frequency Capping wird auf eine bestimmte Anzahl von Monaten angewendet. |
TIME_UNIT_WEEKS |
Das Frequency Capping wird auf eine bestimmte Anzahl von Wochen angewendet. |
TIME_UNIT_DAYS |
Das Frequency Capping wird auf eine bestimmte Anzahl von Tagen angewendet. |
Methoden |
|
|---|---|
|
Erstellt ein Produkt. |
|
Ruft ein Produkt ab. |
|
Listet Produkte auf. |
|
Aktualisiert ein Produkt. |