Package google.shopping.merchant.notifications.v1beta

אינדקס

NotificationsApiService

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

CreateNotificationSubscription

rpc CreateNotificationSubscription(CreateNotificationSubscriptionRequest) returns (NotificationSubscription)

יצירת מינויים לקבלת התראות עבור עסק. בחשבון עצמאי או בחשבון משנה, העסק יכול ליצור מינוי בעצמו. בחשבונות MCA, העסק יכול ליצור מינוי לכל החשבונות המנוהלים או לחשבון משנה ספציפי.

נאפשר את קיומם של סוגי המינויים הבאים להתרעות (לכל עסק כמנוי לכל סוג אירוע):

  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 לציון המאפיין במשאב שרוצים לעדכן ולעדכן את המוכר על כך.

טיפוסים בני מנייה (enum)
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 מייצג את מספר חשבון Merchant של המוכר שההגדרות האישיות בבעלותו. פורמט: accounts/{account}/notificationsubscriptions/{notification_subscription}
registered_event

NotificationEventType

האירוע שרוצים לקבל עליו התראה.
call_back_uri

string

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

שדה האיחוד interested_in.

הערך של interested_in יכול להיות רק אחת מהאפשרויות הבאות:
all_managed_accounts

bool

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

string

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

NotificationEventType

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

טיפוסים בני מנייה (enum)
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 לציון המשאב שרוצים לעדכן את המוכר לגבי השינוי שלו.

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

UpdateNotificationSubscriptionRequest

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

שדות
notification_subscription

NotificationSubscription

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

FieldMask

רשימת השדות שמתעדכנים.