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.

السمة

حقل التعداد لتحديد السمة في المورد الذي يتم تغييره لإعلام التاجر بذلك

عمليات التعداد
ATTRIBUTE_UNSPECIFIED سمة غير محدّدة
STATUS حالة العنصر الذي تم تغييره

CreateNotificationSubscriptionRequest

رسالة طلب حول طريقة CreateNotificationSUBSCRIPTION

الحقول
parent

string

مطلوبة. حساب التاجر الذي يملك الاشتراك الجديد في الإشعارات تنسيق الملف: accounts/{account}
notification_subscription

NotificationSubscription

مطلوبة. الاشتراك في الإشعارات الذي تريد إنشاءه

DeleteNotificationSubscriptionRequest

طلب رسالة لطريقة Delete NotificationSUBSCRIPTION

الحقول
name

string

مطلوبة. اسم الاشتراك في الإشعارات الذي تريد حذفه.

GetNotificationSubscriptionRequest

رسالة طلب حول طريقة GetNotification Subscription.

الحقول
name

string

مطلوبة. name الخاص باشتراك الإشعارات.

ListNotificationSubscriptionsRequest

رسالة طلب حول طريقة ListNotification Subscription.

الحقول
parent

string

مطلوبة. حساب التاجر الذي يملك اشتراكات الإشعارات تنسيق الملف: accounts/{account}
page_size

int32

الحد الأقصى لعدد اشتراكات الإشعارات المطلوب عرضها في الصفحة القيمة التلقائية للحقل "page_size" هي 100. الحد الأقصى للقيمة هو 200. سيتم فرض القيم التي تتجاوز 200 على 200.
page_token

string

الرمز المميّز (إذا تم توفيره) لاسترداد الصفحة اللاحقة. يجب أن تتطابق جميع المَعلمات الأخرى مع الاستدعاء الأصلي الذي وفّر الرمز المميّز للصفحة.

ListNotificationSubscriptionsResponse

رسالة استجابة لطريقة ListNotification Subscription.

الحقول
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

يمثل نوع الحدث الذي يريد التاجر تلقّي إشعارات بشأنه.

عمليات التعداد
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}}

المورد

التعداد لتحديد المورد الذي يتم تغييره لإبلاغ التاجر به.

عمليات التعداد
RESOURCE_UNSPECIFIED مورد غير محدّد
PRODUCT نوع المورد : منتج

UpdateNotificationSubscriptionRequest

رسالة طلب الخاصة بطريقة UpdateNotification Subscription.

الحقول
notification_subscription

NotificationSubscription

مطلوبة. يشير إلى الإصدار الجديد من الاشتراك في الإشعارات الذي يجب تحديثه.
update_mask

FieldMask

قائمة الحقول التي يتم تعديلها