REST Resource: accounts.notificationsubscriptions
Mit Sammlungen den Überblick behalten
Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
Ressource: NotificationSubscription
Stellt ein Benachrichtigungsabo dar, das einem Händlerkonto gehört.
JSON-Darstellung |
{
"name": string,
"registeredEvent": enum (NotificationEventType ),
"callBackUri": string,
// Union field interested_in can be only one of the following:
"allManagedAccounts": boolean,
"targetAccount": string
// End of list of possible types for union field interested_in .
} |
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/{notificationSubscription}
|
registeredEvent |
enum (NotificationEventType )
Das Ereignis, über das der Händler benachrichtigt werden möchte.
|
callBackUri |
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: |
allManagedAccounts |
boolean
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.
|
targetAccount |
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. |
Methoden |
|
Erstellt ein Benachrichtigungsabo für ein Unternehmen. |
|
Löscht ein Benachrichtigungsabo für einen Händler. |
|
Ruft Benachrichtigungsabos für ein Konto ab. |
|
Ruft alle Benachrichtigungsabos für einen Händler ab. |
|
Aktualisiert ein vorhandenes Benachrichtigungsabo für einen Händler. |
Sofern nicht anders angegeben, sind die Inhalte dieser Seite unter der Creative Commons Attribution 4.0 License und Codebeispiele unter der Apache 2.0 License lizenziert. Weitere Informationen finden Sie in den Websiterichtlinien von Google Developers. Java ist eine eingetragene Marke von Oracle und/oder seinen Partnern.
Zuletzt aktualisiert: 2024-11-24 (UTC).
[null,null,["Zuletzt aktualisiert: 2024-11-24 (UTC)."],[[["\u003cp\u003eNotificationSubscription enables merchants to receive notifications about specific events related to their account.\u003c/p\u003e\n"],["\u003cp\u003eMerchants can configure which events trigger notifications, such as product status changes, and provide a callback URL to receive them.\u003c/p\u003e\n"],["\u003cp\u003eThe API offers methods to create, delete, retrieve, and update notification subscriptions.\u003c/p\u003e\n"],["\u003cp\u003eIt allows merchants to receive notifications for events occurring on all managed accounts or a specific target account.\u003c/p\u003e\n"]]],["Merchants can create `NotificationSubscription` resources to receive updates about specific events. Each subscription includes a `name`, a `registeredEvent` (e.g., `PRODUCT_STATUS_CHANGE`), and a `callBackUri` for notification delivery. Merchants can specify if they want to receive events regarding `allManagedAccounts` or a `targetAccount`. Available methods include `create`, `delete`, `get`, `list`, and `patch` for managing these subscriptions. Notification event type can be `PRODUCT_STATUS_CHANGE` or `NOTIFICATION_EVENT_TYPE_UNSPECIFIED`.\n"],null,["# REST Resource: accounts.notificationsubscriptions\n\n- [Resource: NotificationSubscription](#NotificationSubscription)\n - [JSON representation](#NotificationSubscription.SCHEMA_REPRESENTATION)\n- [NotificationEventType](#NotificationEventType)\n- [Methods](#METHODS_SUMMARY)\n\nResource: NotificationSubscription\n----------------------------------\n\nRepresents a notification subscription owned by a Merchant account.\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"registeredEvent\": enum (/merchant/api/reference/rest/notifications_v1beta/accounts.notificationsubscriptions#NotificationEventType), \"callBackUri\": string, // Union field `interested_in` can be only one of the following: \"allManagedAccounts\": boolean, \"targetAccount\": string // End of list of possible types for union field `interested_in`. } ``` |\n\n| Fields ||\n|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Output only. The `name` of the notification configuration. Generated by the Content API upon creation of a new `NotificationSubscription`. The `account` represents the merchant ID of the merchant that owns the configuration. Format: `accounts/{account}/notificationsubscriptions/{notificationSubscription}` |\n| `registeredEvent` | `enum (`[NotificationEventType](/merchant/api/reference/rest/notifications_v1beta/accounts.notificationsubscriptions#NotificationEventType)`)` The event that the merchant wants to be notified about. |\n| `callBackUri` | `string` URL to be used to push the notification to the merchant. |\n| Union field `interested_in`. `interested_in` can be only one of the following: ||\n| `allManagedAccounts` | `boolean` If this value is true, the requesting account is notified of the specified event for all managed accounts (can be subaccounts or other linked accounts) including newly added accounts on a daily basis. |\n| `targetAccount` | `string` The `name` of the account you want to receive notifications for. Format: `accounts/{account}` |\n\nNotificationEventType\n---------------------\n\nRepresents the event type that the merchant is interested in receiving notifications for.\n\n| Enums ||\n|---------------------------------------|---------------------------------------------------------------------------------------|\n| `NOTIFICATION_EVENT_TYPE_UNSPECIFIED` | Notifications event type is unspecified. |\n| `PRODUCT_STATUS_CHANGE` | Notification of product status changes, for example when product becomes disapproved. |\n\n| Methods ------- ||\n|-----------------------------------------------------------------------------------------------------------|---------------------------------------------------------------|\n| ### [create](/merchant/api/reference/rest/notifications_v1beta/accounts.notificationsubscriptions/create) | Creates a notification subscription for a business. |\n| ### [delete](/merchant/api/reference/rest/notifications_v1beta/accounts.notificationsubscriptions/delete) | Deletes a notification subscription for a merchant. |\n| ### [get](/merchant/api/reference/rest/notifications_v1beta/accounts.notificationsubscriptions/get) | Gets notification subscriptions for an account. |\n| ### [list](/merchant/api/reference/rest/notifications_v1beta/accounts.notificationsubscriptions/list) | Gets all the notification subscriptions for a merchant. |\n| ### [patch](/merchant/api/reference/rest/notifications_v1beta/accounts.notificationsubscriptions/patch) | Updates an existing notification subscription for a merchant. |"]]