Package google.shopping.merchant.promotions.v1beta

Index

PromotionsService

Dienst zum Verwalten von Angeboten für Produkte.

GetPromotion

rpc GetPromotion(GetPromotionRequest) returns (Promotion)

Ruft das Angebot aus Ihrem Merchant Center-Konto ab.

Nach dem Einfügen oder Aktualisieren einer Eingabe für ein Angebot kann es einige Minuten dauern, bis das aktualisierte Angebot abgerufen werden kann.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/content

Weitere Informationen finden Sie in der Übersicht über OAuth 2.0.
InsertPromotion

rpc InsertPromotion(InsertPromotionRequest) returns (Promotion)

Fügen Sie ein Angebot für Ihr Merchant Center-Konto ein. Wenn das Angebot bereits vorhanden ist, wird es stattdessen aktualisiert.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/content

Weitere Informationen finden Sie in der OAuth 2.0-Übersicht.
ListPromotions

rpc ListPromotions(ListPromotionsRequest) returns (ListPromotionsResponse)

Hier werden die Angebote in Ihrem Merchant Center-Konto aufgeführt. Die Antwort enthält möglicherweise weniger Elemente als von pageSize angegeben. Anhand von pageToken können Sie feststellen, ob weitere Elemente angefordert werden müssen.

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

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/content

Weitere Informationen finden Sie in der OAuth 2.0-Übersicht.

Attribute

Attribute

Felder
product_applicability

ProductApplicability

Erforderlich. Gibt an, ob das Angebot für alle Produkte oder nur für bestimmte Produkte gilt.
offer_type

OfferType

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

string

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

string

Erforderlich. Langer Titel für das Angebot.
coupon_value_type

CouponValueType

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

DestinationEnum

Erforderlich. Liste der Ziele, für die das Angebot gilt. Wenn Sie in Ihrer Datenquelle aber kein Ziel mithilfe eines unterstützten Werts 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 Ziel des Angebots.
item_id_inclusion[]

string

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

string

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

string

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

string

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

string

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

string

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

string

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

string

Optional. Produktfilter nach Produkttyp-Ausschluss für das Angebot. Die Produktfilterattribute gelten nur, wenn das Attribut „Produkte, für die das Angebot gilt“ product_applicability auf specific_products festgelegt wurde.
minimum_purchase_amount

Price

Optional. Mindestbestellwert für das Angebot.
minimum_purchase_quantity

int64

Optional. Mindestbestellmenge für das Angebot.
limit_quantity

int64

Optional. Maximale Kaufmenge für das Angebot.
limit_value

Price

Optional. Maximaler Produktpreis für das Angebot.
percent_off

int64

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

Price

Optional. Der Rabattbetrag, der im Angebot angeboten wird.
get_this_quantity_discounted

int64

Optional. Die Anzahl der Artikel, die im Angebot rabattiert sind. Das Attribut wird festgelegt, wenn couponValueType gleich buy_m_get_n_money_off oder buy_m_get_n_percent_off ist.
free_gift_value

Price

Optional. Geschenkwert für das Angebot.
free_gift_description

string

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

string

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

Interval

Erforderlich. TimePeriod-Darstellung für den Gültigkeitszeitraum des Angebots. Mit diesem Attribut wird angegeben, dass das Angebot in diesem Zeitraum in Ihrem Onlineshop getestet werden kann.
promotion_display_time_period

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 promotion_display_time_period nicht angegeben ist, werden durch den Gültigkeitszeitraum des Angebots promotion_effective_time_period das Datum und der Zeitraum bestimmt, in dem das Angebot in der Google Suche und in Shopping-Anzeigen online ist.
store_applicability

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 store_applicability auf ALL_STORES und store_codes_inclusion oder score_code_exclusion auf einen Wert festgelegt ist.
store_codes_inclusion[]

string

Optional. Einzuschließende Geschäftscodes für das Angebot. Die Filialfilterattribute gelten nur, wenn das Attribut store_applicability 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.
store_codes_exclusion[]

string

Optional. Auszuschließende Geschäftscodes für das Angebot. Die Geschäftsfilterattribute gelten nur, wenn das Attribut store_applicability auf specific_stores festgelegt ist.
promotion_url

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 keine promotion_url enthalten ist. Mit dieser URL wird geprüft, ob das Angebot gültig und einlösbar ist.

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 „Prozentrabatt“.
BUY_M_GET_N_MONEY_OFF Gutscheinwerttyp „Bei Kauf von „M“ Rabattbetrag „N“ erhalten“ minimum_purchase_quantity und get_this_quantity_discounted müssen vorhanden sein. money_off_amount muss ebenfalls vorhanden sein.
BUY_M_GET_N_PERCENT_OFF Gutschein-Werttyp „Beim Kauf von „M“ „N“ % Rabatt erhalten“ minimum_purchase_quantity und get_this_quantity_discounted müssen vorhanden sein. percent_off_percentage muss ebenfalls vorhanden sein.
BUY_M_GET_MONEY_OFF Beim Kauf von „M“ Rabatt erhalten. minimum_purchase_quantity und money_off_amount müssen vorhanden sein.
BUY_M_GET_PERCENT_OFF Beim Kauf von „M“ Rabatt erhalten. minimum_purchase_quantity 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 Werttyp des Gutscheins mit kostenlosem Standardversand.
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.

GetPromotionRequest

Anfragenachricht für die Methode GetPromotion.

Felder
name

string

Erforderlich. Der Name des abzurufenden Angebots. Format: accounts/{account}/promotions/{promotions}

InsertPromotionRequest

Anfragenachricht für die Methode InsertPromotion.

Felder
parent

string

Erforderlich. Das Konto, in das das Angebot eingefügt werden soll. Format: accounts/{account}
promotion

Promotion

Erforderlich. Das einzufügende Angebot.
data_source

string

Erforderlich. Die Datenquelle des Formats Werbung: accounts/{account}/dataSources/{datasource}.

ListPromotionsRequest

Anfragenachricht für die Methode ListPromotions.

Felder
parent

string

Erforderlich. Das Konto, für das verarbeitete Angebote aufgelistet werden sollen. Format: accounts/{account}
page_size

int32

Nur Ausgabe. Die maximale Anzahl der Angebote, die zurückgegeben werden sollen. Der Dienst gibt möglicherweise weniger als diesen Wert zurück. Der Höchstwert beträgt 250. Werte über 250 werden auf 250 festgelegt. Wenn keine Angabe erfolgt, wird die maximale Anzahl von Angeboten zurückgegeben.
page_token

string

Nur Ausgabe. Ein Seitentoken, das von einem vorherigen ListPromotions-Aufruf empfangen wurde. Geben Sie diese an, um die nachfolgende Seite abzurufen.

Beim Paginieren müssen alle anderen für ListPromotions bereitgestellten Parameter mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat.

ListPromotionsResponse

Antwortnachricht für die Methode ListPromotions.

Felder
promotions[]

Promotion

Die verarbeiteten Angebote aus dem angegebenen Konto.
next_page_token

string

Ein Token, das als page_token gesendet werden kann, um die nächste Seite abzurufen. Wenn dieses Feld weggelassen wird, gibt es keine nachfolgenden Seiten.

OfferType

Angebotstyp einer Werbeaktion.

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

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 Liste von Produkten.

Angebot

Stellt ein Angebot 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 Angebot kann es einige Minuten dauern, bis das endgültige Angebot abgerufen werden kann.

Felder
name

string

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

string

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

string

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

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

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
redemption_channel[]

RedemptionChannel

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

string

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

Attributes

Optional. Eine Liste der Angebotsattribute.
custom_attributes[]

CustomAttribute

Optional. Eine Liste von benutzerdefinierten (vom Händler bereitgestellten) Attributen. 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.
promotion_status

PromotionStatus

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

int64

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 version_number erfolgen.

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

PromotionStatus

Der Status der Werbeaktion.

Felder
destination_statuses[]

DestinationStatus

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

ItemLevelIssue

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

Timestamp

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
last_update_date

Timestamp

Nur Ausgabe. Datum, an dem der Angebotsstatus zuletzt aktualisiert wurde, im ISO 8601-Format: Datum, Uhrzeit und Zeitzonenoffset, z. B. 2020-01-02T09:00:00+01:00 oder 2020-01-02T09:00:00Z

DestinationStatus

Der Status für das angegebene Ziel.

Felder
reporting_context

ReportingContextEnum

Nur Ausgabe. Der Name des Angebotsziels.
status

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 ist 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.

Felder
code

string

Nur Ausgabe. Der Fehlercode des Problems
severity

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.
reporting_context

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.
applicable_countries[]

string

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

Schweregrad

Der 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.

RedemptionChannel

Der 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.

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 nicht bekannt.
ALL_STORES Das Angebot gilt für alle Geschäfte.
SPECIFIC_STORES Das Angebot gilt nur für die angegebenen Geschäfte.