REST Resource: accounts.promotions

Ressource: Promotion

Stellt eine Werbeaktion dar. Weitere Informationen finden Sie in den folgenden Artikeln.

Die erforderlichen Eingabeattribute zum Bestehen von Datenvalidierungsprüfungen werden primär definiert:

Nach dem Einfügen und Aktualisieren einer Eingabe für ein bevorzugtes Suchergebnis 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 zur eindeutigen Identifizierung des Angebots. Beachten Sie die Mindestanforderungen, um zu verhindern, dass Angebote abgelehnt werden.
contentLanguage

string

Erforderlich. Der zweistellige ISO 639-1-Sprachcode für das Angebot.

Angebote sind nur für ausgewählte Sprachen verfügbar.
targetCountry

string

Erforderlich. Das Zielland, das als Teil der eindeutigen Kennung verwendet wird. Dargestellt als CLDR-Gebietscode.

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

enum (RedemptionChannel)

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

string

Nur Ausgabe. Die primäre Datenquelle des Angebots.
attributes

object (Attributes)

Optional. Eine Liste der Angebotsattribute.
customAttributes[]

object (CustomAttribute)

Optional. Eine Liste benutzerdefinierter (vom Händler bereitgestellt) Attribute. Sie kann auch verwendet werden, um beliebige Attribute der Datenspezifikation in generischer Form einzureichen (z. B. { "name": "size type", "value": "regular" }). Dies ist nützlich, um Attribute zu senden, die nicht explizit von der API freigegeben wurden.
promotionStatus

object (PromotionStatus)

Nur Ausgabe. Der Status eines Angebots, Probleme mit der Datenvalidierung, d. h. Informationen zu einem asynchron berechneten Angebot.
versionNumber

string (int64 format)

Optional. Stellt die vorhandene Version (Aktualität) des Angebots dar, mit der die richtige Reihenfolge beibehalten werden kann, wenn mehrere Updates gleichzeitig vorgenommen werden.

Wenn festgelegt, wird das Einfügen verhindert, wenn die Versionsnummer niedriger als die aktuelle Versionsnummer des vorhandenen Angebots ist. Mit der aktuellen versionNumber kann ein erneutes Einfügen (z. B. eine Angebotsaktualisierung nach 30 Tagen) durchgeführt werden.

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

RedemptionChannel

Der Kanal einer Werbeaktion.

Enums
REDEMPTION_CHANNEL_UNSPECIFIED Gibt an, dass der Kanal nicht angegeben wurde.
IN_STORE Gibt an, dass der Kanal im Geschäft ist. Dies entspricht dem Kanal local, 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. Typ 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. Zur Verwendung mit dem Feld offerType und muss die Mindestanforderungen erfüllen.
longTitle

string

Erforderlich. Langer Titel für das Angebot.
couponValueType

enum (CouponValueType)

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

enum (DestinationEnum)

Erforderlich. Die Liste der Zielanwendungen, 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 zur Darstellung dieser Werte FREE_LISTINGS, FREE_LOCAL_LISTINGS und LOCAL_INVENTORY_ADS. Weitere Informationen finden Sie unter Zielanwendung des Angebots.
itemIdInclusion[]

string

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

string

Optional. Produktfilter für das Angebot nach Marke. Die Produktfilterattribute gelten nur, wenn das productApplicability-Attribut für Produkte, für die das Angebot gilt, auf specific_products festgelegt ist.
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 für das Angebot nach Produkttyp. Die Produktfilterattribute gelten nur, wenn das productApplicability-Attribut für Produkte, für die das Angebot gilt, auf specific_products festgelegt ist.
itemIdExclusion[]

string

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

string

Optional. Produktfilter für das Angebot nach Markenausschluss. 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 productApplicability-Attribut „Produkte, für die das Angebot gilt“ auf den Ausschluss specific_products festgelegt ist.
productTypeExclusion[]

string

Optional. Produktfilter für das Angebot nach Produkttypausschlüsse. 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 gleich buy_m_get_n_money_off oder buy_m_get_n_percent_off ist.
freeGiftValue

object (Price)

Optional. Geschenkwert für das Angebot.
freeGiftDescription

string

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

string

Optional. Geschenkartikel-ID 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 Anzeigezeitraum für das Angebot promotionDisplayTimePeriod nicht angegeben ist, werden durch den Gültigkeitszeitraum des Angebots promotionEffectiveTimePeriod das Datum und der Zeitraum bestimmt, in dem das Angebot in der Google Suche und in Shopping-Anzeigen online ist.
storeApplicability

enum (StoreApplicability)

Optional. Gibt an, ob das Angebot für alle 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. Wenn storeApplicability auf ALL_STORES und storeCodesInclusion oder score_code_exclusion auf einen Wert festgelegt ist, wird ein INVALID_ARGUMENT-Fehler ausgegeben.
storeCodesInclusion[]

string

Optional. Einzuschließende Geschäftscodes für das Angebot. Die Filialfilterattribute gelten nur, wenn das Attribut storeApplicability auf specific_stores festgelegt ist.

Geschäftscode (die Geschäfts-ID aus Ihrem Unternehmensprofil) des Geschä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 Filialfilterattribute 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 der URL wird bestätigt, dass das Angebot gültig und einlösbar ist.

ProductApplicability

Für welches Produkt oder welche Produktliste 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 Produktliste.

OfferType

Angebotstyp einer Werbeaktion.

Enums
OFFER_TYPE_UNSPECIFIED Unbekannter Angebotstyp.
NO_CODE Angebotstyp ohne Code.
GENERIC_CODE Angebotstyp mit Code. Der generische Gutscheincode für das Angebot ist erforderlich, wenn „offerType“ = „GENERIC_CODE“ ist.

CouponValueType

Gutschein-Werttyp eines Angebots.

Enums
COUPON_VALUE_TYPE_UNSPECIFIED Gibt an, dass der Gutschein-Werttyp nicht angegeben ist.
MONEY_OFF Werttyp des Gutscheins für Geldrabatt.
PERCENT_OFF Werttyp des Gutscheins in Prozent.
BUY_M_GET_N_MONEY_OFF Kaufe eine Menge in „M“, erhalte „N“ Rabatt-Gutschein-Werttyp. 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 Wenn du eine Menge in „M“ kaufst, erhältst du Rabatt. minimumPurchaseQuantity und percent_off_percentage müssen vorhanden sein.
FREE_GIFT Geschenk mit nur Beschreibung.
FREE_GIFT_WITH_VALUE Geschenk mit Geldwert.
FREE_GIFT_WITH_ITEM_ID Geschenk mit Artikel-ID.
FREE_SHIPPING_STANDARD Werttyp des Gutscheins mit kostenlosem Standardversand.
FREE_SHIPPING_OVERNIGHT Werttyp „Gutschein für kostenlosen Versand über Nacht“.
FREE_SHIPPING_TWO_DAY Werttyp des Gutscheins für kostenlosen Versand innerhalb von 2 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

StoreApplicability

Geschäftscodes oder eine Liste von Geschäftscodes, für die das Angebot gilt. Nur für Angebote 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 des Angebots.

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

object (DestinationStatus)

Nur Ausgabe. Die vorgesehenen Ziele für das Angebot.
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 Versatz, 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 der Zielanwendung des Angebots.
status

enum (State)

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

Status

Der aktuelle Status des Angebots.

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 wird nicht beendet und alle Überprüfungen werden genehmigt, das aktive Datum liegt jedoch in der Zukunft.

ItemLevelIssue

Das Problem im Zusammenhang mit dem Angebot.

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. Gibt an, ob das Problem vom Händler behoben werden kann.
attribute

string

Nur Ausgabe. Der Name des Attributs, wenn das Problem durch ein einzelnes Attribut verursacht wird.
reportingContext

enum (ReportingContextEnum)

Nur Ausgabe. Das Ziel, auf das das Problem zutrifft.
description

string

Nur Ausgabe. Eine kurze Problembeschreibung auf Englisch.
detail

string

Nur Ausgabe. Eine detaillierte Problembeschreibung auf Englisch.
documentation

string

Nur Ausgabe. Die URL einer Webseite, die bei der Lösung dieses Problems hilfreich ist.
applicableCountries[]

string

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

Schweregrad

Der Schweregrad des Problems.

Enums
SEVERITY_UNSPECIFIED Nicht angegeben.
NOT_IMPACTED Bei diesem Problem handelt es sich um eine Warnung, die keine direkten Auswirkungen auf das Angebot hat.
DEMOTED Das Angebot wurde abgewertet und die Leistung in den Suchergebnissen ist höchstwahrscheinlich eingeschränkt
DISAPPROVED Aufgrund des Problems wird das Angebot 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.