Package google.shopping.merchant.notifications.v1beta

ดัชนี

NotificationsApiService

บริการจัดการการสมัครรับข้อมูลการแจ้งเตือนสำหรับผู้ขาย

CreateNotificationSubscription

rpc CreateNotificationSubscription(CreateNotificationSubscriptionRequest) returns (NotificationSubscription)

สร้างการสมัครรับข้อมูลการแจ้งเตือนสำหรับผู้ขาย เราจะอนุญาตให้การสมัครรับการแจ้งเตือนประเภทต่างๆ ต่อไปนี้อยู่ร่วมกันได้ (ต่อผู้ขาย 1 รายที่เป็นสมาชิกต่อประเภทกิจกรรม) 1. การสมัครใช้บริการสำหรับบัญชีที่จัดการทั้งหมด + การสมัครใช้บริการสำหรับตนเอง 2. การสมัครใช้บริการ "บางส่วน" หลายรายการสำหรับบัญชีที่จัดการ + การสมัครใช้บริการสำหรับตนเอง

เราจะไม่อนุญาต (ต่อผู้ขาย 1 รายที่เป็นสมาชิกต่อประเภทกิจกรรม) 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

แอตทริบิวต์

ennum เพื่อระบุแอตทริบิวต์ในทรัพยากรที่มีการเปลี่ยนแปลงเพื่อแจ้งเตือนผู้ขาย

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

หากค่านี้เป็นจริง บัญชีที่ส่งคำขอจะได้รับการแจ้งเตือนเกี่ยวกับกิจกรรมที่ระบุของบัญชีที่จัดการทั้งหมด (อาจเป็นบัญชีย่อยหรือบัญชีที่ลิงก์อื่นๆ) รวมถึงบัญชีที่เพิ่มเข้ามาใหม่เป็นประจำทุกวัน

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}}

ทรัพยากร

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

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

UpdateNotificationSubscriptionRequest

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

ช่อง
notification_subscription

NotificationSubscription

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

update_mask

FieldMask

รายการฟิลด์ที่กําลังอัปเดต