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ügt 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 Übersicht über OAuth 2.0.
ListPromotions

rpc ListPromotions(ListPromotionsRequest) returns (ListPromotionsResponse)

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

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 Übersicht über OAuth 2.0.

Attribute

Attribute.

Felder
product_applicability

ProductApplicability

Erforderlich. Gültigkeit für das Angebot auf alle Produkte oder nur auf bestimmte Produkte
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. Zur Verwendung mit dem Feld offerType und muss 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 Typ des ausgewählten Gutscheinwerts sind einige Attribute erforderlich.
promotion_destinations[]

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

string

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

string

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

string

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

string

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

string

Optional. Produktfilter für das Angebot nach Markenausschluss. Die Produktfilterattribute gelten nur, wenn das product_applicability-Attribut für Produkte, für die das Angebot gilt, auf specific_products festgelegt ist.
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 für das Angebot nach Produkttypausschlüsse. Die Produktfilterattribute gelten nur, wenn das product_applicability-Attribut für Produkte, für die das Angebot gilt, auf specific_products festgelegt ist.
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 in der Aktion angeboten wird.
get_this_quantity_discounted

int64

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.
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. Geschenkartikel-ID für das Angebot.
promotion_effective_time_period

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.
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 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 store_applicability auf ALL_STORES und store_codes_inclusion oder score_code_exclusion auf einen Wert festgelegt ist, wird ein INVALID_ARGUMENT-Fehler ausgegeben.
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 (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.
store_codes_exclusion[]

string

Optional. Ausgeschlossene Geschäftscodes für das Angebot. Die Filialfilterattribute 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 promotion_url nicht angegeben ist. Mit der URL wird bestätigt, dass das Angebot gültig und einlösbar 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. 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 Wenn du eine Menge von „M“ kaufst, erhältst du N % Rabatt auf den Gutscheinwerttyp. minimum_purchase_quantity und get_this_quantity_discounted 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. minimum_purchase_quantity und money_off_amount müssen vorhanden sein.
BUY_M_GET_PERCENT_OFF Wenn du eine Menge in „M“ kaufst, erhältst du Rabatt. minimum_purchase_quantity 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.

GetPromotionRequest

Anfragenachricht für die Methode GetPromotion.

Felder
name

string

Erforderlich. Der Name der abzurufenden Werbung. Format: accounts/{account}/promotions/{promotions}

InsertPromotionRequest

Anfragenachricht für die Methode InsertPromotion.

Felder
parent

string

Erforderlich. Das Konto, in das das Angebot eingefügt wird. 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 zurückzugebenden Angebote. Der Dienst gibt möglicherweise weniger als diesen Wert zurück. Der Höchstwert beträgt 1.000. Werte über 1.000 werden implizit auf 1.000 umgewandelt. 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. Der generische Gutscheincode für das Angebot ist erforderlich, wenn „offerType“ = „GENERIC_CODE“ 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.

Werbung

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.

Felder
name

string

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

string

Erforderlich. Die vom Nutzer angegebene Angebots-ID zur eindeutigen Identifizierung des Angebots. Beachten Sie die Mindestanforderungen, um zu verhindern, dass Angebote abgelehnt werden.
content_language

string

Erforderlich. Der zweistellige 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. Dargestellt als CLDR-Gebietscode.

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

RedemptionChannel

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

string

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

Attributes

Optional. Eine Liste der Angebotsattribute.
custom_attributes[]

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

PromotionStatus

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

int64

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

PromotionStatus

Der Status des Angebots.

Felder
destination_statuses[]

DestinationStatus

Nur Ausgabe. Die vorgesehenen Ziele für das Angebot.
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 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.

Felder
reporting_context

ReportingContextEnum

Nur Ausgabe. Der Name der Zielanwendung des Angebots.
status

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.

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

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

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.

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.

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.