Package google.shopping.merchant.notifications.v1beta

אינדקס

NotificationsApiService

שירות לניהול מינויים להתראות עבור מוכרים

CreateNotificationSubscription

rpc CreateNotificationSubscription(CreateNotificationSubscriptionRequest) returns (NotificationSubscription)

יצירת מינוי להתראות בשביל מוכר. נאפשר לשייך את הסוגים הבאים של מינויים להתראות (לכל מוכר, כמנוי/ה בכל סוג אירוע): 1. מינוי לכל החשבונות המנוהלים + מינוי לעצמי 2. מספר מינויים "חלקיים" לחשבונות מנוהלים + מינוי אישי

לא נאפשר (למוכר, כמנוי, לכל סוג אירוע): 1. מספר מינויים עצמיים. 2. מינויים מרובים ל "כל החשבונות המנוהלים". 3. כל המינויים והמינויים החלקיים בו-זמנית. 4. ריבוי מינויים חלקיים עבור אותו חשבון יעד

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

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

למידע נוסף, עיינו בסקירה הכללית על OAuth 2.0.
DeleteNotificationSubscription

rpc DeleteNotificationSubscription(DeleteNotificationSubscriptionRequest) returns (Empty)

מחיקת המינוי להתראות של מוכר.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

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

למידע נוסף, עיינו בסקירה הכללית על OAuth 2.0.
GetNotificationSubscription

rpc GetNotificationSubscription(GetNotificationSubscriptionRequest) returns (NotificationSubscription)

קבלת מינויים להתראות בחשבון.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

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

למידע נוסף, עיינו בסקירה הכללית על OAuth 2.0.
ListNotificationSubscriptions

rpc ListNotificationSubscriptions(ListNotificationSubscriptionsRequest) returns (ListNotificationSubscriptionsResponse)

קבלת כל המינויים של מוֹכר להתראות.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

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

למידע נוסף, עיינו בסקירה הכללית על OAuth 2.0.
UpdateNotificationSubscription

rpc UpdateNotificationSubscription(UpdateNotificationSubscriptionRequest) returns (NotificationSubscription)

עדכון מינוי קיים להתראות עבור מוכר.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

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

למידע נוסף, עיינו בסקירה הכללית על OAuth 2.0.

מאפיין

Enum לציון המאפיין במשאב שמשתנה כדי לעדכן את המוכר.

טיפוסים בני מנייה (enums)
ATTRIBUTE_UNSPECIFIED מאפיין לא מוגדר
STATUS הסטטוס של הישות ששונתה

CreateNotificationSubscriptionRequest

הודעת בקשה לשיטת CreateNotificationSubscription.

שדות
parent

string

חובה. חשבון המוכר שהוא הבעלים של המינוי החדש להתראות. פורמט: accounts/{account}
notification_subscription

NotificationSubscription

חובה. המינוי להתראות ליצירה.

DeleteNotificationSubscriptionRequest

הודעת בקשה עבור השיטה DeleteNotificationSubscription.

שדות
name

string

חובה. שם המינוי להתראות למחיקה.

GetNotificationSubscriptionRequest

הודעת בקשה עבור שיטת GetNotificationSubscription.

שדות
name

string

חובה. name של המינוי להתראות.

ListNotificationSubscriptionsRequest

הודעת בקשה עבור שיטת ListNotificationSubscription.

שדות
parent

string

חובה. חשבון המוכר שהוא הבעלים של המינויים להתראות. פורמט: accounts/{account}
page_size

int32

המספר המקסימלי של מינויים להתראות שיש להחזיר בדף. ערך ברירת המחדל של page_size הוא 100. הערך המקסימלי הוא 200. הערכים שגבוהים מ-200 יכוונו ל-200.
page_token

string

אסימון (אם סופק) כדי לאחזר את הדף הבא. כל שאר הפרמטרים חייבים להתאים לקריאה המקורית שסיפקה את אסימון הדף.

ListNotificationSubscriptionsResponse

הודעת תגובה עבור השיטה ListNotificationSubscription.

שדות
notification_subscriptions[]

NotificationSubscription

רשימת המינויים להתראות שהמוכר ביקש.
next_page_token

string

אסימון, שיכול להישלח בתור page_token כדי לאחזר את הדף הבא. אם השדה הזה יושמט, לא יהיו דפים עוקבים.

NotificationSubscription

מייצג מינוי להתראות בבעלות חשבון מוכר.

שדות
name

string

פלט בלבד. name של הגדרת ההתראות. נוצר על ידי Content API בזמן היצירה של NotificationSubscription חדש. הערך account מייצג את מספר המוכר של המוכר שמוגדר כבעלים של ההגדרה. פורמט: accounts/{account}/notificationsubscriptions/{notification_subscription}
registered_event

NotificationEventType

האירוע שהמוכר רוצה לקבל עליו הודעה.
call_back_uri

string

כתובת ה-URL שתשמש לשליחת ההודעה למוכר.

שדה איחוד interested_in.

interested_in יכול להיות רק אחד מהבאים:
all_managed_accounts

bool

אם הערך הזה מוגדר, החשבון המבקש יקבל הודעה על האירוע שצוין בכל החשבונות המנוהלים (יכולים להיות חשבונות משנה או חשבונות מקושרים אחרים), כולל חשבונות חדשים שנוספו על בסיס יומי.
target_account

string

name של החשבון שלגביו רוצים לקבל התראות. פורמט: accounts/{account}

NotificationEventType

סוג האירוע שהמוכר רוצה לקבל לגביו התראות.

טיפוסים בני מנייה (enums)
NOTIFICATION_EVENT_TYPE_UNSPECIFIED סוג אירוע ההתראות לא צוין.
PRODUCT_STATUS_CHANGE הודעה על שינויים בסטטוס המוצר, למשל כשמוצר נפסל.

ProductChange

השינוי שקרה למוצר, כולל הערך הישן, הערך החדש, קוד המדינה כקוד האזור וההקשר לדיווח.

שדות
old_value

string

הערך הישן של המשאב או המאפיין שהשתנו.
new_value

string

הערך החדש של המשאב או המאפיין שהשתנו.
region_code

string

המדינות שבהן חל השינוי (אם רלוונטי)
reporting_context

ReportingContextEnum

הקשרים לדיווח שהתבצע בהם השינוי (אם רלוונטי)

ProductStatusChangeMessage

ההודעה שהמוכר יקבל כדי לקבל התראה על אירוע של שינוי סטטוס המוצר

שדות
changes[]

ProductChange

הודעה שמתארת את השינוי שהתרחש במוצר
account

string

חשבון היעד שבבעלותו הישות ששונתה. פורמט : accounts/{merchant_id}
managing_account

string

החשבון שמנהל את חשבון המוכר יכול להיות זהה למספר המזהה של המוכר אם הוא חשבון עצמאי. פורמט : accounts/{service_provider_id}
resource_type

Resource

המשאב שהשתנה, במקרה הזה הוא תמיד Product.
attribute

Attribute

המאפיין במשאב שהשתנה, במקרה זה יהיה תמיד Status.
resource_id

string

מזהה המוצר.
resource

string

שם המוצר. פורמט: {product.name=accounts/{account}/products/{product}}

משאב

Enum לציון המשאב שמשתנה כדי להודיע למוכר.

טיפוסים בני מנייה (enums)
RESOURCE_UNSPECIFIED משאב לא מוגדר
PRODUCT סוג משאב : מוצר

UpdateNotificationSubscriptionRequest

הודעת בקשה עבור שיטת UpdateNotificationSubscription.

שדות
notification_subscription

NotificationSubscription

חובה. הגרסה החדשה של המינוי להתראות שצריך לעדכן.
update_mask

FieldMask

רשימת השדות בתהליך עדכון.