Package google.shopping.merchant.notifications.v1beta

Index

NotificationsApiService

Dienst zum Verwalten von abonnierten Benachrichtigungen für Händler

CreateNotificationSubscription

rpc CreateNotificationSubscription(CreateNotificationSubscriptionRequest) returns (NotificationSubscription)

Erstellt ein Benachrichtigungsabo für einen Händler. Folgende Arten von abonnierten Benachrichtigungen sind gleichzeitig zulässig (pro Händler als Abonnent und Ereignistyp): 1. Abo für alle verwalteten Konten + Abo für sich selbst 2. Mehrere „Teilabos“ für verwaltete Konten und eigenes Abo

Folgendes ist nicht zulässig (pro Händler als Abonnent und Ereignistyp): 1. mehrere eigenständige Abonnements. 2. mehrere Abos "alle verwalteten Konten". 3. alle und Teilabos gleichzeitig. 4. Mehrere Teilabos für dasselbe Zielkonto

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

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

rpc DeleteNotificationSubscription(DeleteNotificationSubscriptionRequest) returns (Empty)

Löscht ein Benachrichtigungsabo für einen Händler.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

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

rpc GetNotificationSubscription(GetNotificationSubscriptionRequest) returns (NotificationSubscription)

Ruft abonnierte Benachrichtigungen für ein Konto ab.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

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

rpc ListNotificationSubscriptions(ListNotificationSubscriptionsRequest) returns (ListNotificationSubscriptionsResponse)

Ruft alle abonnierten Benachrichtigungen eines Händlers ab.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

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

rpc UpdateNotificationSubscription(UpdateNotificationSubscriptionRequest) returns (NotificationSubscription)

Dadurch wird ein bestehendes Benachrichtigungsabo für einen Händler aktualisiert.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

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

Attribut

Aufzählung zur Angabe des Attributs in der Ressource, die geändert wird, um den Händler zu benachrichtigen.

Enums
ATTRIBUTE_UNSPECIFIED Nicht angegebenes Attribut
STATUS Status des geänderten Elements

CreateNotificationSubscriptionRequest

Anfragenachricht für die Methode CreateNotificationSubscription-Methode.

Felder
parent

string

Erforderlich. Das Händlerkonto, zu dem das neue Benachrichtigungsabo gehört. Format: accounts/{account}
notification_subscription

NotificationSubscription

Erforderlich. Das zu erstellende Benachrichtigungsabo.

DeleteNotificationSubscriptionRequest

Anfragenachricht für die Methode Delete NotificationSubscription-Methode.

Felder
name

string

Erforderlich. Der Name des zu löschenden Benachrichtigungsabos.

GetNotificationSubscriptionRequest

Anfragenachricht für die Methode Get NotificationSubscription-Methode.

Felder
name

string

Erforderlich. Der name des Benachrichtigungsabos.

ListNotificationSubscriptionsRequest

Anfragenachricht für die Methode List NotificationSubscription-Methode.

Felder
parent

string

Erforderlich. Das Händlerkonto, dem die abonnierten Benachrichtigungen gehören Format: accounts/{account}
page_size

int32

Die maximale Anzahl von abonnierten Benachrichtigungen, die auf einer Seite zurückgegeben werden sollen. Der Standardwert für page_size ist 100. Der Höchstwert ist 200. Für Werte über 200 wird 200 erzwungen.
page_token

string

Token (falls angegeben), um die nachfolgende Seite abzurufen. Alle anderen Parameter müssen mit dem ursprünglichen Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat.

ListNotificationSubscriptionsResponse

Antwortnachricht für die Methode ListNotificationSubscription.

Felder
notification_subscriptions[]

NotificationSubscription

Die Liste der vom Händler angeforderten abonnierten Benachrichtigungen.
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.

NotificationSubscription

Stellt ein Benachrichtigungsabo dar, das einem Händlerkonto gehört.

Felder
name

string

Nur Ausgabe Der name der Benachrichtigungskonfiguration. Wird von der Content API beim Erstellen einer neuen NotificationSubscription generiert. Die account steht für die Händler-ID des Händlers, dem die Konfiguration gehört. Format: accounts/{account}/notificationsubscriptions/{notification_subscription}
registered_event

NotificationEventType

Das Ereignis, über das der Händler benachrichtigt werden möchte.
call_back_uri

string

URL, mit der die Benachrichtigung an den Händler gesendet wird.

Union-Feld interested_in.

Für interested_in ist nur einer der folgenden Werte zulässig:
all_managed_accounts

bool

Wenn dieser Wert „true“ ist, wird das anfragende Konto täglich für alle verwalteten Konten (untergeordnete Konten oder andere verknüpfte Konten) über das angegebene Ereignis benachrichtigt.
target_account

string

name des Kontos, für das Sie Benachrichtigungen erhalten möchten. Format: accounts/{account}

NotificationEventType

Der Ereignistyp, für den der Händler Benachrichtigungen erhalten möchte.

Enums
NOTIFICATION_EVENT_TYPE_UNSPECIFIED Der Ereignistyp „Benachrichtigungen“ ist nicht angegeben.
PRODUCT_STATUS_CHANGE Benachrichtigung über Änderungen des Produktstatus, z. B. wenn ein Produkt abgelehnt wird

ProductChange

Die am Produkt vorgenommene Änderung, einschließlich alter Wert, neuer Wert, Ländercode als Regionscode und Berichtskontext.

Felder
old_value

string

Der alte Wert der geänderten Ressource oder des Attributs.
new_value

string

Der neue Wert der geänderten Ressource oder des geänderten Attributs.
region_code

string

Länder mit dieser Änderung (falls zutreffend)
reporting_context

ReportingContextEnum

Berichtskontexte mit der Änderung (falls zutreffend)

ProductStatusChangeMessage

Die Nachricht, die der Händler erhält, um über eine Änderung des Produktstatus informiert zu werden

Felder
changes[]

ProductChange

Eine Nachricht, in der die Änderung beschrieben wird, die am Produkt vorgenommen wurde
account

string

Das Zielkonto, zu dem die geänderte Entität gehört. Format : accounts/{merchant_id}
managing_account

string

Das Konto, über das das Händlerkonto verwaltet wird, kann mit der Händler-ID identisch sein, wenn es sich um ein eigenständiges Konto handelt. Format : accounts/{service_provider_id}
resource_type

Resource

Die geänderte Ressource. In diesem Fall ist sie immer Product.
attribute

Attribute

Das Attribut in der Ressource, das sich geändert hat. In diesem Fall ist es immer Status.
resource_id

string

Die Produkt-ID.
resource

string

Der Produktname. Format: {product.name=accounts/{account}/products/{product}}

Ressource

Aufzählung zur Angabe der Ressource, die geändert wird, um den Händler zu benachrichtigen.

Enums
RESOURCE_UNSPECIFIED Nicht angegebene Ressource
PRODUCT Ressourcentyp : Produkt

UpdateNotificationSubscriptionRequest

Anfragenachricht für die Methode Update NotificationSubscription-Methode.

Felder
notification_subscription

NotificationSubscription

Erforderlich. Die neue Version des Benachrichtigungsabos, die aktualisiert werden soll.
update_mask

FieldMask

Liste der Felder, die aktualisiert werden.