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 Overview .

DeleteNotificationSubscription

rpc DeleteNotificationSubscription( DeleteNotificationSubscriptionRequest ) returns ( Empty )

اشتراک اعلان یک تاجر را حذف می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، بهOAuth 2.0 Overview .

GetNotificationSubscription

rpc GetNotificationSubscription( GetNotificationSubscriptionRequest ) returns ( NotificationSubscription )

اشتراک اعلان برای یک حساب دریافت می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، بهOAuth 2.0 Overview .

ListNotificationSubscriptions

rpc ListNotificationSubscriptions( ListNotificationSubscriptionsRequest ) returns ( ListNotificationSubscriptionsResponse )

همه اشتراک های اعلان یک تاجر را دریافت می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، بهOAuth 2.0 Overview .

اشتراک UpdateNotification

rpc UpdateNotificationSubscription( UpdateNotificationSubscriptionRequest ) returns ( NotificationSubscription )

اشتراک اعلان موجود برای یک تاجر را به روز می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، بهOAuth 2.0 Overview .

صفت

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 برای بازیابی صفحه بعدی ارسال شود. اگر این قسمت حذف شود، هیچ صفحه بعدی وجود ندارد.

اطلاعیه اشتراک

نشان دهنده یک اشتراک اعلان متعلق به یک حساب تجاری است.

فیلدها
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 اعلان وضعیت محصول تغییر می کند، برای مثال زمانی که محصول رد می شود.

تغییر محصول

تغییری که برای محصول رخ داده است شامل ارزش قدیمی، ارزش جدید، کد کشور به عنوان کد منطقه و زمینه گزارش.

فیلدها
old_ value

string

مقدار قدیمی منبع یا ویژگی تغییر یافته است.

new_ value

string

مقدار جدید منبع یا ویژگی تغییر یافته.

region_ code

string

کشورهایی که این تغییر را دارند (در صورت وجود)

reporting_ context

ReportingContextEnum

گزارش زمینه‌هایی که دارای تغییر هستند (در صورت وجود)

پیام تغییر وضعیت محصول

پیامی که تاجر برای اطلاع از رویداد تغییر وضعیت محصول دریافت می کند

فیلدها
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 برای مشخص کردن منبعی که در حال تغییر است تا به تاجر اطلاع دهد.

Enums
RESOURCE_UNSPECIFIED منبع نامشخص
PRODUCT نوع منبع: محصول

UpdateNotificationSubscriptionRequest

درخواست پیام برای روش UpdateNotificationSubscription.

فیلدها
notification_ subscription

NotificationSubscription

مورد نیاز. نسخه جدید اشتراک اعلان که باید به روز شود.

update_ mask

FieldMask

لیست فیلدهای در حال به روز رسانی