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

rpc UpdateNotificationSubscription(UpdateNotificationSubscriptionRequest) returns (NotificationSubscription)

تعديل اشتراك حالي في الإشعارات للتاجر

نطاقات التفويض

يجب توفير نطاق OAuth التالي:

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

لمزيد من المعلومات، يُرجى الاطّلاع على OAuth 2.0 Overview.

السمة

فهرس لتحديد السمة في المورد التي يتم تغييرها لإرسال إشعار بها إلى التاجر

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

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

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

وقت انتهاء صلاحية المنتج. لن يتم ضبط هذا الحقل إذا تم إرسال الإشعار لحدث حذف منتج.

المورد

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

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

UpdateNotificationSubscriptionRequest

رسالة طلب لطريقة UpdateNotificationSubscription

الحقول
notification_subscription

NotificationSubscription

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

FieldMask

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