Package google.shopping.merchant.notifications.v1beta

Index

NotificationsApiService

Dienst zum Verwalten von Benachrichtigungsabos für Händler

CreateNotificationSubscription

rpc CreateNotificationSubscription(CreateNotificationSubscriptionRequest) returns (NotificationSubscription)

Erstellt ein Benachrichtigungsabo für ein Unternehmen. Für eigenständige Konten oder Unterkonten kann das Unternehmen ein Abo für sich selbst erstellen. Für Mehrfachkundenkonten kann das Unternehmen ein Abo für alle verwalteten Konten oder für ein bestimmtes Unterkonto erstellen.

Die folgenden Arten von Benachrichtigungsabos können gleichzeitig vorhanden sein (pro Unternehmen als Abonnent und pro Ereignistyp):

  1. Abo für alle verwalteten Konten + Abo für mich selbst

  2. Mehrere „teilweise“ Abos für verwaltete Konten und ein Abo für mich selbst

Folgendes ist nicht zulässig (pro Unternehmen als Abonnent und pro Ereignistyp):

  1. Mehrere selbst abgeschlossene Abos

  2. Mehrere Abos vom Typ „Alle verwalteten Konten“

  3. Das Abo „Alle verwalteten Konten“ und Teilabos gleichzeitig.

  4. Mehrere teilweise Abos für dasselbe Zielkonto.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie in der OAuth 2.0-Übersicht.
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 OAuth 2.0-Übersicht.
GetNotificationSubscription

rpc GetNotificationSubscription(GetNotificationSubscriptionRequest) returns (NotificationSubscription)

Ruft Benachrichtigungsabos für ein Konto ab.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

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

rpc ListNotificationSubscriptions(ListNotificationSubscriptionsRequest) returns (ListNotificationSubscriptionsResponse)

Ruft alle Benachrichtigungsabos für einen Händler ab.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

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

rpc UpdateNotificationSubscription(UpdateNotificationSubscriptionRequest) returns (NotificationSubscription)

Aktualisiert ein vorhandenes Benachrichtigungsabo für einen Händler.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

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

Attribut

Aufzählung, mit der das Attribut in der Ressource angegeben wird, das geändert wird, um den Händler zu benachrichtigen.

Enums
ATTRIBUTE_UNSPECIFIED Nicht angegebenes Attribut
STATUS Status der geänderten Entität

CreateNotificationSubscriptionRequest

Anfragenachricht für die Methode „CreateNotificationSubscription“.

Felder
parent

string

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

NotificationSubscription

Erforderlich. Das zu erstellende Benachrichtigungsabo.

DeleteNotificationSubscriptionRequest

Anfragenachricht für die Methode „DeleteNotificationSubscription“

Felder
name

string

Erforderlich. Der Name des zu löschenden Benachrichtigungsabonnements.

GetNotificationSubscriptionRequest

Anfragenachricht für die Methode „GetNotificationSubscription“.

Felder
name

string

Erforderlich. Die name des Benachrichtigungsabos.

ListNotificationSubscriptionsRequest

Anfragenachricht für die Methode „ListNotificationSubscription“.

Felder
parent

string

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

int32

Die maximale Anzahl von Benachrichtigungsabos, die auf einer Seite zurückgegeben werden sollen. Der Standardwert für page_size ist 100. Der Maximalwert ist 200. Werte über 200 werden auf 200 festgelegt.
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 Benachrichtigungsabos.
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. Die name der Benachrichtigungskonfiguration. Wird von der Content API beim Erstellen einer neuen NotificationSubscription generiert. Der 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, über die die Benachrichtigung an den Händler gesendet werden soll.

Union-Feld interested_in.

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

bool

Wenn dieser Wert „wahr“ ist, wird das anfragende Konto täglich über das angegebene Ereignis für alle verwalteten Konten (Unterkonten oder andere verknüpfte Konten) einschließlich neu hinzugefügter Konten informiert.
target_account

string

Die 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 das Produkt abgelehnt wird.

ProductChange

Die Änderung am Produkt, einschließlich des alten und des neuen Werts, des Landescodes als Regionscode und des Berichtskontexts.

Felder
old_value

string

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

string

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

string

Länder, in denen die Änderung gilt (falls zutreffend)
reporting_context

ReportingContextEnum

Kontexte für die Berichterstellung, in denen die Änderung auftritt (falls zutreffend)

ProductStatusChangeMessage

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

Felder
changes[]

ProductChange

Eine Nachricht, in der die Änderung am Produkt beschrieben wird
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 Konto des Händlers verwaltet wird. Kann mit der Händler-ID übereinstimmen, 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 das immer Product.
attribute

Attribute

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

string

Die Produkt-ID.
resource

string

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

Timestamp

Das Ablaufdatum des Produkts. Dieses Feld wird nicht festgelegt, wenn die Benachrichtigung für ein Ereignis zum Löschen eines Produkts gesendet wird.

Ressource

Aufzählung, um die Ressource anzugeben, 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 „UpdateNotificationSubscription“.

Felder
notification_subscription

NotificationSubscription

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

FieldMask

Liste der aktualisierten Felder.