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 แสดงรหัสผู้ขายของผู้ขายที่เป็นเจ้าของการกําหนดค่า รูปแบบ: 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}}
expiration_time

Timestamp

เวลาหมดอายุของผลิตภัณฑ์ ระบบจะไม่ตั้งค่าช่องนี้หากมีการส่งการแจ้งเตือนสำหรับเหตุการณ์การลบผลิตภัณฑ์

ทรัพยากร

Enum เพื่อระบุทรัพยากรที่มีการเปลี่ยนแปลงเพื่อแจ้งให้ผู้ขายทราบ

Enum
RESOURCE_UNSPECIFIED ทรัพยากรที่ไม่ระบุ
PRODUCT ประเภททรัพยากร : ผลิตภัณฑ์

UpdateNotificationSubscriptionRequest

ข้อความคําขอสําหรับเมธอด UpdateNotificationSubscription

ช่อง
notification_subscription

NotificationSubscription

ต้องระบุ การสมัครรับการแจ้งเตือนเวอร์ชันใหม่ที่ควรอัปเดต
update_mask

FieldMask

รายการช่องที่อัปเดต