Package google.mybusiness.placeactions.v1

الفهرس

• PlaceActions (واجهة)
• CreatePlaceActionLinkRequest (رسالة)
• DeletePlaceActionLinkRequest (رسالة)
• ErrorCode (تعداد)
• GetPlaceActionLinkRequest (رسالة)
• ListPlaceActionLinksRequest (رسالة)
• ListPlaceActionLinksResponse (رسالة)
• ListPlaceActionTypeMetadataRequest (رسالة)
• ListPlaceActionTypeMetadataResponse (رسالة)
• PlaceActionLink (رسالة)
• PlaceActionLink.ProviderType (تعداد)
• PlaceActionType (تعداد)
• PlaceActionTypeMetadata (رسالة)
• UpdatePlaceActionLinkRequest (رسالة)

PlaceActions

تفعِّل واجهة برمجة التطبيقات هذه إدارة روابط PlaceAction للمواقع الجغرافية للنشاط التجاري.

CreatePlaceActionLink

rpc CreatePlaceActionLink(CreatePlaceActionLinkRequest) returns (PlaceActionLink) تنشئ رابطًا لإجراء مكان مرتبط بالموقع الجغرافي المحدَّد ويعرضه. يُعتبر الطلب مكرّرًا إذا كانت العناصر parent وplace_action_link.uri وplace_action_link.place_action_type مطابقة لطلب سابق. نطاقات التفويض يجب توفير نطاق OAuth التالي: https://www.googleapis.com/auth/business.manage لمزيد من المعلومات، راجِع نظرة عامة على بروتوكول OAuth 2.0.

DeletePlaceActionLink
rpc DeletePlaceActionLink(DeletePlaceActionLinkRequest) returns (Empty) حذف رابط إجراء مكان من الموقع المحدّد. نطاقات التفويض يجب توفير نطاق OAuth التالي: https://www.googleapis.com/auth/business.manage لمزيد من المعلومات، راجِع نظرة عامة على بروتوكول OAuth 2.0.

GetPlaceActionLink
rpc GetPlaceActionLink(GetPlaceActionLinkRequest) returns (PlaceActionLink) الحصول على رابط الإجراء المحدّد المتعلّق بالمكان. نطاقات التفويض يجب توفير نطاق OAuth التالي: https://www.googleapis.com/auth/business.manage لمزيد من المعلومات، راجِع نظرة عامة على بروتوكول OAuth 2.0.

ListPlaceActionLinks
rpc ListPlaceActionLinks(ListPlaceActionLinksRequest) returns (ListPlaceActionLinksResponse) يسرد روابط الإجراءات المستندة إلى المكان للموقع الجغرافي المحدّد. نطاقات التفويض يجب توفير نطاق OAuth التالي: https://www.googleapis.com/auth/business.manage لمزيد من المعلومات، راجِع نظرة عامة على بروتوكول OAuth 2.0.

ListPlaceActionTypeMetadata
rpc ListPlaceActionTypeMetadata(ListPlaceActionTypeMetadataRequest) returns (ListPlaceActionTypeMetadataResponse) تعرض قائمة بأنواع إجراءات الأماكن المتاحة لموقع جغرافي أو بلد معيّن. نطاقات التفويض يجب توفير نطاق OAuth التالي: https://www.googleapis.com/auth/business.manage لمزيد من المعلومات، راجِع نظرة عامة على بروتوكول OAuth 2.0.

UpdatePlaceActionLink
rpc UpdatePlaceActionLink(UpdatePlaceActionLinkRequest) returns (PlaceActionLink) تعمل على تعديل رابط الإجراء المحدّد المستنِد إلى المكان وعرضه. نطاقات التفويض يجب توفير نطاق OAuth التالي: https://www.googleapis.com/auth/business.manage لمزيد من المعلومات، راجِع نظرة عامة على بروتوكول OAuth 2.0.

CreatePlaceActionLinkRequest

طلب رسالة لـ PlaceActions.CreatePlaceActionLink

الحقول
parent	string مطلوبة. اسم المورد للموقع الجغرافي الذي يتم فيه إنشاء رابط هذا الإجراء المتعلّق بالمكان locations/{location_id}.
place_action_link	PlaceActionLink مطلوبة. رابط الإجراء المستنِد إلى المكان الذي سيتمّ إنشاؤه

DeletePlaceActionLinkRequest

طلب رسالة لـ PlaceActions.DeletePlaceActionLink

الحقول
name	string مطلوبة. اسم المورد لرابط الإجراء المتعلّق بالمكان المطلوب إزالته من الموقع الجغرافي.

ErrorCode

رموز خطأ للأعطال الداخلية

عمليات التعداد
ERROR_CODE_UNSPECIFIED	رمز خطأ غير محدَّد.
UNVERIFIED_LOCATION	لم يتم إثبات ملكية الموقع الجغرافي.
INVALID_LOCATION_CATEGORY	فئة الموقع الجغرافي غير مؤهَّلة لنوع الإجراء المتعلّق بالمكان. سيتم عرض نوع إجراء المكان الذي يتسبّب في حدوث الخطأ في البيانات الوصفية، مع استخدام السلسلة "place_action_type" كمفتاح وسلسلة قيمة تعداد PlaceActionType باعتبارها القيمة.
INVALID_URL	عنوان URL غير صالح/غير صالح. سيتم عرض عنوان URL لإجراء المكان غير الصالح في البيانات الوصفية، مع استخدام السلسلة "url" كمفتاح وعنوان URL كقيمة.
URL_PROVIDER_NOT_ALLOWED	يحتوي عنوان URL على موفر غير مسموح به. سيتم عرض عنوان URL لإجراء المكان غير المسموح به في البيانات الوصفية، مع استخدام السلسلة "url" كمفتاح وعنوان URL كقيمة.
TOO_MANY_VALUES	تم ضبط عدد كبير جدًا من القيم لنوع إجراء المكان. سيتم عرض النوع الذي تم بلوغ الحد الأقصى له في البيانات الوصفية، مع إدراج السلسلة "place_action_type" كمفتاح وسلسلة قيمة التعداد PlaceActionType كقيمة.
DELETED_LINK	تم حذف رابط الإجراء المطلوب المتعلّق بالمكان. سيتم عرض عنوان URL المقابل في البيانات الوصفية، مع استخدام السلسلة "url" كمفتاح وعنوان url كقيمة.
LINK_ALREADY_EXISTS	جارٍ طلب تحديث لتحويل رابط إجراء مكان إلى رابط إجراء موجود سلفًا، ويحمل معرّف الموارد المنتظم (URI) نفسه والنوع نفسه في الموقع الجغرافي المحدّد.
SCALABLE_DEEP_LINK_INVALID_MULTIPLICITY	سبقَ استخدام النطاق الذي يحتوي عليه الرابط، وهناك حدّ أقصى يبلغ رابطًا واحدًا لكل نطاق بالنسبة إلى كل PlaceActionType.
LINK_DOES_NOT_EXIST	تم تحديد رابط لا يمكن العثور عليه في قاعدة البيانات.

GetPlaceActionLinkRequest

طلب رسالة لـ PlaceActions.GetPlaceActionLink

الحقول
name	string مطلوبة. اسم رابط إجراء المكان المطلوب جلبه.

ListPlaceActionLinksRequest

طلب رسالة لـ PlaceActions.ListPlaceActionLinks سيؤدي هذا إلى إدراج روابط إجراءات الأماكن الخاصة بموقع جغرافي معيّن، بدون ترتيب محدّد. قد لا يؤدي ذلك إلى عرض الروابط التي تم إنشاؤها مؤخرًا (خلال آخر 24 ساعة) من خلال مساحات عرض أخرى، مثل الموقع الإلكتروني لـ "نشاطي التجاري على Google". أي رابط تم إنشاؤه قبل أكثر من 24 ساعة سيظهر من خلال واجهة برمجة التطبيقات هذه.

الحقول
parent	string مطلوبة. اسم الموقع الجغرافي الذي سيتم سرد روابط إجراءات اتّخاذه. locations/{location_id}.
filter	string اختياريّ. فلتر يقيد ارتباط الإجراء المكاني بالرجوع. يتضمن الرد الإدخالات التي تتطابق مع الفلتر. نتيح استخدام الفلتر التالي فقط: 1-place_action_type=XYZ حيث يكون XYZ هو PlaceActionType صالح.
page_size	int32 اختياريّ. عدد روابط الإجراءات المستندة إلى المكان المطلوب عرضها لكل صفحة. العدد التلقائي 10. الحد الأدنى هو 1.
page_token	string اختياريّ. وفي حال تحديدها، سيتم عرض الصفحة التالية من روابط الإجراءات المستنِدة إلى المكان.

ListPlaceActionLinksResponse

رسالة الرد لـ PlaceActions.ListActionLinks.

الحقول
place_action_links[]	PlaceActionLink القائمة المعروضة لروابط إجراءات المكان.
next_page_token	string في حال كان هناك عدد أكبر من روابط الإجراءات المستندة إلى المكان مقارنةً بحجم الصفحة المطلوب، ستتم تعبئة هذا الحقل برمز مميّز لجلب الصفحة التالية من النتائج.

ListPlaceActionTypeMetadataRequest

طلب رسالة لـ PlaceActions.ListActionTypeMetadata. سيتم إرجاع النتائج بدون ترتيب محدّد.

الحقول
language_code	string اختياريّ. رمز اللغة المطلوب استخدام الأسماء المعروضة فيه، وفقًا لمجموعة معايير IETF BCP-47. إذا لم تكن هذه اللغة متاحة، سيتم توفيرها باللغة الإنجليزية.
page_size	int32 اختياريّ. عدد أنواع الإجراءات التي يجب تضمينها في كل صفحة. القيمة التلقائية هي 10، والحد الأدنى هو 1.
page_token	string اختياريّ. وفي حال تحديد ذلك، يتم استرداد الصفحة التالية من البيانات الوصفية لنوع إجراء المكان. يتم عرض pageToken عندما تؤدي استدعاء placeActionTypeMetadata.list إلى عرض نتائج أكثر مما يمكن أن يلائم حجم الصفحة المطلوب.
filter	string اختياريّ. فلتر يقيد أنواع إجراءات المكان لعرض بيانات وصفية لها. يتضمن الرد الإدخالات التي تتطابق مع الفلتر. نتيح فقط استخدام الفلاتر التالية: 1- location=XYZ حيث XYZ عبارة عن سلسلة تشير إلى اسم مورد موقع، بالتنسيق locations/{location_id}. 2. region_code=XYZ حيث XYZ رمز منطقة Unicode CLDR للبحث عن أنواع الإجراءات المتاحة. وفي حال عدم توفير أي فلتر، يتم عرض جميع أنواع إجراءات الأماكن.

ListPlaceActionTypeMetadataResponse

رسالة رد لـ PlaceActions.ListActionTypeMetadata.

الحقول
place_action_type_metadata[]	PlaceActionTypeMetadata مجموعة من البيانات الوصفية لأنواع الإجراءات المستندة إلى الأماكن.
next_page_token	string إذا تجاوز عدد أنواع الإجراءات حجم الصفحة المطلوب، ستتم تعبئة هذا الحقل برمز مميّز لجلب الصفحة التالية عند إجراء مكالمة لاحقة إلى placeActionTypeMetadata.list. إذا لم تكن هناك نتائج أخرى، لن يظهر هذا الحقل في الردّ.

PlaceActionLink

يمثّل رابط الإجراء المستند إلى المكان وسماته.

الحقول
name	string اختياريّ. اسم المورد بالتنسيق locations/{location_id}/placeActionLinks/{place_action_link_id}. لن يتم النظر في حقل الاسم إلا في طلبي UpdatePlaceActionLink وDeletePlaceActionLink لتحديث الروابط وحذفها على التوالي. ومع ذلك، سيتم تجاهله في طلب CreatePlaceActionLink، حيث سيتم تعيين place_action_link_id من قِبل الخادم عند إنشاء رابط جديد بنجاح وسيتم عرضه كجزء من الاستجابة.
provider_type	ProviderType النتائج فقط. تحدد هذه السمة نوع مقدّم الخدمة.
is_editable	bool النتائج فقط. تشير هذه السمة إلى ما إذا كان بإمكان العميل تعديل هذا الرابط.
uri	string مطلوبة. معرّف الموارد المنتظم (URI) للرابط. يمكن إعادة استخدام معرّف الموارد المنتظم (URI) نفسه لأنواع إجراءات مختلفة في مواقع جغرافية مختلفة. ومع ذلك، لا يُسمح إلا برابط واحد لإجراء مكان واحد لكل مجموعة فريدة من (معرّف الموارد المنتظم (URI) ونوع إجراء المكان والموقع الجغرافي).
place_action_type	PlaceActionType مطلوبة. نوع الإجراء المكاني الذي يمكن تنفيذه باستخدام هذا الرابط.
is_preferred	bool اختياريّ. ما إذا كان التاجر يُفضِّل هذا الرابط. يمكن وضع علامة "مفضّل" على رابط واحد فقط لكل نوع إجراء خاص بالموقع الجغرافي. إذا كان الطلب المستقبلي يضع علامة على رابط مختلف على أنّه مفضل لنوع إجراء المكان نفسه، سيفقد الرابط المفضّل الحالي (إن وُجد) الخيار المفضّل.
create_time	Timestamp النتائج فقط. الوقت الذي تم فيه إنشاء رابط الإجراء المستنِد إلى المكان.
update_time	Timestamp النتائج فقط. وقت آخر تعديل على رابط الإجراء المستنِد إلى المكان.

ProviderType

يمكن قراءة نوع موفر الروابط فقط.

عمليات التعداد
PROVIDER_TYPE_UNSPECIFIED	غير محدَّد.
MERCHANT	مقدّم خدمة الطرف الأول، مثل تاجر أو وكالة بالنيابة عن تاجر
AGGREGATOR_3P	مجمّع سلع تابع لجهة خارجية، مثل شريك Reserve with Google

PlaceActionType

تمثّل هذه السمة نوع الإجراء المكاني الذي يمكن تنفيذه باستخدام الرابط.

عمليات التعداد
PLACE_ACTION_TYPE_UNSPECIFIED	غير محدَّد.
APPOINTMENT	نوع الإجراء هو حجز موعد.
ONLINE_APPOINTMENT	نوع الإجراء هو حجز موعد على الإنترنت.
DINING_RESERVATION	نوع الإجراء هو إجراء حجز لتناول الطعام.
FOOD_ORDERING	إنّ نوع الإجراء هو طلب خدمة التوصيل و/أو طلب الوجبات الجاهزة لتناولها خارج المطعم.
FOOD_DELIVERY	نوع الإجراء هو طلب الطعام للتوصيل.
FOOD_TAKEOUT	نوع الإجراء هو طلب الطعام لتناوله خارجًا.
SHOP_ONLINE	نوع الإجراء هو التسوّق، ويمكن تسليمه و/أو استلامه.

PlaceActionTypeMetadata

البيانات الوصفية لأنواع الإجراءات القائمة على الأماكن المتاحة

الحقول
place_action_type	PlaceActionType نوع إجراء المكان.
display_name	string الاسم المعروض المترجَم للسمة (إذا كان متاحًا)، وإلّا الاسم المعروض باللغة الإنجليزية.

UpdatePlaceActionLinkRequest

طلب رسالة لـ PlaceActions.UpdatePlaceActionLink

الحقول
place_action_link	PlaceActionLink مطلوبة. رابط الإجراء المستنِد إلى المكان الذي تم تعديله.
update_mask	FieldMask مطلوبة. الحقول المحدّدة المطلوب تعديلها الحقول الوحيدة القابلة للتعديل هي uri وplace_action_type وis_preferred. إذا كان الرابط المعدَّل متوفّرًا حاليًا في الموقع نفسه بالسمتَين place_action_type وuri نفسهما، سيتعذّر تنفيذ الإجراء مع ظهور الخطأ ALREADY_EXISTS.