REST Resource: accounts.promotions

Ressource: Angebot

Stellt ein Angebot dar. Weitere Informationen finden Sie in den folgenden Artikeln.

Die erforderlichen Eingabeattribute für Angebote, die die Datenvalidierungsüberprüfungen bestehen müssen, werden hauptsächlich unten definiert:

Nach dem Einfügen oder Aktualisieren eines Angebots kann es einige Minuten dauern, bis das endgültige Angebot abgerufen werden kann.

JSON-Darstellung 
{
  "name": string,
  "promotionId": string,
  "contentLanguage": string,
  "targetCountry": string,
  "redemptionChannel": [
    enum (RedemptionChannel)
  ],
  "dataSource": string,
  "attributes": {
    object (Attributes)
  },
  "customAttributes": [
    {
      object (CustomAttribute)
    }
  ],
  "promotionStatus": {
    object (PromotionStatus)
  },
  "versionNumber": string
}
Felder
name

string

Kennung. Der Name der Werbeaktion. Format: accounts/{account}/promotions/{promotion}
promotionId

string

Erforderlich. Die vom Nutzer angegebene Angebots-ID, um das Angebot eindeutig zu identifizieren. Beachten Sie die Mindestanforderungen, um Ablehnungen von Angeboten zu vermeiden.
contentLanguage

string

Erforderlich. Der aus zwei Buchstaben bestehende ISO 639-1-Sprachcode für das Angebot.

Angebote sind nur in ausgewählten Sprachen verfügbar.
targetCountry

string

Erforderlich. Das Zielland, das als Teil der eindeutigen Kennung verwendet wird. Wird als CLDR-Regionalcode dargestellt.

Angebote sind nur in ausgewählten Ländern verfügbar. Produkteinträge und Shopping-Anzeigen Anzeigen für lokales Inventar
redemptionChannel[]

enum (RedemptionChannel)

Erforderlich. Art der Einlösung für das Angebot. Es ist mindestens ein Channel ist erforderlich.
dataSource

string

Nur Ausgabe. Die primäre Datenquelle der Werbung.
attributes

object (Attributes)

Optional. Eine Liste von Angebotsattributen.
customAttributes[]

object (CustomAttribute)

Optional. Eine Liste benutzerdefinierter (vom Händler bereitgestellt) Attribute. Außerdem kann es zum Einreichen beliebiger Attribute der Datenspezifikation in ihrer generischen Form (z. B. { "name": "size type", "value": "regular" }) verwendet werden. Das ist nützlich, um Attribute einzureichen, die nicht explizit von der API bereitgestellt werden.
promotionStatus

object (PromotionStatus)

Nur Ausgabe. Status eines Angebots, Probleme mit der Datenvalidierung, d. h. Informationen zu einem Angebot, die asynchron berechnet werden.
versionNumber

string (int64 format)

Optional. Stellt die vorhandene Version (Aktualität) des Angebots dar. Damit kann die richtige Reihenfolge bei mehreren gleichzeitigen Aktualisierungen beibehalten werden.

Wenn diese Option festgelegt ist, wird die Einfügung verhindert, wenn die Versionsnummer niedriger als die aktuelle Versionsnummer der vorhandenen Werbeaktion ist. Die erneute Einfügung (z. B. Aktualisierung des Angebots nach 30 Tagen) kann mit der aktuellen versionNumber erfolgen.

Wenn der Vorgang verhindert wird, wird die abgebrochene Ausnahme ausgelöst.

RedemptionChannel

Kanal einer Werbeaktion.

Enums
REDEMPTION_CHANNEL_UNSPECIFIED Gibt an, dass der Kanal nicht angegeben ist.
IN_STORE Gibt an, dass der Kanal im Geschäft verfügbar ist. Dies ist derselbe local-Kanal, der für products verwendet wird.
ONLINE Gibt an, dass der Kanal online ist.

Attribute

Attribute

JSON-Darstellung 
{
  "productApplicability": enum (ProductApplicability),
  "offerType": enum (OfferType),
  "genericRedemptionCode": string,
  "longTitle": string,
  "couponValueType": enum (CouponValueType),
  "promotionDestinations": [
    enum (DestinationEnum)
  ],
  "itemIdInclusion": [
    string
  ],
  "brandInclusion": [
    string
  ],
  "itemGroupIdInclusion": [
    string
  ],
  "productTypeInclusion": [
    string
  ],
  "itemIdExclusion": [
    string
  ],
  "brandExclusion": [
    string
  ],
  "itemGroupIdExclusion": [
    string
  ],
  "productTypeExclusion": [
    string
  ],
  "minimumPurchaseAmount": {
    object (Price)
  },
  "minimumPurchaseQuantity": string,
  "limitQuantity": string,
  "limitValue": {
    object (Price)
  },
  "percentOff": string,
  "moneyOffAmount": {
    object (Price)
  },
  "getThisQuantityDiscounted": string,
  "freeGiftValue": {
    object (Price)
  },
  "freeGiftDescription": string,
  "freeGiftItemId": string,
  "promotionEffectiveTimePeriod": {
    object (Interval)
  },
  "promotionDisplayTimePeriod": {
    object (Interval)
  },
  "storeApplicability": enum (StoreApplicability),
  "storeCodesInclusion": [
    string
  ],
  "storeCodesExclusion": [
    string
  ],
  "promotionUrl": string
}
Felder
productApplicability

enum (ProductApplicability)

Erforderlich. Gültigkeit für das Angebot auf alle Produkte oder nur auf bestimmte Produkte
offerType

enum (OfferType)

Erforderlich. Art des Angebots. Verwenden Sie dieses Attribut, um anzugeben, ob Kunden einen Gutscheincode benötigen, um Ihr Angebot einzulösen.
genericRedemptionCode

string

Optional. Generischer Gutscheincode für das Angebot. Muss mit dem Feld offerType verwendet werden und die Mindestanforderungen erfüllen.
longTitle

string

Erforderlich. Langer Titel für das Angebot.
couponValueType

enum (CouponValueType)

Erforderlich. Das Attribut Gutschein-Werttyp gibt an, welche Art von Angebot Sie machen. Je nach Typ des ausgewählten Gutscheinwerts sind einige Attribute erforderlich.
promotionDestinations[]

enum (DestinationEnum)

Erforderlich. Liste der Ziele, für die das Angebot gilt. Wenn Sie in der Datenquelle einen unterstützten Wert nicht als Ziel angeben, erscheint Ihr Angebot standardmäßig in Shopping-Anzeigen und Produkteinträgen.

Möglicherweise haben Sie die folgenden Werte als Zielanwendungen für Ihre Produkte eingereicht: Shopping Actions, Plattformen auf Google, Plattformen für lokales Inventar auf Google. Verwenden Sie FREE_LISTINGS, FREE_LOCAL_LISTINGS und LOCAL_INVENTORY_ADS, um diese Werte darzustellen. Weitere Informationen finden Sie unter Ziel des Angebots.
itemIdInclusion[]

string

Optional. Produktfilter für das Angebot nach Artikel-ID. Die Produktfilterattribute gelten nur, wenn das Attribut „Produkte, für die das Angebot gilt“ productApplicability auf specific_products festgelegt wurde.
brandInclusion[]

string

Optional. Produktfilter nach Marke für das Angebot. Die Produktfilterattribute gelten nur, wenn das Attribut „Produkte, für die das Angebot gilt“ productApplicability auf specific_products festgelegt wurde.
itemGroupIdInclusion[]

string

Optional. Produktfilter für das Angebot nach Artikelgruppen-ID. Die Produktfilterattribute gelten nur, wenn das Attribut „Produkte, für die das Angebot gilt“ [productApplicability] auf „Bestimmte Produkte“ specific_products festgelegt ist.
productTypeInclusion[]

string

Optional. Produktfilter nach Produkttyp für das Angebot. Die Produktfilterattribute gelten nur, wenn das Attribut „Produkte, für die das Angebot gilt“ productApplicability auf specific_products festgelegt wurde.
itemIdExclusion[]

string

Optional. Produktfilter nach Artikel-ID-Ausschluss für das Angebot. Die Produktfilterattribute gelten nur, wenn das Attribut „Produkte, für die das Angebot gilt“ productApplicability auf specific_products festgelegt wurde.
brandExclusion[]

string

Optional. Produktfilter nach Markenausschluss für das Angebot. Die Produktfilterattribute gelten nur, wenn das productApplicability-Attribut für Produkte, für die das Angebot gilt, auf specific_products festgelegt ist.
itemGroupIdExclusion[]

string

Optional. Produktfilter nach Artikelgruppen-ID Die Produktfilterattribute gelten nur, wenn das Attribut „Produkte, für die das Angebot gilt“ productApplicability auf specific_products festgelegt wurde.
productTypeExclusion[]

string

Optional. Produktfilter nach Produkttyp-Ausschluss für das Angebot. Die Produktfilterattribute gelten nur, wenn das productApplicability-Attribut für Produkte, für die das Angebot gilt, auf specific_products festgelegt ist.
minimumPurchaseAmount

object (Price)

Optional. Mindestbestellwert für das Angebot.
minimumPurchaseQuantity

string (int64 format)

Optional. Mindestbestellmenge für das Angebot.
limitQuantity

string (int64 format)

Optional. Maximale Kaufmenge für das Angebot.
limitValue

object (Price)

Optional. Maximaler Produktpreis für das Angebot.
percentOff

string (int64 format)

Optional. Der in der Aktion angebotene Rabatt in Prozent.
moneyOffAmount

object (Price)

Optional. Der Rabattbetrag, der in der Aktion angeboten wird.
getThisQuantityDiscounted

string (int64 format)

Optional. Die Anzahl der Artikel, für die das Angebot gilt. Das Attribut wird festgelegt, wenn couponValueType mit buy_m_get_n_money_off oder buy_m_get_n_percent_off übereinstimmt.
freeGiftValue

object (Price)

Optional. Geschenkwert für das Angebot.
freeGiftDescription

string

Optional. Beschreibung des Geschenks für das Angebot.
freeGiftItemId

string

Optional. Artikel-ID des Geschenks für das Angebot.
promotionEffectiveTimePeriod

object (Interval)

Erforderlich. TimePeriod-Darstellung für den Gültigkeitszeitraum des Angebots. Dieses Attribut gibt an, dass das Angebot während dieses Zeitraums in Ihrem Onlineshop getestet werden kann.
promotionDisplayTimePeriod

object (Interval)

Optional. TimePeriod-Darstellung der Verfügbarkeitsdaten des Angebots. Dieses Attribut gibt das Datum und den Zeitraum an, in dem die Aktion in der Google-Suche und in Shopping-Anzeigen online ist. Wenn der Gültigkeitszeitraum des Angebots promotionDisplayTimePeriod nicht angegeben ist, werden Datum und Zeitraum, in dem das Angebot auf Google und in Shopping-Anzeigen veröffentlicht wird, durch den Gültigkeitszeitraum des Angebots promotionEffectiveTimePeriod bestimmt.
storeApplicability

enum (StoreApplicability)

Optional. Gibt an, ob das Angebot für alle Geschäfte oder nur für bestimmte Geschäfte gilt. Bei Angeboten für Anzeigen für lokales Inventar wird ein Fehler ausgegeben, wenn keine Gültigkeit für Geschäfte angegeben ist. Ein INVALID_ARGUMENT-Fehler wird ausgegeben, wenn storeApplicability auf ALL_STORES und storeCodesInclusion oder score_code_exclusion auf einen Wert festgelegt ist.
storeCodesInclusion[]

string

Optional. Zu berücksichtigende Händlercodes für das Angebot. Die Geschäftsfilterattribute gelten nur, wenn das Attribut storeApplicability auf specific_stores festgelegt ist.

Geschäftscode (Geschäfts-ID aus Ihrem Unternehmensprofil) des Ladengeschäfts, in dem das Produkt verkauft wird. Weitere Informationen finden Sie in der Datenspezifikation für lokales Inventar.
storeCodesExclusion[]

string

Optional. Ausgeschlossene Geschäftscodes für das Angebot. Die Geschäftsfilterattribute gelten nur, wenn das Attribut storeApplicability auf specific_stores festgelegt ist.
promotionUrl

string

Optional. URL der Seite auf der Website des Händlers, auf der das Angebot angezeigt wird. Bei Angeboten für Anzeigen für lokales Inventar wird ein Fehler ausgegeben, wenn promotionUrl nicht angegeben ist. Mit dieser URL wird geprüft, ob das Angebot gültig und einlösbar ist.

ProductApplicability

Für welches Produkt oder welche Produkte das Angebot gilt.

Enums
PRODUCT_APPLICABILITY_UNSPECIFIED Für welche Produkte das Angebot gilt, ist unbekannt.
ALL_PRODUCTS Gilt für alle Produkte.
SPECIFIC_PRODUCTS Gilt nur für ein einzelnes Produkt oder eine Liste von Produkten.

OfferType

Angebotstyp einer Werbeaktion.

Enums
OFFER_TYPE_UNSPECIFIED Unbekannter Angebotstyp.
NO_CODE Angebotstyp ohne Code.
GENERIC_CODE Angebotstyp mit einem Code. Ein generischer Gutscheincode für das Angebot ist erforderlich, wenn offerType = GENERIC_CODE.

CouponValueType

Gutschein-Werttyp eines Angebots.

Enums
COUPON_VALUE_TYPE_UNSPECIFIED Gibt an, dass der Gutscheinwerttyp nicht angegeben ist.
MONEY_OFF Gutschein-Werttyp für Rabatt.
PERCENT_OFF Gutschein-Werttyp „Rabatt in Prozent“.
BUY_M_GET_N_MONEY_OFF Gutscheinwerttyp „Bei Kauf von „M“ Rabattbetrag „N“ erhalten“ minimumPurchaseQuantity und getThisQuantityDiscounted müssen vorhanden sein. moneyOffAmount muss ebenfalls vorhanden sein.
BUY_M_GET_N_PERCENT_OFF Wenn du eine Menge von „M“ kaufst, erhältst du N % Rabatt auf den Gutscheinwerttyp. minimumPurchaseQuantity und getThisQuantityDiscounted müssen vorhanden sein. percent_off_percentage muss ebenfalls vorhanden sein.
BUY_M_GET_MONEY_OFF Wenn du eine Menge in „M“ kaufst, erhältst du Rabatt. minimumPurchaseQuantity und moneyOffAmount müssen vorhanden sein.
BUY_M_GET_PERCENT_OFF Beim Kauf von „M“ Rabatt erhalten. minimumPurchaseQuantity und percent_off_percentage müssen vorhanden sein.
FREE_GIFT Geschenk mit Beschreibung
FREE_GIFT_WITH_VALUE Geschenk mit Geldwert.
FREE_GIFT_WITH_ITEM_ID Geschenk mit Artikel-ID
FREE_SHIPPING_STANDARD Standardwerttyp für Gutscheine für kostenlosen Versand.
FREE_SHIPPING_OVERNIGHT Gutschein-Werttyp für kostenlosen Versand über Nacht.
FREE_SHIPPING_TWO_DAY Gutschein-Werttyp für kostenlosen Versand innerhalb von zwei Tagen.

DestinationEnum

Zielwerte.

Enums
DESTINATION_ENUM_UNSPECIFIED Nicht angegeben.
SHOPPING_ADS Shopping-Anzeigen:
DISPLAY_ADS Displayanzeigen
LOCAL_INVENTORY_ADS Anzeigen für lokales Inventar:
FREE_LISTINGS Produkteinträge:
FREE_LOCAL_LISTINGS Lokale Produkteinträge:
YOUTUBE_SHOPPING YouTube Shopping
YOUTUBE_SHOPPING_CHECKOUT YouTube Shopping-Bezahlvorgang
YOUTUBE_AFFILIATE YouTube-Affiliate.
FREE_VEHICLE_LISTINGS Kostenlose Fahrzeugeinträge.
VEHICLE_ADS Fahrzeuganzeigen
CLOUD_RETAIL Cloud Retail
LOCAL_CLOUD_RETAIL Lokaler Cloud-Einzelhandel

StoreApplicability

Geschäftscodes oder Liste der Geschäftscodes, auf die sich das Angebot bezieht. Nur für Anzeigen für lokales Inventar.

Enums
STORE_APPLICABILITY_UNSPECIFIED Für welche Geschäftscodes das Angebot gilt, ist unbekannt.
ALL_STORES Das Angebot gilt für alle Geschäfte.
SPECIFIC_STORES Das Angebot gilt nur für die angegebenen Geschäfte.

PromotionStatus

Der Status der Werbeaktion.

JSON-Darstellung 
{
  "destinationStatuses": [
    {
      object (DestinationStatus)
    }
  ],
  "itemLevelIssues": [
    {
      object (ItemLevelIssue)
    }
  ],
  "creationDate": string,
  "lastUpdateDate": string
}
Felder
destinationStatuses[]

object (DestinationStatus)

Nur Ausgabe. Die vorgesehenen Ziele des Angebots.
itemLevelIssues[]

object (ItemLevelIssue)

Nur Ausgabe. Eine Liste der Probleme im Zusammenhang mit dem Angebot.
creationDate

string (Timestamp format)

Nur Ausgabe. Datum, an dem das Angebot erstellt wurde, im ISO 8601-Format: Datum, Uhrzeit und Zeitzonenoffset, z. B. 2020-01-02T09:00:00+01:00 oder 2020-01-02T09:00:00Z
lastUpdateDate

string (Timestamp format)

Nur Ausgabe. Datum der letzten Aktualisierung des Angebotsstatus im ISO 8601-Format: Datum, Uhrzeit und Offset, z. B. 2020-01-02T09:00:00+01:00 oder 2020-01-02T09:00:00Z

DestinationStatus

Der Status für das angegebene Ziel.

JSON-Darstellung 
{
  "reportingContext": enum (ReportingContextEnum),
  "status": enum (State)
}
Felder
reportingContext

enum (ReportingContextEnum)

Nur Ausgabe. Der Name des Angebotsziels.
status

enum (State)

Nur Ausgabe. Der Status für das angegebene Ziel.

Status

Der aktuelle Status der Werbeaktion.

Enums
STATE_UNSPECIFIED Unbekannter Angebotsstatus.
IN_REVIEW Das Angebot wird überprüft.
REJECTED Das Angebot wurde abgelehnt.
LIVE Das Angebot wurde genehmigt und aktiv.
STOPPED Das Angebot wurde vom Händler beendet.
EXPIRED Das Angebot ist nicht mehr aktiv.
PENDING Das Angebot ist nicht beendet und alle Überprüfungen wurden genehmigt, das aktive Datum liegt jedoch in der Zukunft.

ItemLevelIssue

Das mit dem Angebot verbundene Problem.

JSON-Darstellung 
{
  "code": string,
  "severity": enum (Severity),
  "resolution": string,
  "attribute": string,
  "reportingContext": enum (ReportingContextEnum),
  "description": string,
  "detail": string,
  "documentation": string,
  "applicableCountries": [
    string
  ]
}
Felder
code

string

Nur Ausgabe. Der Fehlercode des Problems
severity

enum (Severity)

Nur Ausgabe. Wie sich dieses Problem auf die Auslieferung des Angebots auswirkt.
resolution

string

Nur Ausgabe. Ob das Problem vom Händler behoben werden kann.
attribute

string

Nur Ausgabe. Der Attributname, falls das Problem durch ein einzelnes Attribut verursacht wird.
reportingContext

enum (ReportingContextEnum)

Nur Ausgabe. Das Ziel, das von dem Problem betroffen ist.
description

string

Nur Ausgabe. Eine kurze Problembeschreibung in Englisch.
detail

string

Nur Ausgabe. Ausführliche Problembeschreibung in Englisch.
documentation

string

Nur Ausgabe. Die URL einer Webseite, die bei der Lösung des Problems helfen kann.
applicableCountries[]

string

Nur Ausgabe. Liste der Ländercodes (ISO 3166-1 alpha-2), bei denen das Problem auf das Angebot zutrifft.

Schweregrad

Schweregrad des Problems

Enums
SEVERITY_UNSPECIFIED Nicht angegeben.
NOT_IMPACTED Dieses Problem ist eine Warnung und hat keine direkten Auswirkungen auf das Angebot.
DEMOTED Das Angebot wird herabgestuft und hat höchstwahrscheinlich eine eingeschränkte Leistung in den Suchergebnissen.
DISAPPROVED Das Angebot wird aufgrund des Problems abgelehnt.

Methoden

get

 Ruft das Angebot aus Ihrem Merchant Center-Konto ab.

insert

 Fügt ein Angebot für Ihr Merchant Center-Konto ein.

list

 Listet die Angebote in Ihrem Merchant Center-Konto auf.