Package google.mybusiness.notifications.v1

الفهرس

NotificationSettings

تتيح هذه الخدمة للمستخدمين إدارة إعدادات الإشعارات لحسابات الأعمال.

GetNotificationSetting

rpc GetNotificationSetting(GetNotificationSettingRequest) returns (NotificationSetting)

لعرض إعدادات إشعارات pubsub للحساب.

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

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

  • https://www.googleapis.com/auth/business.manage

لمزيد من المعلومات، راجِع نظرة عامة على بروتوكول OAuth 2.0.
UpdateNotificationSetting

rpc UpdateNotificationSetting(UpdateNotificationSettingRequest) returns (NotificationSetting)

تعمل على ضبط إعداد إشعار pubsub للحساب الذي يُعلم Google بالموضوع الذي تريد إرسال إشعارات pubsub له. استخدم الحقل Notification_types (أنواع الإشعارات) ضمن notifications_setting لمعالجة الأحداث التي يريد الحساب الاشتراك فيها.

سيتضمن الحساب موردًا واحدًا فقط لإعداد الإشعارات، ويمكن ضبط موضوع pubsub واحد فقط. لحذف هذه الإعدادات، يجب تعديلها باستخدام نوع notifications_types فارغ.

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

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

  • https://www.googleapis.com/auth/business.manage

لمزيد من المعلومات، راجِع نظرة عامة على بروتوكول OAuth 2.0.

ErrorCode

جميع رموز الأخطاء التي تعرضها واجهة برمجة التطبيقات

عمليات التعداد
ERROR_CODE_UNSPECIFIED رمز الخطأ غير متوفّر.
SHARES_PUBSUB_TOPIC_MESSAGE_ACROSS_VERSIONS تستخدم إصدارات أخرى من واجهة برمجة التطبيقات هذه اسم موضوع النشر/الموضوع الفرعي المقدَّم في سياسة rpc 'updateNotificationSetup'. يُرجى تقديم اسم موضوع جديد للتخفيف من هذه المشكلة.
PUBLISH_PERMISSIONS_MISSING_FOR_PUBSUB_TOPIC لا يشتمل اسم موضوع النشر/الموضوع الفرعي المقدم لإعداد إشعارات التحديث على أذونات نشر للمستخدم.
INVALID_PUBSUB_TOPIC اسم موضوع النشر/الموضوع الفرعي الذي تم تقديمه لإعداد إشعارات التحديث غير صالح.

GetNotificationSettingRequest

طلب رسالة لـ NotificationSettings.GetNotificationSettings

الحقول
name

string

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

NotificationSetting

موضوع Google Pub/Sub حيث يمكن نشر الإشعارات عند تعديل أحد المواقع أو عند إضافة مراجعة جديدة إليه. سيكون هناك مورد واحد فقط لإعدادات الإشعارات لكل حساب.

الحقول
name

string

مطلوبة. اسم المورد المعيَّن لهذا الإعداد هذا هو النموذج accounts/{account_id}/notificationSetting.
pubsub_topic

string

اختياريّ. موضوع Google Pub/Sub الذي سيتلقى إشعارات عندما يتم تحديث المواقع الجغرافية التي يديرها هذا الحساب. وفي حال ترك هذه السياسة بدون ضبط، لن يتم نشر أي إشعارات.

يجب أن يمتلك الحساب mybusiness-api-pubsub@system.gserviceaccount.com أذونات نشر على الأقل حول موضوع النشر/الاشتراك.
notification_types[]

NotificationType

أنواع الإشعارات التي سيتم إرسالها إلى موضوع النشر/الاشتراك. لإيقاف تلقّي الإشعارات بالكامل، استخدِم NotificationSettings.UpdateNotificationSettings مع قيمة notifications_types فارغة، أو اضبط pubsub_topic على سلسلة فارغة.

NotificationType

نوع الإشعار الذي تم إرساله إلى موضوع النشر/الاشتراك.

عمليات التعداد
NOTIFICATION_TYPE_UNSPECIFIED ما مِن نوع إشعار. لن تتم مطابقة أي إشعارات.
GOOGLE_UPDATE يتضمن الموقع تحديثات Google للمراجعة. سيعرض حقل location_name في الإشعار اسم مورد الموقع مع تحديثات Google.
NEW_REVIEW تمت إضافة مراجعة جديدة إلى الموقع. وسيعرض حقل "review_name" في الإشعار اسم المورد للمراجعة التي تمت إضافتها، وسيحتوي حقل location_name على اسم مورد الموقع الجغرافي.
UPDATED_REVIEW تم تعديل مراجعة للموقع. وسيعرض حقل "review_name" في الإشعار اسم المورد للمراجعة التي تمت إضافتها، وسيحتوي حقل location_name على اسم مورد الموقع الجغرافي.
NEW_CUSTOMER_MEDIA أضاف أحد مستخدمي "خرائط Google" عنصر وسائط جديد إلى الموقع الجغرافي. سيقدّم الإشعار اسم المورد لعنصر الوسائط الجديد.
NEW_QUESTION وتتم إضافة سؤال جديد إلى الموقع الجغرافي. سيزوّد الإشعار اسم المورد المعني.
UPDATED_QUESTION تم تعديل سؤال حول الموقع الجغرافي. سيزوّد الإشعار اسم المورد المعني.
NEW_ANSWER وتتم إضافة إجابة جديدة إلى الموقع الجغرافي. سيوفر الإشعار اسم المورد الخاص بالسؤال والجواب.
UPDATED_ANSWER تم تعديل إجابة الموقع الجغرافي. سيوفر الإشعار اسم المورد الخاص بالسؤال والجواب.
DUPLICATE_LOCATION يشير إلى ما إذا كان هناك تغيير في حقل الموقع المكرّر لبيانات الموقع الوصفية.
LOSS_OF_VOICE_OF_MERCHANT

مهملة: يمكنك نقل الاستخدامات الحالية لهذه القيمة إلى القيمة "VOICE_OF_MERCHANT_UPDATED" الأكثر توسيعًا.
VOICE_OF_MERCHANT_UPDATED يشير إلى ما إذا كان للموقع الجغرافي تم تعديله في حالة Voice of Merchant (VOM). تحدّد طريقة VOM ما إذا كان الموقع الجغرافي في وضع جيد وأنّ التاجر يتحكّم في النشاط التجاري على Google. سيتم نشر أي تعديلات يتم إجراؤها على الموقع الجغرافي على "خرائط Google" بعد اجتياز مرحلة المراجعة. يمكنك الاتصال بـ GetVoiceOfMerchantState rpc للحصول على مزيد من التفاصيل.

UpdateNotificationSettingRequest

رسالة طلب لـ NotificationSettings.UpdateNotificationSettings.

الحقول
notification_setting

NotificationSetting

مطلوبة. إعدادات الإشعارات المعدّلة
update_mask

FieldMask

مطلوبة. الحقول المحددة التي يجب تعديلها. الحقل الوحيد القابل للتعديل هو notifications_setting.