REST Resource: accounts.notificationsubscriptions
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
משאב: NotificationSubscription
מייצג מינוי לקבלת התראות שנמצא בבעלות של חשבון מוכר.
ייצוג ב-JSON |
{
"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 .
} |
שדות |
name |
string
פלט בלבד. ה-name של הגדרת ההתראה. נוצר על ידי Content API כשיוצרים NotificationSubscription חדש. השדה account מייצג את מספר חשבון Merchant של המוכר שבבעלותו ההגדרה. פורמט: accounts/{account}/notificationsubscriptions/{notificationSubscription}
|
registeredEvent |
enum (NotificationEventType )
האירוע שרוצים לקבל עליו התראה.
|
callBackUri |
string
כתובת ה-URL שתשמש לשליחת ההתראה אל המוכר.
|
שדה האיחוד interested_in . הערך של interested_in יכול להיות רק אחת מהאפשרויות הבאות: |
allManagedAccounts |
boolean
אם הערך הזה הוא True, החשבון המבקש יקבל התראה על האירוע שצוין בכל החשבונות המנוהלים (יכולים להיות אלה חשבונות משנה או חשבונות מקושרים אחרים), כולל חשבונות שנוספו לאחרונה, על בסיס יומי.
|
targetAccount |
string
name של החשבון שעבורו רוצים לקבל התראות. פורמט: accounts/{account}
|
NotificationEventType
מייצג את סוג האירוע שהמוכר מעוניין לקבל עליו התראות.
טיפוסים בני מנייה (enum) |
NOTIFICATION_EVENT_TYPE_UNSPECIFIED |
סוג האירוע של ההתראות לא צוין. |
PRODUCT_STATUS_CHANGE |
התראות על שינויים בסטטוס המוצר, למשל כשהמוצר נדחה. |
Methods |
|
יצירת מינויים לקבלת התראות לגבי עסק. |
|
מחיקה של מינוי לקבלת התראות עבור מוכר. |
|
הפונקציה מקבלת מינויים להתראות בחשבון. |
|
הפונקציה מקבלת את כל המינויים לקבלת התראות של מוכר. |
|
עדכון של מינוי קיים להתראות של מוכר. |
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2024-11-24 (שעון UTC).
[null,null,["עדכון אחרון: 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. |"]]