- طلب HTTP
- نص الطلب
- نص الاستجابة
- المعالج
- النية بالشراء
- IntentParameterValue
- المشهد
- SlotFillingStatus
- فتحة
- SlotMode
- SlotStatus
- طلب
- بسيط
- المحتوى
- البطاقة
- الصورة
- ImageFill
- الرابط
- OpenUrl
- UrlHint
- جدول
- TableColumn
- HorizontalAlignment
- TableRow
- TableCell
- الوسائط
- MediaType
- OptionalMediaControls
- MediaObject
- MediaImage
- RepeatMode
- التجميع
- CollectionItem
- قائمة
- ListItem
- CollectionBrowse
- السلعة
- اقتراح
- لوحة الرسم
- ContinuousMatchConfig
- ExpectedPhrase
- OrderUpdate
- النوع
- الترتيب
- معلومات المستخدم
- PhoneNumber
- الصورة
- التاجر
- الموقع الجغرافي
- LatLng
- PostalAddress
- جدول المحتويات
- LineItem
- PriceAttribute
- النوع
- الولاية
- المال
- الإجراء
- النوع
- OpenUrlAction
- AndroidApp
- VersionFilter
- UrlTypeHint
- ActionMetadata
- الإفصاح
- DisclosureText
- TextLink
- DisclosurePresentationOptions
- PresentationRequirement
- PurchaseItemExtension
- PurchaseStatus
- PurchaseType
- MerchantUnitMeasure
- الوحدة
- PurchaseReturnsInfo
- PurchaseFulfillmentInfo
- النوع
- الوقت
- PickupInfo
- PickupType
- CurbsideInfo
- CurbsideFulfillmentType
- مركبة
- CheckInInfo
- CheckInType
- ItemOption
- ProductDetails
- ReservationItemExtension
- ReservationStatus
- ReservationType
- StaffFacilitator
- PaymentData
- PaymentResult
- PaymentInfo
- PaymentMethodDisplayInfo
- PaymentType
- PaymentMethodProvenance
- العروض الترويجية
- PurchaseOrderExtension
- PurchaseLocationType
- PurchaseError
- ErrorType
- TicketOrderExtension
- TicketEvent
- النوع
- EventCharacter
- النوع
- UserNotification
- NextScene
- الجلسة
- TypeOverride
- TypeOverrideMode
- SynonymType
- الإدخال
- EntryDisplay
- المستخدم
- AccountLinkingStatus
- UserVerificationStatus
- التفاعل
- IntentSubscription
- PackageEntitlements
- إذن الوصول إلى الموقع الإلكتروني
- SkuType
- SignedData
- الإذن
- الشاشة الرئيسية
- الجهاز
- الإمكانات
- الموقع الجغرافي
- TimeZone
- السياق
- MediaContext
- CanvasContext
- المتوقعة
استدعاء إجراء عن بُعد (RPC) الذي يمثّل واجهة برمجة التطبيقات الخاصة بالتنفيذ
طلب HTTP
POST https://webhook_handler_service.googleapis.com/fulfill
يستخدِم عنوان URL بنية تحويل ترميز gRPC.
نص الطلب
يحتوي نص الطلب على بيانات بالبنية التالية:
تمثيل JSON | |
---|---|
{ "handler": { object ( |
الحقول | |
---|---|
handler |
مطلوب. معلومات حول كيفية التعامل مع الطلب. على سبيل المثال، قد يحتوي الطلب الذي يهدف إلى الحصول على حقيقة على معالج يحمل اسم getFact. |
intent |
مطلوب. يمثل آخر غرض مطابق. يُرجى الاطّلاع على https://developers.google.com/assistant/conversational/intents. |
scene |
اختياريّ. معلومات عن المشهد الحالي والمشهد التالي عند استدعاء الدالة سيتم ملء هذا الحقل عند إجراء طلب التنفيذ ضمن نطاق مشهد. للاطّلاع على مزيد من المعلومات، يُرجى الانتقال إلى https://developers.google.com/assistant/conversational/scenes. |
session |
مطلوب. يحتفظ ببيانات الجلسة مثل معرِّف الجلسة ومَعلماتها. |
user |
مطلوب. المستخدم الذي بدأ المحادثة. |
home |
اختياريّ. تشير هذه السمة إلى معلومات ذات صلة ببنية HomeGraph التي ينتمي إليها الجهاز المستهدَف. يمكنك الاطّلاع على https://developers.google.com/actions/smarthome/concepts/homegraph. |
device |
مطلوب. معلومات عن الجهاز الذي يستخدمه المستخدم للتفاعل مع الإجراء. |
context |
اختياريّ. معلومات السياق الحالي للطلب. تتضمن، على سبيل المثال لا الحصر، معلومات جلسة الوسائط النشطة أو معلومات اللوحة. |
نص الاستجابة
إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:
يمثل هذا الإعداد ردًّا يتم إرساله من عملية تنفيذ المطوّر إلى "المهام مع مساعد Google".
تمثيل JSON | |
---|---|
{ "prompt": { object ( |
الحقول | |
---|---|
prompt |
اختياريّ. تمثّل الطلبات التي سيتم إرسالها إلى المستخدم، وسيتم إلحاقها بالرسائل التي تمت إضافتها مسبقًا ما لم يتم استبدالها بشكل صريح. |
scene |
اختياريّ. يمثل المشهد الحالي والتالي. في حال ضبط |
session |
اختياريّ. يصف هذا الحقل بيانات الجلسة الحالية، ويمكن إنشاء مَعلمات الجلسة أو تعديلها أو إزالتها من خلال عملية التنفيذ. |
user |
اختياريّ. استخدِم هذا العمود لتحديد مَعلمات المستخدم المطلوب إرسالها مجددًا. |
home |
اختياريّ. يتم استخدامه لتحديد معلَمات ذات صلة ببنية HomeGraph التي ينتمي إليها الجهاز المستهدف. يمكنك الاطّلاع على https://developers.google.com/actions/smarthome/concepts/homegraph. |
device |
اختياريّ. استخدِم هذه الميزة للتنقّل بين الأجهزة المزوّدة بخدمة "مساعد Google" والتي يمكن للمستخدم الوصول إليها. |
expected |
اختياريّ. يصف التوقعات بشأن منعطف الحوار التالي. |
المعالج
يمثل هذا الإعداد معالج تنفيذ يربط معلومات الأحداث من "المهام مع مساعد Google" إلى عملية التنفيذ. استخدِم اسم المعالج لتحديد الرمز البرمجي الذي يجب تشغيله في عملية التنفيذ. على سبيل المثال، يمكن استخدام معالج للحصول على معلومات عن معلومات طلب المستخدم باستخدام اسم معالِج مثل "OrderLookup" بينما يحصل تطبيق آخر على معلومات المنتج من قاعدة بيانات، باستخدام اسم معالج مثل "GetProductInfo".
تمثيل JSON | |
---|---|
{ "name": string } |
الحقول | |
---|---|
name |
اختياريّ. اسم المعالج. |
النيّة بالشراء
يمثل نية. يُرجى الاطّلاع على https://developers.google.com/assistant/conversational/intents.
تمثيل JSON | |
---|---|
{
"name": string,
"params": {
string: {
object ( |
الحقول | |
---|---|
name |
مطلوب. اسم آخر غرض مطابق. |
params |
مطلوب. تمثل المَعلمات المحدَّدة كجزء من مطابقة النية. هذه خريطة لاسم المَعلمة المحدّدة بقيمة المَعلمة المحدّدة من إدخال المستخدم. ستظهر هنا جميع المَعلمات المحدّدة في الغرض المطابق والمحدد. عنصر يحتوي على قائمة بأزواج |
query |
اختياريّ. الإدخال المكتوب أو المنطوق من المستخدم النهائي الذي يطابق هذا الهدف ستتم تعبئة هذا الحقل عند مطابقة هدف، استنادًا إلى إدخال المستخدم. |
IntentParameterValue
يمثل قيمة لمعلَمة intent. يُرجى الاطّلاع على https://developers.google.com/assistant/conversational/types.
تمثيل JSON | |
---|---|
{ "original": string, "resolved": value } |
الحقول | |
---|---|
original |
مطلوب. قيمة النص الأصلية المستخرجة من كلام المستخدم. |
resolved |
مطلوب. القيمة المنظَّمة للمَعلمة المستخرجة من البيانات التي أدخلها المستخدم لن تتم تعبئة هذا الحقل إلا إذا تم تحديد المعلمة في الغرض المطابق، وكان من الممكن تحديد قيمة المعلمة أثناء مطابقة النية. |
منظر
تمثيل مشهد. يمكن للمشاهد استدعاء عملية التنفيذ وإضافة الطلبات وجمع قيم الخانة من المستخدم. يتم تشغيل المشاهد حسب الأحداث أو الأهداف، ويمكن أن تؤدي إلى بدء الأحداث ومطابقة الأهداف للانتقال إلى مشاهد أخرى.
تمثيل JSON | |
---|---|
{ "name": string, "slotFillingStatus": enum ( |
الحقول | |
---|---|
name |
مطلوب. اسم المشهد الحالي |
slotFillingStatus |
مطلوب. الحالة الحالية لملء الخانات هذا الحقل للقراءة فقط. |
slots |
الخانات المرتبطة بالمشهد الحالي لا يمكن لردود المعالج عرض خانات لم يتم إرسالها في الطلب. عنصر يحتوي على قائمة بأزواج |
next |
اختياريّ. المعلومات على المشهد المطلوب تنفيذها في المرة التالية |
SlotFillingStatus
يمثل هذا الوضع الحالة الحالية لملء الخانات.
عمليات التعداد | |
---|---|
UNSPECIFIED |
القيمة الاحتياطية عندما لا تتم تعبئة حقل الاستخدام |
INITIALIZED |
تم إعداد الخانات ولكن لم يبدأ ملء الخانات. |
COLLECTING |
جارٍ جمع قيم الخانة. |
FINAL |
كل قيم الخانة نهائية ولا يمكن تغييرها. |
الحيز
يمثل خانة.
تمثيل JSON | |
---|---|
{ "mode": enum ( |
الحقول | |
---|---|
mode |
وضع الخانة (مطلوب أو اختياري). يمكن ضبطه من قِبل المطوّر. |
status |
حالة الخانة. |
value |
قيمة الخانة. سيؤدي تغيير هذه القيمة في الاستجابة إلى تعديل القيمة في ملء الخانة. |
updated |
يشير إلى ما إذا تم جمع قيمة الخانة في آخر منعطف. هذا الحقل للقراءة فقط. |
prompt |
اختياريّ. يتم إرسال هذا الطلب إلى المستخدم عند الحاجة لملء الفترة المطلوبة. يلغي هذا الطلب الطلب الحالي المحدَّد في وحدة التحكّم. لا يتم تضمين هذا الحقل في طلب الرد التلقائي على الويب. |
SlotMode
يمثل وضع الخانة، أي إذا كان مطلوبًا أم لا.
عمليات التعداد | |
---|---|
MODE_UNSPECIFIED |
القيمة الاحتياطية عندما لا تتم تعبئة حقل الاستخدام |
OPTIONAL |
يشير إلى أنّ الفتحة غير مطلوبة لإكمال ملء الخانة. |
REQUIRED |
يشير إلى أنّ الفتحة مطلوبة لإكمال ملء الخانة. |
SlotStatus
يمثل حالة خانة.
عمليات التعداد | |
---|---|
SLOT_UNSPECIFIED |
القيمة الاحتياطية عندما لا تتم تعبئة حقل الاستخدام |
EMPTY |
يشير إلى عدم توفّر أي قيم للخانة. ولا يمكن تعديل هذه الحالة من خلال الرد. |
INVALID |
يشير إلى أن قيمة الخانة غير صالحة. يمكن تحديد هذه الحالة من خلال الردّ. |
FILLED |
يشير إلى قيمة الفتحة. ولا يمكن تعديل هذه الحالة من خلال الرد. |
طلب واحد
تمثيل رد لمستخدم. يُرجى الاطّلاع على https://developers.google.com/assistant/conversational/prompts.
تمثيل JSON | |
---|---|
{ "override": boolean, "firstSimple": { object ( |
الحقول | |
---|---|
override |
اختياريّ. وضع لكيفية دمج هذه الرسائل مع الرسائل المحددة مسبقًا. "صحيح" يمحو جميع الرسائل المحددة سابقًا (الأول والأخير البسيط، ورابط المحتوى والاقتراحات، ولوحة الرسم) ويضيف الرسائل المحددة في هذا الطلب. "خطأ" تضيف الرسائل المحدَّدة في هذا الطلب إلى الرسائل المحدَّدة في الردود السابقة. ترك هذا الحقل على "خطأ" يمكّن أيضًا الإلحاق ببعض الحقول داخل الطلبات البسيطة ومطالبة الاقتراحات ومطالبة لوحة الرسم (جزء من مطالبة المحتوى). يتم دائمًا استبدال رسائل "المحتوى" و"الروابط" إذا تم تحديدها في الطلب. القيمة التلقائية هي "خطأ". |
firstSimple |
اختياريّ. أول رد صوتي ونص فقط. |
content |
اختياريّ. محتوى مثل بطاقة أو قائمة أو وسائط لعرضها للمستخدم. |
lastSimple |
اختياريّ. آخر رد صوتي ونص فقط. |
suggestions[] |
اختياريّ. سيتم عرض الاقتراحات للمستخدم والتي ستظهر دائمًا في نهاية الردّ. إذا تم "تجاوز" في الطلب الذي يتضمن القيمة "false"، ستتم إضافة العناوين المحددة في هذا الحقل إلى العناوين المحددة في أي طلبات اقتراحات محددة مسبقًا، وستتم إزالة القيم المكررة. |
link |
اختياريّ. شريحة اقتراح إضافية يمكن أن تربط بالتطبيق أو الموقع الإلكتروني المرتبط. سيتم عرض الشريحة بعنوان "Open (name)" (فتح (اسم)). 20 حرفًا كحد أقصى. |
canvas |
اختياريّ. يمثل هذا النوع رد لوحة رسم تفاعليًا يتم إرساله إلى المستخدم. |
orderUpdate |
يتجاوب "الإجراء الاختياري" باستخدام أمر OrderUpdate (تحديث الطلب) بعد استلام الطلب أثناء تدفق المعاملات. عند استلام هذا الطلب، تسجِّل Google هذا التعديل للطلب، وفي حال نجاح هذا الإجراء، تعرض بطاقة إيصال الاستلام مع تحويل النص إلى كلام المُرسل على أجهزة العرض. |
بسيط
يمثل طلبًا بسيطًا لإرساله إلى مستخدم. يُرجى الاطّلاع على https://developers.google.com/assistant/conversational/prompts-simple.
تمثيل JSON | |
---|---|
{ "speech": string, "text": string } |
الحقول | |
---|---|
speech |
اختياريّ. تمثل الكلام الذي سيتم قوله للمستخدم. يمكن أن يكون SSML أو تحويل النص إلى كلام. إذا تم "تجاوز" في المطالبة التي تحتوي على "صحيح"، يحل الكلام المحدد في هذا الحقل محل كلام الطلب البسيط السابق. يُرجى الاطّلاع على https://developers.google.com/assistant/conversational/ssml. |
text |
نص اختياري للعرض في فقاعة المحادثة. وفي حال عدم إتاحته، سيتم عرض عرض لحقل الكلام أعلاه. يقتصر على 640 حرفًا. إذا تم "تجاوز" في المطالبة التي تحتوي على "صحيح"، يتم استبدال النص المحدد في هذا الحقل بنص الطلب البسيط السابق. |
المحتوى
كائن الحاوية للطلبات الغنية بصريًا أو طلبات التحديد.
تمثيل JSON | |
---|---|
{ // Union field |
الحقول | ||
---|---|---|
حقل الاتحاد يمكن أن يكون |
||
card |
بطاقة أساسية |
|
image |
صورة. |
|
table |
بطاقة جدول. |
|
media |
استجابة تشير إلى مجموعة من الوسائط التي سيتم تشغيلها. |
|
collection |
بطاقة تعرض مجموعة من الخيارات للاختيار من بينها. |
|
list |
بطاقة تعرض قائمة بالخيارات للاختيار منها. |
|
collectionBrowse |
بطاقة تعرض مجموعة من صفحات الويب المراد فتحها |
بطاقة
بطاقة أساسية لعرض بعض المعلومات، على سبيل المثال: صورة و/أو نص. يمكنك الاطّلاع على https://developers.google.com/assistant/conversational/prompts-rich#basic_card.
تمثيل JSON | |
---|---|
{ "title": string, "subtitle": string, "text": string, "image": { object ( |
الحقول | |
---|---|
title |
العنوان العام للبطاقة. اختياريّ. |
subtitle |
اختياريّ. |
text |
النص الأساسي للبطاقة. تتيح مجموعة محدودة من بنية markdown للتنسيق. مطلوب، ما لم تكن الصورة موجودة. |
image |
صورة الجزء الرئيسي للبطاقة تم تثبيت الارتفاع على 192 وحدة بكسل مستقلة الكثافة (dp). اختياريّ. |
imageFill |
طريقة ملء خلفية الصورة اختياريّ. |
button |
زر برابط خارجي اختياريّ. |
صورة
صورة معروضة في البطاقة يُرجى الاطّلاع على https://developers.google.com/assistant/conversational/prompts-rich#image-cards.
تمثيل JSON | |
---|---|
{ "url": string, "alt": string, "height": integer, "width": integer } |
الحقول | |
---|---|
url |
عنوان URL المصدر الخاص بالصورة يمكن أن تكون الصور بتنسيق JPG وPNG وGIF (متحرّكة وغير متحركة). مثلاً: |
alt |
وصف نصي للصورة التي سيتم استخدامها لتسهيل الاستخدام، على سبيل المثال قارئات الشاشة. مطلوب. |
height |
ارتفاع الصورة بالبكسل. اختياريّ. |
width |
عرض الصورة بالبكسل. اختياريّ. |
ImageFill
خيارات عرض الصور المحتملة التي تؤثر في طريقة عرض الصورة ويجب استخدام هذه السمة عندما لا تتطابق نسبة عرض الصورة إلى ارتفاعها مع نسبة العرض إلى الارتفاع لحاوية الصورة.
عمليات التعداد | |
---|---|
UNSPECIFIED |
|
GRAY |
املأ الفجوات بين الصورة وحاوية الصورة بأشرطة رمادية. |
WHITE |
املأ الفجوات بين الصورة وحاوية الصورة بأشرطة بيضاء. |
CROPPED |
يتم تغيير حجم الصورة بحيث يتطابق عرض الصورة وارتفاعها مع أبعاد الحاوية أو يتجاوزها. وقد يؤدي ذلك إلى اقتصاص الجزء العلوي والسفلي من الصورة إذا كان ارتفاع الصورة الذي تم تغيير حجمه أكبر من ارتفاع الحاوية، أو اقتصاص الجانبَين الأيسر والأيمن من الصورة إذا كان عرض الصورة الذي تم تغيير حجمه أكبر من عرض الحاوية. هذا مشابه لـ "وضع التكبير/التصغير" على تلفزيون بشاشة عريضة عند تشغيل فيديو بنسبة 4:3. |
رابط
شريحة اقتراح إضافية يمكن أن تربط بالتطبيق أو الموقع الإلكتروني المرتبط. سيتم عرض الشريحة بعنوان "Open (name)" (فتح (اسم)).
تمثيل JSON | |
---|---|
{
"name": string,
"open": {
object ( |
الحقول | |
---|---|
name |
اسم الرابط 20 حرفًا كحد أقصى |
open |
ماذا يحدث عندما يفتح المستخدم الرابط؟ |
OpenUrl
تمثيل JSON | |
---|---|
{
"url": string,
"hint": enum ( |
الحقول | |
---|---|
url |
حقل عنوان URL الذي يمكن أن يكون أيًا مما يلي: - http/https عناوين URL لفتح تطبيق مرتبط بتطبيق أو صفحة ويب |
hint |
يشير هذا الحقل إلى تلميح لنوع عنوان URL. |
UrlHint
الأنواع المختلفة من تلميحات عناوين URL:
عمليات التعداد | |
---|---|
LINK_UNSPECIFIED |
غير محدّد |
AMP |
يشير عنوان URL مباشرةً إلى محتوى AMP أو إلى عنوان URL أساسي يشير إلى محتوى AMP من خلال . يُرجى الاطّلاع على https://amp.dev/. |
جدول
بطاقة جدول لعرض جدول نصوص يُرجى الاطّلاع على https://developers.google.com/assistant/conversational/prompts-rich#table_cards.
تمثيل JSON | |
---|---|
{ "title": string, "subtitle": string, "image": { object ( |
الحقول | |
---|---|
title |
تمثّل هذه السمة العنوان العام للجدول. اختياري، ولكن يجب تعيينه في حال تعيين الترجمة. |
subtitle |
عنوان فرعي للجدول. اختياريّ. |
image |
صورة مرتبطة بالجدول اختياريّ. |
columns[] |
عناوين الأعمدة ومحاذاة الأعمدة |
rows[] |
بيانات الصف في الجدول يمكن ضمان عرض أول 3 صفوف، ولكن قد يتم اقتصاص الصفوف الأخرى على أسطح معيّنة. يُرجى إجراء الاختبار باستخدام المحاكي لمعرفة الصفوف التي سيتم عرضها لسطح معيَّن. في مساحات العرض التي تتيح استخدام ميزة WEB_BROWSER، يمكنك توجيه المستخدم إلى صفحة ويب تحتوي على مزيد من البيانات. |
button |
زرّ |
TableColumn
تمثيل JSON | |
---|---|
{
"header": string,
"align": enum ( |
الحقول | |
---|---|
header |
نص عنوان العمود |
align |
محاذاة أفقية لعمود w.r.t المحتوى إذا لم يتم تحديد ذلك، ستتم محاذاة المحتوى مع الحافة الأمامية. |
HorizontalAlignment
محاذاة المحتوى داخل الخلية.
عمليات التعداد | |
---|---|
UNSPECIFIED |
|
LEADING |
الحافة البادئة للخلية. هذا هو الخيار التلقائي. |
CENTER |
تتم محاذاة المحتوى مع وسط العمود. |
TRAILING |
تتم محاذاة المحتوى مع الحافة اللاحقة للعمود. |
TableRow
تصف صفًا في الجدول.
تمثيل JSON | |
---|---|
{
"cells": [
{
object ( |
الحقول | |
---|---|
cells[] |
الخلايا في هذا الصف. يتم ضمان عرض أول 3 خلايا، ولكن قد يتم اقتصاص الخلايا الأخرى على أسطح معيّنة. يُرجى الاختبار باستخدام المحاكي لمعرفة الخلايا التي سيتم عرضها على سطح معيَّن. |
divider |
يشير إلى ما إذا كان يجب أن يكون هناك مُقسّم بعد كل صف. |
TableCell
لوصف خلية على التوالي.
تمثيل JSON | |
---|---|
{ "text": string } |
الحقول | |
---|---|
text |
المحتوى النصي للخلية. |
الوسائط
يمثل كائن وسائط واحدًا. يحتوي على معلومات عن الوسائط، مثل الاسم والوصف وعنوان URL وما إلى ذلك. يمكنك الانتقال إلى https://developers.google.com/assistant/conversational/prompts-media.
تمثيل JSON | |
---|---|
{ "mediaType": enum ( |
الحقول | |
---|---|
mediaType |
|
startOffset |
إزاحة بدء كائن الوسائط الأول. مدة بالثواني مكونة من تسعة أرقام كسور كحد أقصى، ويتم إنهاؤها بعبارة " |
optionalMediaControls[] |
أنواع عناصر التحكم الاختيارية في الوسائط التي يمكن أن تدعمها جلسة الاستجابة للوسائط هذه. في حال ضبطها، سيتم إرسال الطلب إلى جهة خارجية عند وقوع حدث معيّن للوسائط. في حال ترك هذه السياسة بدون ضبط، يجب أن يتعامل الطرف الثالث مع نوعَي التحكّم التلقائيَّين، "تم الانتهاء" و"تعذّر الإجراء". |
mediaObjects[] |
قائمة كائنات الوسائط |
repeatMode |
وضع التكرار لقائمة عناصر الوسائط. |
firstMediaObjectIndex |
فهرس يستند إلى 0 لأول عنصر وسائط في MediaObjects يتم تشغيله. إذا كان المحتوى غير محدّد أو صفرًا أو خارج الحدود، يبدأ التشغيل من أول عنصر وسائط في MediaObjects. |
MediaType
نوع الوسائط لهذا الردّ.
عمليات التعداد | |
---|---|
MEDIA_TYPE_UNSPECIFIED |
|
AUDIO |
ملف صوتي |
MEDIA_STATUS_ACK |
الاستجابة للإقرار بتقرير حالة الوسائط. |
OptionalMediaControls
أنواع عناصر التحكم الاختيارية في الوسائط التي يمكن أن تتيحها استجابة الوسائط
عمليات التعداد | |
---|---|
OPTIONAL_MEDIA_CONTROLS_UNSPECIFIED |
قيمة غير محدّدة |
PAUSED |
تم إيقاف الحدث مؤقتًا. يتم تشغيله عندما يوقف المستخدم الوسائط مؤقتًا. |
STOPPED |
تم إيقاف الحدث. يتم تشغيله عندما يخرج المستخدم من جلسة الجهات الخارجية أثناء تشغيل الوسائط. |
MediaObject
لتمثيل عنصر وسائط واحد
تمثيل JSON | |
---|---|
{
"name": string,
"description": string,
"url": string,
"image": {
object ( |
الحقول | |
---|---|
name |
اسم كائن الوسائط هذا. |
description |
وصف عنصر الوسائط هذا. |
url |
تمثّل هذه السمة عنوان URL الذي يشير إلى محتوى الوسائط. يجب استضافة ملفات MP3 على خادم ويب وأن تكون متاحة للجميع من خلال عنوان URL يستخدم HTTPS. يمكن البث المباشر بتنسيق MP3 فقط. |
image |
الصورة التي سيتم عرضها مع بطاقة الوسائط. |
MediaImage
تمثيل JSON | |
---|---|
{ // Union field |
الحقول | ||
---|---|---|
حقل الاتحاد يمكن أن يكون |
||
large |
صورة كبيرة، مثل غلاف الألبوم، وما إلى ذلك |
|
icon |
رمز صورة صغير يتم عرضه على يمين العنوان. ويتم تغيير حجمها إلى 36×36 بكسل مستقل الكثافة. |
RepeatMode
أنواع وضع التكرار لقائمة من عناصر الوسائط.
عمليات التعداد | |
---|---|
REPEAT_MODE_UNSPECIFIED |
يعادل إيقاف التشغيل. |
OFF |
إنهاء جلسة الوسائط في نهاية كائن الوسائط الأخير. |
ALL |
تكرار إلى بداية كائن الوسائط الأول عند الوصول إلى نهاية كائن الوسائط الأخير. |
مجموعة
بطاقة لعرض مجموعة من الخيارات للاختيار منها يُرجى الاطّلاع على https://developers.google.com/assistant/conversational/prompts-selection#collection.
تمثيل JSON | |
---|---|
{ "title": string, "subtitle": string, "items": [ { object ( |
الحقول | |
---|---|
title |
تمثّل هذه السمة عنوان المجموعة. اختياريّ. |
subtitle |
العنوان الفرعي للمجموعة. اختياريّ. |
items[] |
تمثّل هذه السمة قائمة من العناصر. ويمكن أن تكون الحد الأدنى 2 و10 كحد أقصى. |
imageFill |
طريقة ملء خلفيات الصور الخاصة بعناصر المجموعة اختياريّ. |
CollectionItem
عنصر في المجموعة
تمثيل JSON | |
---|---|
{ "key": string } |
الحقول | |
---|---|
key |
مطلوب. مفتاح NLU الذي يتطابق مع اسم مفتاح الإدخال في النوع المرتبط. |
قائمة
بطاقة لعرض قائمة بالخيارات للاختيار منها يُرجى الاطّلاع على https://developers.google.com/assistant/conversational/prompts-selection#list.
تمثيل JSON | |
---|---|
{
"title": string,
"subtitle": string,
"items": [
{
object ( |
الحقول | |
---|---|
title |
عنوان القائمة اختياريّ. |
subtitle |
العنوان الفرعي للقائمة. اختياريّ. |
items[] |
تمثّل هذه السمة قائمة من العناصر. ويمكن أن تكون الحد الأدنى 2 و30 كحد أقصى. |
ListItem
عنصر في القائمة
تمثيل JSON | |
---|---|
{ "key": string } |
الحقول | |
---|---|
key |
مطلوب. مفتاح NLU الذي يتطابق مع اسم مفتاح الإدخال في النوع المرتبط. |
CollectionBrowse
تقدم مجموعة من مستندات الويب كمجموعة من العناصر ذات المربعات الكبيرة. يمكن اختيار العناصر لبدء عرض مستند الويب المرتبط بها في عارض ويب. لمعرفة مزيد من المعلومات، يمكنك الاطّلاع على https://developers.google.com/assistant/conversational/prompts-selection#collectionBrowse.
تمثيل JSON | |
---|---|
{ "items": [ { object ( |
الحقول | |
---|---|
items[] |
تمثّل هذه السمة قائمة من العناصر. ويمكن أن تكون الحد الأدنى 2 و10 كحد أقصى. |
imageFill |
خيار عرض نوع الصورة |
المنتج/الخدمة
عنصر في المجموعة
تمثيل JSON | |
---|---|
{ "title": string, "description": string, "footer": string, "image": { object ( |
الحقول | |
---|---|
title |
مطلوب. عنوان عنصر المجموعة |
description |
تمثّل هذه السمة وصف عنصر المجموعة. |
footer |
نص التذييل لعنصر المجموعة، ويتم عرضه أسفل الوصف. سطر واحد من النص، تم اقتطاعه بعلامة الحذف. |
image |
صورة للسلعة في المجموعة |
openUriAction |
مطلوب. معرف موارد منتظم (URI) للفتح إذا تم تحديد العنصر. |
اقتراح
توفّر الاقتراحات للمستخدمين على الأجهزة التي تفعِّل العرض شرائح اقتراحات عندما يعرض "مساعد Google" الطلب. يمكنك استخدام شرائح الاقتراحات لتقديم تلميحات لردود المستخدمين لمواصلة المحادثة أو تغيير مسارها. عند النقر على شريحة الاقتراح، تُرجع الشريحة النص المعروض إلى المحادثة حرفيًا، كما لو كان المستخدم قد كتبه. يمكنك الاطّلاع على https://developers.google.com/assistant/conversational/prompts#suggestions.
تمثيل JSON | |
---|---|
{ "title": string } |
الحقول | |
---|---|
title |
مطلوب. النص المعروض في شريحة الاقتراح عند النقر على هذا النص، سيتم نشره مرة أخرى على المحادثة حرفيًا كما لو كان المستخدم قد كتبه. يجب أن يكون كل عنوان فريدًا من بين مجموعة شرائح الاقتراحات. 25 حرفًا بحد أقصى |
اللوحة
يمثل هذا الإعداد رد لوحة رسم تفاعليًا يتم إرساله إلى المستخدم. ويمكن استخدامه مع "firstSimple" في الرسالة التي تحتوي على الطلب للتحدث إلى المستخدم بالإضافة إلى عرض رد تفاعلي ضمن اللوحة. الحد الأقصى لحجم الاستجابة هو 50 كيلو بايت. لمعرفة مزيد من المعلومات، يمكنك الاطّلاع على https://developers.google.com/assistant/interactivecanvas.
تمثيل JSON | |
---|---|
{
"url": string,
"data": [
value
],
"suppressMic": boolean,
"continuousMatchConfig": {
object ( |
الحقول | |
---|---|
url |
عنوان URL لتطبيق الويب التفاعلي للوحة الرسم المطلوب تحميله. وفي حال ترك السياسة بدون ضبط، ستتم إعادة استخدام عنوان URL من لوحة الرسم النشطة الحالية. |
data[] |
اختياريّ. يتم تمرير بيانات JSON إلى صفحة الويب للتجربة الشاملة كفعالية. إذا تم "تجاوز" الحقل في الطلب الذي يتضمّن الطلب هو "false" ستتم إضافة قيم البيانات المحددة في طلب لوحة الرسم هذا بعد قيم البيانات المحددة في طلبات لوحة الرسم السابقة. |
suppressMic |
اختياريّ. القيمة التلقائية: false. |
continuousMatchConfig |
الإعدادات المستخدمة لبدء وضع المطابقة المستمرة |
ContinuousMatchConfig
الإعدادات المستخدمة لبدء وضع المطابقة المستمرة
تمثيل JSON | |
---|---|
{
"expectedPhrases": [
{
object ( |
الحقول | |
---|---|
expectedPhrases[] |
كل العبارات المتوقّعة المحتملة خلال جلسة "وضع المطابقة المستمرة" هذه |
durationSeconds |
المدة الزمنية لمواصلة تفعيل "وضع المطابقة المستمرة" في حال تحديده، سيتم إغلاق الميكروفون عند انتهاء الوقت. الحد الأقصى المسموح به للقيمة هو 180. |
ExpectedPhrase
تمثيل JSON | |
---|---|
{ "phrase": string, "alternativePhrases": [ string ] } |
الحقول | |
---|---|
phrase |
العبارة المطلوب مطابقتها أثناء جلسة وضع المطابقة المستمرة |
alternativePhrases[] |
قد يخطئ نموذج الكلام في التعرف على بعض العبارات حتى مع تحيز الكلام. يتيح هذا للمطوّرين تحديد عوامل تشغيل بديلة للمصطلحات المتجانسة. |
OrderUpdate
يمكنك إجراء تعديل على طلب.
تمثيل JSON | |
---|---|
{ "type": enum ( |
الحقول | |
---|---|
type |
متوقّفة نهائيًا: يُرجى استخدام OrderUpdate.update_mask بدلاً من ذلك. إذا كان النوع = SNAPSHOT، يجب أن يكون OrderUpdate.order هو الطلب بالكامل. إذا كان النوع = ORDER_STATUS، يكون هذا هو التغيير في حالة مستوى الطلب. يتم فقط اختيار Order.last_update_time وهذه الحالة العمودية. ملاحظة: لا يتوافق type.ORDER_STATUS إلا مع تحديثات حالة PercahaseOrderExtension، ولا توجد خطة لتوسيع هذا الدعم. بدلاً من ذلك، ننصح باستخدام updateMask لأنّه أكثر عمومية وقابلية للتوسُّع ويمكن استخدامه لجميع المجالات. |
order |
|
updateMask |
ملاحظة: تتوفّر بعض الاقتراحات أو الاقتراحات للحقول الخاصة التالية: 1. سيتم دائمًا تحديث order.last_update_time كجزء من طلب التعديل. 2- سيتم تجاهل order.create_time وorder.google_order_id وorder.merchant_order_id في حال توفيرها كجزء من updateMask. هذه قائمة مفصولة بفواصل تضم أسماء الحقول المؤهلة بالكامل. مثال: |
userNotification |
في حال تحديد هذا الخيار، سيتم عرض إشعار للمستخدم بالعنوان والنص المحدَّدين. تحديد الإشعار هو اقتراح للإشعار وليس مضمونًا أن يؤدي إلى إشعار. |
reason |
سبب التغيير/التحديث. |
النوع
متوقّفة نهائيًا: يُرجى استخدام OrderUpdate.update_mask بدلاً من ذلك. تم السماح بالتعديلات على الطلب.
عمليات التعداد | |
---|---|
TYPE_UNSPECIFIED |
النوع غير محدَّد، ويجب عدم ضبط ذلك بشكل صريح. |
ORDER_STATUS |
يجب تعديل حالة الطلب فقط. |
SNAPSHOT |
تعديل نبذة عن الطلب |
طلب
كيان الطلب: ملاحظة: 1- يجب أن تكون كل السلاسل على جميع المستويات أقل من 1000 حرف ما لم يتم تحديد خلاف ذلك. 2. يجب أن يكون عدد جميع الحقول المتكرّرة على جميع المستويات أقل من 50، ما لم يتم تحديد خلاف ذلك. 3- يجب أن تكون كل الطوابع الزمنية بجميع المستويات، في حال تحديدها، طوابع زمنية صالحة.
تمثيل JSON | |
---|---|
{ "googleOrderId": string, "merchantOrderId": string, "userVisibleOrderId": string, "userVisibleStateLabel": string, "buyerInfo": { object ( |
الحقول | ||
---|---|---|
googleOrderId |
مُعرّف الطلب الذي قدمته Google. |
|
merchantOrderId |
مطلوب: مُعرّف الطلب الداخلي الذي عيّنه التاجر. ويجب أن يكون هذا المعرّف فريدًا ومطلوبًا للعمليات اللاحقة الخاصة بتعديل الطلب. قد يتم ضبط هذا المعرّف على googleOrderId المقدَّم أو أي قيمة فريدة أخرى. يُرجى العِلم أنّ المعرّف المقدَّم للمستخدمين هو uservisibleOrderId، وهو قد يكون قيمة مختلفة وسهلة الاستخدام. الحد الأقصى المسموح به للطول هو 128 حرفًا. |
|
userVisibleOrderId |
رقم التعريف الموجَّه للمستخدم الذي يشير إلى الطلب الحالي يجب أن يكون هذا المعرّف متوافقًا مع المعرّف المعروض لهذا الطلب في السياقات الأخرى، بما في ذلك المواقع الإلكترونية والتطبيقات والبريد الإلكتروني. |
|
userVisibleStateLabel |
متوقّفة نهائيًا: استخدِم حالة إضافات الطلب بدلاً منها. تصنيف مرئي للمستخدم للحالة التي تم فيها تقديم هذا الطلب |
|
buyerInfo |
معلومات عن المشتري |
|
image |
الصورة المرتبطة بالطلب |
|
createTime |
مطلوب: تاريخ ووقت إنشاء الطلب. طابع زمني بتنسيق RFC3339 حسب التوقيت العالمي المنسَّق (UTC) "زولو" بدقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: |
|
lastUpdateTime |
تاريخ ووقت آخر تعديل للطلب مطلوب لتحديث OrderUpdate. طابع زمني بتنسيق RFC3339 حسب التوقيت العالمي المنسَّق (UTC) "زولو" بدقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: |
|
transactionMerchant |
التاجر الذي سهّل عملية الدفع وقد يختلف هذا الإجراء عن موفّر خدمة على مستوى العنصر. مثال: طلب Expedia مع عنصر من ANA |
|
contents |
المطلوب: محتوى الطلب، وهو مجموعة من تفاصيل الإعلان |
|
priceAttributes[] |
الأسعار والخصومات والضرائب وما إلى ذلك |
|
followUpActions[] |
متابعة الإجراءات على مستوى الطلب |
|
paymentData |
البيانات المتعلّقة بالدفع في الطلب |
|
termsOfServiceUrl |
رابط إلى بنود الخدمة التي تنطبق على الطلب أو الطلب المقترَح |
|
note |
تم إرفاق الملاحظات بالطلب. |
|
promotions[] |
تمثّل هذه السمة جميع العروض الترويجية المرتبطة بهذا الطلب. |
|
disclosures[] |
الإفصاحات المرتبطة بهذا الطلب |
|
vertical |
متوقّفة نهائيًا: استخدِم مواضع الإعلانات بدلاً منها. سيتم تطبيق هذه السمات على جميع تفاصيل الإعلانات، ما لم يتم إلغاؤها في بعض تفاصيل الإعلانات. يجب أن يتطابق هذا العمود مع النوع العمودي على مستوى العنصر. القيم المحتملة: كائن يحتوي على حقول من نوع عشوائي يحتوي الحقل الإضافي |
|
حقل الاتحاد verticals . سيتم تطبيق هذه السمات على جميع تفاصيل الإعلانات، ما لم يتم إلغاؤها في بعض تفاصيل الإعلانات. يجب أن يتطابق هذا العمود مع النوع العمودي على مستوى العنصر. يمكن أن يكون verticals واحدًا فقط مما يلي: |
||
purchase |
أمر الشراء |
|
ticket |
طلب التذكرة |
UserInfo
معلومات حول المستخدم وتُستخدم هذه السمة لتمثيل معلومات المستخدم المرتبط بالطلب.
تمثيل JSON | |
---|---|
{
"email": string,
"firstName": string,
"lastName": string,
"displayName": string,
"phoneNumbers": [
{
object ( |
الحقول | |
---|---|
email |
البريد الإلكتروني للمستخدم، على سبيل المثال: janedoe@gmail.com. |
firstName |
الاسم الأول للمستخدم |
lastName |
اسم العائلة للمستخدم |
displayName |
قد يكون الاسم المعروض للمستخدم مختلفًا عن الاسم الأول أو اسم العائلة. |
phoneNumbers[] |
أرقام هواتف المستخدم |
رقم الهاتف
التمثيل العادي لرقم الهاتف
تمثيل JSON | |
---|---|
{ "e164PhoneNumber": string, "extension": string, "preferredDomesticCarrierCode": string } |
الحقول | |
---|---|
e164PhoneNumber |
رقم الهاتف بتنسيق E.164، على النحو المحدّد في توصية E.164 من الاتحاد الدولي للاتصالات (ITU). رابط wiki: https://en.wikipedia.org/wiki/E.164 |
extension |
لا يتم توحيد الامتداد في توصيات الاتحاد الدولي للاتصالات، باستثناء ما يتم تعريفه كسلسلة من الأرقام التي يصل طولها إلى 40 رقمًا كحد أقصى. ويُعرَّف بأنه سلسلة هنا لاستيعاب الاستخدام المحتمل لصفر بادئ في الإضافة (للمؤسسات الحرية الكاملة في تنفيذ ذلك، حيث لا يوجد معيار محدد). بخلاف الأرقام، هناك بعض رموز الطلب الأخرى مثل "," (الإشارة إلى الانتظار) قد يتم تخزينها هنا. على سبيل المثال، في الملحق xxx-xxx-xxxx 123، "123" هي الإضافة. |
preferredDomesticCarrierCode |
رمز اختيار مشغّل شبكة الجوّال المفضَّل عند الاتصال برقم الهاتف هذا محليًا. ويشمل ذلك أيضًا الرموز التي يلزم الاتصال بها في بعض البلدان عند الاتصال من الخطوط الأرضية إلى الهواتف الجوّالة، أو العكس. على سبيل المثال، في كولومبيا، تشير "3" يجب الاتصال به قبل رقم الهاتف نفسه عند الاتصال من هاتف جوال إلى هاتف أرضي محلي والعكس صحيح. https://en.wikipedia.org/wiki/Telephone_numbers_in_Colombia https://en.wikipedia.org/wiki/Brazilian_Carrier_Selection_Code لاحظ أن هذا هو "المفضل" الرمز، مما يعني أن رموزًا أخرى قد تعمل أيضًا. |
صورة
صورة معروضة في البطاقة
تمثيل JSON | |
---|---|
{ "url": string, "accessibilityText": string, "height": integer, "width": integer } |
الحقول | |
---|---|
url |
عنوان URL المصدر الخاص بالصورة يمكن أن تكون الصور بتنسيق JPG وPNG وGIF (متحرّكة وغير متحركة). مثلاً: |
accessibilityText |
وصف نصي للصورة التي سيتم استخدامها لتسهيل الاستخدام، على سبيل المثال قارئات الشاشة. مطلوب. |
height |
ارتفاع الصورة بالبكسل. اختياريّ. |
width |
عرض الصورة بالبكسل. اختياريّ. |
التاجر
تاجر سلة التسوّق أو الطلب أو العنصر
تمثيل JSON | |
---|---|
{ "id": string, "name": string, "image": { object ( |
الحقول | |
---|---|
id |
معرّف اختياري تم تخصيصه للتاجر، إن توفّر. |
name |
اسم التاجر، مثل "خبز البانيرا". |
image |
الصورة المرتبطة بالتاجر |
phoneNumbers[] |
أرقام هواتف التاجر |
address |
عنوان التاجر. |
الموقع الجغرافي
حاوية تمثّل موقعًا جغرافيًا
تمثيل JSON | |
---|---|
{ "coordinates": { object ( |
الحقول | |
---|---|
coordinates |
الإحداثيات الجغرافية يتطلب [DEVICE_PRECISE_LOCATION] إذن [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION]. |
formattedAddress |
العنوان المعروض، على سبيل المثال: "1600 Amphitheatre Pkwy, Mountain View, CA 94043". يتطلب [DEVICE_PRECISE_LOCATION] إذن [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION]. |
zipCode |
الرمز البريدي. يتطلب [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] أو [DEVICE_COARSE_LOCATION] إذن [google.actions.v2.Permission.DEVICE_COARSE_LOCATION]. |
city |
المدينة. يتطلب [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] أو [DEVICE_COARSE_LOCATION] إذن [google.actions.v2.Permission.DEVICE_COARSE_LOCATION]. |
postalAddress |
العنوان البريدي. يتطلب [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] أو [DEVICE_COARSE_LOCATION] إذن [google.actions.v2.Permission.DEVICE_COARSE_LOCATION]. |
name |
اسم المكان. |
phoneNumber |
رقم هاتف الموقع الجغرافي، على سبيل المثال رقم جهة الاتصال لموقع النشاط التجاري أو رقم الهاتف الخاص بموقع التسليم. |
notes |
ملاحظات حول الموقع الجغرافي |
placeId |
يتم استخدام PlaceId مع Places API لاسترجاع تفاصيل المكان. يمكنك الاطّلاع على https://developers.google.com/places/web-service/place-id. |
LatLng
كائن يمثّل زوجًا من خط العرض/الطول. ويتم التعبير عن ذلك في صورة زوج من الزوجين لتمثيل درجات الطول والعرض والدرجات. ما لم يُنص على خلاف ذلك، يجب أن يتوافق هذا العنصر مع معيار WGS84. يجب أن تكون القيم ضمن النطاقات التي تمت تسويتها.
تمثيل JSON | |
---|---|
{ "latitude": number, "longitude": number } |
الحقول | |
---|---|
latitude |
خط العرض بالدرجات. يجب أن يكون في النطاق [ -90.0، +90.0]. |
longitude |
خط الطول بالدرجات. يجب أن يكون في النطاق [ -180.0، +180.0]. |
PostalAddress
يمثل عنوانًا بريديًا، على سبيل المثال: لعناوين التسليم البريدي أو الدفع استنادًا إلى العنوان البريدي، يمكن لخدمة البريد تسليم السلع إلى المبنى. مربّع أو ما شابه ذلك حيث لم يُقصد به تصميم نماذج للمواقع الجغرافية (الطرق والمدن والجبال).
في الاستخدام النموذجي، يتم إنشاء عنوان من خلال البيانات التي يُدخلها المستخدم أو من استيراد البيانات الحالية، وذلك حسب نوع العملية.
نصائح بشأن إدخال أو تعديل العنوان: - يجب استخدام تطبيق مصغّر مخصّص للعنوان i18n، مثل https://github.com/google/libaddressinput). يجب عدم عرض عناصر واجهة المستخدم أمام المستخدمين لإدخال أو تعديل الحقول خارج البلدان التي يُستخدَم فيها هذا الحقل.
لمزيد من الإرشادات حول كيفية استخدام هذا المخطط، يُرجى الاطّلاع على: https://support.google.com/business/answer/6397478
تمثيل JSON | |
---|---|
{ "revision": integer, "regionCode": string, "languageCode": string, "postalCode": string, "sortingCode": string, "administrativeArea": string, "locality": string, "sublocality": string, "addressLines": [ string ], "recipients": [ string ], "organization": string } |
الحقول | |
---|---|
revision |
تمثّل هذه السمة مراجعة المخطط لـ يجب أن تكون جميع النُسخ السابقة متوافقة مع الإصدارات القديمة. |
regionCode |
مطلوب. رمز CLDR للبلد أو المنطقة التي يقع فيها العنوان. لا يتم استنتاج ذلك أبدًا، وتقع على عاتق المستخدم مسؤولية التأكّد من صحة القيمة. لمعرفة التفاصيل، يمكنك الاطّلاع على http://cldr.unicode.org/ وhttp://www.unicode.org/cldr/charts/30/supplemental/territory_information.html. مثال: "CH" لسويسرا. |
languageCode |
اختياريّ. رمز لغة محتوى هذا العنوان BCP-47 (إذا كان معروفًا) وهي غالبًا لغة واجهة المستخدم لنموذج الإدخال أو من المتوقّع أن تتطابق مع إحدى اللغات المستخدمة في العنوان الدولة/المنطقة، أو ما يعادلها صوتيًا. ويمكن أن يؤثر ذلك في التنسيق في بلدان معيّنة، ولكنه ليس ضروريًا لتصحيح البيانات، ولن يؤثر أبدًا في أي عملية تحقّق أو عمليات أخرى غير متعلّقة بالتنسيق. وإذا كانت هذه القيمة غير معروفة، يجب حذفها (بدلاً من تحديد قيمة تلقائية قد تكون غير صحيحة). أمثلة: "zh-Hant" و"ja" و"ja-Latn" و"en". |
postalCode |
اختياريّ. الرمز البريدي للعنوان. لا تستخدِم بعض البلدان الرموز البريدية أو تشترط توفّر هذه الرموز، ولكن عند استخدامها، قد تُجري عمليات تحقُّق إضافية من خلال أجزاء أخرى من العنوان (مثل التحقّق من صحة الولاية أو الرمز البريدي في الولايات المتحدة الأمريكية). |
sortingCode |
اختياريّ. رمز ترتيب إضافي خاص بالبلد. لا تُستخدم هذه الميزة في معظم المناطق. عند استخدامها، تكون القيمة إما سلسلة مثل "CEDEX"، متبوعة بشكل اختياري برقم (مثل "CEDEX 7")، أو مجرد رقم وحده، يمثّل "رمز القطاع" (جامايكا)، "مؤشر منطقة التسليم" (مالاوي) أو "مؤشر مكتب البريد" (على سبيل المثال: ساحل العاج). |
administrativeArea |
اختياريّ. أعلى تقسيم فرعي إداري يتم استخدامه للعناوين البريدية لبلد أو منطقة. على سبيل المثال، يمكن أن تكون ولاية أو مقاطعة أو مقاطعة أو محافظة. على وجه التحديد، بالنسبة إلى إسبانيا، هذه هي الإقليم وليس المجتمع المستقلّ (على سبيل المثال، "برشلونة" وليس "كاتالونيا"). لا يستخدم العديد من البلدان منطقة إدارية في العناوين البريدية. مثلاً: في سويسرا يجب عدم تعبئة هذا الحقل. |
locality |
اختياريّ. يشير بوجه عام إلى الجزء من المدينة أو البلدة من العنوان. أمثلة: مدينة في الولايات المتحدة، بلدية تكنولوجيا المعلومات، بلدة بريد المملكة المتحدة. في مناطق العالم التي لم يتم فيها تحديد المناطق المحلية بشكل جيد أو لا تتناسب مع هذا الهيكل جيدًا، اترك المنطقة المحلية فارغة واستخدم addressLines. |
sublocality |
اختياريّ. المنطقة المحلية الفرعية للعنوان. على سبيل المثال، يمكن أن تكون الأحياء أو المناطق الإدارية أو المناطق. |
addressLines[] |
أسطر عنوان غير منظمة تصف المستويات الأدنى من العنوان. بما أنّ القيم في addressLines لا تحتوي على معلومات النوع وقد تحتوي أحيانًا على قيم متعددة في حقل واحد (على سبيل المثال، "أبو ظبي، تكساس")، من المهم أن يكون ترتيب الأسطر واضحًا. يجب أن يكون ترتيب أسطر العنوان "ترتيب على شكل مغلف". للبلد أو المنطقة التي يقع فيها العنوان. وفي الأماكن التي قد يختلف فيها الاسم (مثل اليابان)، يتم استخدام address_language لجعله صريحًا (على سبيل المثال، "ja" لترتيب الحروف الكبيرة إلى الصغيرة وja-Latn أو "en" للصغير إلى الكبير). وبهذه الطريقة، يمكن تحديد السطر الأكثر تحديدًا للعنوان بناءً على اللغة. إنّ الحد الأدنى المسموح به للتمثيل الهيكلي للعنوان هو رمز المنطقة مع جميع المعلومات المتبقية في سطر العنوان. سيكون من الممكن تنسيق هذا العنوان تقريبًا بدون ترميز جغرافي، ولكن لا يمكن وضع أي تفسير دلالي حول أي من مكونات العنوان حتى يتم حله جزئيًا على الأقل. إنشاء عنوان يحتوي فقط على رمز المنطقة وسطر العنوان، ومن ثمَّ يُعتبر الترميز الجغرافي الطريقة الموصى بها للتعامل مع العناوين غير المنظَّمة تمامًا (بدلاً من تخمين أجزاء العنوان التي يجب أن تكون مناطق محلية أو مناطق إدارية). |
recipients[] |
اختياريّ. المستلم على العنوان. في حالات معيّنة، قد يحتوي هذا الحقل على معلومات متعددة الأسطر. على سبيل المثال، قد يحتوي على كلمة "رعاية" المعلومات. |
organization |
اختياريّ. تمثّل هذه السمة اسم المؤسسة في العنوان. |
المحتويات
ملف تغليف العناصر
تمثيل JSON | |
---|---|
{
"lineItems": [
{
object ( |
الحقول | |
---|---|
lineItems[] |
قائمة عناصر الطلب ويجب توفير عنصر واحد على الأقل، ويُسمح باستخدام 50 عنصرًا كحد أقصى. يجب أن تنتمي كل العناصر إلى موضع الإعلان نفسه. |
LineItem
يحتوي بند واحد على عمود واحد. يمكن أن يحتوي الطلب أو سلة التسوق على عناصر متعددة من نفس موضع الإعلان. يجب تحديد العناصر الفرعية/الإضافات وما إلى ذلك في نماذج أوّلية رأسية اعتمادًا على حالات استخدامها. ملاحظة: 1- يجب أن تكون كل السلاسل على جميع المستويات أقل من 1000 حرف ما لم يتم تحديد خلاف ذلك. 2. يجب أن يكون عدد جميع الحقول المتكرّرة على جميع المستويات أقل من 50، ما لم يتم تحديد خلاف ذلك. 3- يجب أن تكون كل الطوابع الزمنية بجميع المستويات، في حال تحديدها، طوابع زمنية صالحة.
تمثيل JSON | |
---|---|
{ "id": string, "name": string, "userVisibleStateLabel": string, "provider": { object ( |
الحقول | ||
---|---|---|
id |
مطلوب: المعرّف الذي خصّصه التاجر للعنصر. تُستخدَم لتحديد تفاصيل الإعلان الحالية عند تطبيق التعديلات الجزئية. الحد الأقصى المسموح به للطول هو 64 حرفًا. |
|
name |
اسم البند كما هو معروض في الإيصال. الحد الأقصى المسموح به للطول هو 100 حرف. |
|
userVisibleStateLabel |
تمّ الإيقاف. يُرجى استخدام الحالة العمودية بدلاً من ذلك. على سبيل المثال، بالنسبة إلى عمليات الشراء، استخدِم PurchaseOrderExtension.status. تصنيف مرئي للمستخدم لحالة هذا العنصر |
|
provider |
تمثّل هذه السمة موفِّر العنصر المعيّن، إذا كان مختلفًا عن الطلب العام. مثال: طلب Expedia مع مقدم خدمة العناصر ANA |
|
priceAttributes[] |
السعر والتعديلات على مستوى العنصر: |
|
followUpActions[] |
إجراءات المتابعة على تفاصيل الإعلان |
|
recipients[] |
بالنسبة إلى العملاء على مستوى العنصر، قد يختلف هذا الخيار عن المشتري على مستوى الطلب. مثال: قام المستخدم س بحجز مطعم تحت اسم المستخدم ص. |
|
image |
صورة صغيرة مرتبطة بهذه السلعة، إن توفّرت |
|
description |
وصف البند. |
|
notes[] |
ملاحظات إضافية تنطبق على هذا العنصر بالتحديد، مثل سياسة الإلغاء |
|
disclosures[] |
بيانات الإفصاح المرتبطة بهذا البند |
|
vertical |
متوقّفة نهائيًا: استخدِم الفئات بدلاً منها. المطلوب: المحتوى الدلالي للعنصر استنادًا إلى نوعه أو مجاله. يجب أن يتضمّن كل مجال تفاصيل توصيل الطلب الخاصة به. يجب أن تكون إحدى القيمتين التاليتين: كائن يحتوي على حقول من نوع عشوائي يحتوي الحقل الإضافي |
|
حقل الاتحاد verticals . المطلوب: المحتوى الدلالي للعنصر استنادًا إلى نوعه أو مجاله. يجب أن يتضمّن كل مجال تفاصيل توصيل الطلب الخاصة به. يمكن أن يكون verticals واحدًا فقط مما يلي: |
||
purchase |
طلبات الشراء، مثل السلع والطعام وغير ذلك |
|
reservation |
طلبات الحجز، مثل المطعم وقص الشعر وما إلى ذلك |
PriceAttribute
سمة السعر لطلب أو عنصر
تمثيل JSON | |
---|---|
{ "type": enum ( |
الحقول | ||
---|---|---|
type |
مطلوبة: نوع سمة الأموال |
|
name |
مطلوبة: يعرض المستخدم سلسلة لسمة السعر. يرسل التاجر هذه المعلومات وترجمتها. |
|
id |
اختياري: معرّف العنصر الذي يتوافق معه هذا السعر. |
|
state |
مطلوب: حالة السعر: التقدير مقابل الفعلي. |
|
taxIncluded |
تُستخدَم لتحديد ما إذا كان السعر يشمل الضريبة. |
|
حقل الاتحاد spec . تُمثِّل المبلغ النقدي أو النسبة المئوية بالمللي ثانية. يمكن أن يكون spec واحدًا فقط مما يلي: |
||
amount |
المبلغ النقدي. |
|
amountMillipercentage |
مواصفات النسبة المئوية، حتى 1/1000 من النسبة المئوية على سبيل المثال: يتم تمثيل 8.750% على شكل 8, 750، وتمثّل النسب المئوية السالبة خصومات بنسبة مئوية. جارٍ إيقاف هذا الحقل نهائيًا. يمكنك إعادة إضافتها عندما تكون هناك حالة استخدام قوية مطلوبة. |
النوع
يمثل نوع المال.
عمليات التعداد | |
---|---|
TYPE_UNSPECIFIED |
لم يتم تحديد النوع، ويجب ألا يحتاج العملاء إلى ضبطه بشكلٍ صريح. |
REGULAR |
السعر المعروض العادي، قبل تطبيق أي خصومات وغير ذلك |
DISCOUNT |
يجب طرحها من الإجمالي الفرعي. |
TAX |
ستتم إضافته إلى الإجمالي الفرعي. |
DELIVERY |
ستتم إضافته إلى الإجمالي الفرعي. |
SUBTOTAL |
قد يكون المبلغ الإجمالي الفرعي قبل إضافة بعض الرسوم. |
FEE |
أي رسوم إضافية |
GRATUITY |
ستتم إضافته إلى الإجمالي الفرعي. |
TOTAL |
السعر المعروض للطلب أو العنصر. |
الحالة
يمثّل هذا الحقل ولاية السعر.
عمليات التعداد | |
---|---|
STATE_UNSPECIFIED |
لم يتم تحديده. |
ESTIMATE |
السعر هو مجرّد تقدير، ولكن المبلغ النهائي سيكون قريبًا من هذا المبلغ. مثال: في الحالات التي تكون فيها الضريبة غير معروفة بدقة في وقت إجراء المعاملة، سيكون الإجمالي مبلغًا بقيمة تقديرية. |
ACTUAL |
السعر الفعلي الذي سيتم تحصيله للمستخدم. |
المال
يمثل مبلغًا من المال مع نوع العملة.
تمثيل JSON | |
---|---|
{ "currencyCode": string, "amountInMicros": string } |
الحقول | |
---|---|
currencyCode |
تمثّل هذه السمة رمز العملة المكوَّن من 3 أحرف والمحدّد في ISO 4217. |
amountInMicros |
المبلغ بوحدات المايكرو. على سبيل المثال، يجب ضبط هذا الحقل على 1990000 مقابل 1.99 دولار أمريكي. |
الإجراء
إجراء متابعة مرتبط بالطلب أو العنصر
تمثيل JSON | |
---|---|
{ "type": enum ( |
الحقول | |
---|---|
type |
مطلوب: نوع الإجراء |
title |
عنوان الإجراء أو تصنيفه المعروضَين للمستخدم الحد الأقصى المسموح به للطول هو 100 حرف. |
openUrlAction |
الإجراء الواجب اتخاذه. |
actionMetadata |
البيانات الوصفية المرتبطة بإجراء ما. |
النوع
إجراءات المتابعة المحتملة.
عمليات التعداد | |
---|---|
TYPE_UNSPECIFIED |
إجراء غير محدَّد. |
VIEW_DETAILS |
عرض إجراء تفاصيل الطلب |
MODIFY |
تعديل إجراء الطلب |
CANCEL |
إلغاء إجراء الطلب |
RETURN |
إجراء طلب الإرجاع. |
EXCHANGE |
إجراء طلب Exchange. |
EMAIL |
إجراء البريد الإلكتروني. تم إيقاف نوعَي EMAIL وCALL نهائيًا. يمكن استخدام openUrlAction.url كرقم هاتف أو بريد إلكتروني. |
CALL |
إجراء المكالمة |
REORDER |
إعادة ترتيب الإجراء. |
REVIEW |
مراجعة إجراء الطلب |
CUSTOMER_SERVICE |
يُرجى التواصل مع خدمة العملاء. |
FIX_ISSUE |
يجب الانتقال إلى الموقع الإلكتروني أو التطبيق الخاص بالتاجر لحلّ المشكلة. |
DIRECTION |
رابط الاتجاه |
OpenUrlAction
لفتح عنوان URL المحدّد.
تمثيل JSON | |
---|---|
{ "url": string, "androidApp": { object ( |
الحقول | |
---|---|
url |
حقل عنوان URL الذي يمكن أن يكون أيًا مما يلي: - http/https عناوين URL لفتح تطبيق مرتبط بتطبيق أو صفحة ويب |
androidApp |
معلومات حول تطبيق Android إذا كان من المتوقع أن يتم توفير عنوان URL من خلال تطبيق Android. |
urlTypeHint |
يشير هذا الحقل إلى تلميح لنوع عنوان URL. |
AndroidApp
مواصفات تطبيق Android في ما يتعلّق بقيود التنفيذ
تمثيل JSON | |
---|---|
{
"packageName": string,
"versions": [
{
object ( |
الحقول | |
---|---|
packageName |
يجب تحديد اسم الحزمة عند تحديد Android Fulfillment. |
versions[] |
عند تحديد فلاتر متعددة، سيؤدي أي فلتر مطابق إلى تشغيل التطبيق. |
VersionFilter
يجب تضمين VersionFilter إذا كانت هناك إصدارات معيّنة من التطبيق مطلوبة.
تمثيل JSON | |
---|---|
{ "minVersion": integer, "maxVersion": integer } |
الحقول | |
---|---|
minVersion |
الحد الأدنى لرمز الإصدار أو 0، بشكل شامل. |
maxVersion |
الحد الأقصى لرمز الإصدار، شاملة. ويكون النطاق المذكور هو [minVersion:maxVersion]. يتضمن النطاق الفارغ أي إصدار. أمثلة: لتحديد إصدار واحد، استخدِم: [target_version:target_version]. لتحديد أي إصدار، اترك minVersion وmaxVersion بدون تحديد. لتحديد جميع الإصدارات حتى maxVersion، اترك minVersion غير محدَّد. لتحديد جميع الإصدارات من minVersion، اترك maxVersion غير محدّد. |
UrlTypeHint
الأنواع المختلفة من تلميحات عناوين URL:
عمليات التعداد | |
---|---|
URL_TYPE_HINT_UNSPECIFIED |
غير محدّد |
AMP_CONTENT |
يشير عنوان URL مباشرةً إلى محتوى AMP أو إلى عنوان URL أساسي يشير إلى محتوى AMP من خلال <link rel="amphtml">. |
ActionMetadata
البيانات الوصفية ذات الصلة لكل إجراء
تمثيل JSON | |
---|---|
{ "expireTime": string } |
الحقول | |
---|---|
expireTime |
الوقت الذي ستنتهي فيه صلاحية هذا الإجراء طابع زمني بتنسيق RFC3339 حسب التوقيت العالمي المنسَّق (UTC) "زولو" بدقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: |
الإفصاح
بيان إفصاح عن المنتج أو الخدمة أو السياسة يمكن تقديمه للمستخدم.
تمثيل JSON | |
---|---|
{ "title": string, "disclosureText": { object ( |
الحقول | |
---|---|
title |
عنوان الإفصاح مثال: "معلومات الأمان". |
disclosureText |
محتوى الإفصاح روابط الويب مسموح بها. |
presentationOptions |
خيارات العرض التقديمي لبيان الإفصاح |
DisclosureText
يمثل نصًا عاديًا مع روابط ويب.
تمثيل JSON | |
---|---|
{
"template": string,
"textLinks": [
{
object ( |
الحقول | |
---|---|
template |
النص المطلوب عرضه، يحتوي على عناصر نائبة مثل "{0}" و "{1}" لكل رابط نصي يجب إدراجه. مثال: "تحذير: يمكن أن يعرّضك هذا المنتج لمواد كيميائية معروفة في ولاية كاليفورنيا أنّها تسبب السرطان. لمزيد من المعلومات، انتقل إلى {0}." يجب ألا يحتوي نص الإفصاح عن جهة تمويل الإعلان على أي محتوى ترويجي أو مشابه للإعلانات. |
textLinks[] |
هي الروابط النصية التي يجب استبدالها في النموذج. سيتم استبدال أول عنوان بـ "{0}" في سلسلة النموذج، والخيار الثاني لـ "{1}"، وما إلى ذلك. |
TextLink
تمثّل هذه السمة رابطًا نصيًا يجب استبداله بالقالب.
تمثيل JSON | |
---|---|
{ "displayText": string, "url": string } |
الحقول | |
---|---|
displayText |
النص الذي يجب عرضه للمستخدمين |
url |
عنوان URL الذي يجب توجيه المستخدمين إليه عند تفعيل الرابط. |
DisclosurePresentationOptions
الخيارات المتاحة لعرض بيان الإفصاح.
تمثيل JSON | |
---|---|
{
"presentationRequirement": enum ( |
الحقول | |
---|---|
presentationRequirement |
متطلبات عرض بيان الإفصاح: |
initiallyExpanded |
ما إذا كان يجب توسيع محتوى بيان الإفصاح في البداية ويتم تصغيرها في البداية بشكل تلقائي. |
PresentationRequirement
مطلب عرض الإفصاح.
عمليات التعداد | |
---|---|
REQUIREMENT_UNSPECIFIED |
مطلب غير محدَّد ويجب عدم ضبط هذه الإعدادات بشكل صريح. |
REQUIREMENT_OPTIONAL |
ويكون هذا الإفصاح اختياريًا. ويمكن تخطّيه إذا كان الجهاز لا يتيح عرض الإفصاحات. |
REQUIREMENT_REQUIRED |
يجب تقديم بيان الإفصاح. سيتم إرسال المحادثة إلى الهاتف إذا كان الجهاز لا يتيح عرض الإفصاحات. |
PurchaseItemExtension
محتوى العناصر في قطاع الشراء
تمثيل JSON | |
---|---|
{ "status": enum ( |
الحقول | |
---|---|
status |
مطلوب: الحالة على مستوى العنصر |
userVisibleStatusLabel |
المطلوب: إظهار التصنيف/سلسلة للمستخدم لمعرفة الحالة. الحد الأقصى المسموح به للطول هو 50 حرفًا. |
type |
مطلوب: نوع عملية الشراء |
productId |
معرّف المنتج أو العرض المرتبط بهذا العنصر |
quantity |
كمية السلعة |
unitMeasure |
قياس الوحدة. تُستخدَم لتحديد حجم السلعة في الوحدات المختارة. يتم استخدام الحجم مع السعر النشط لتحديد سعر الوحدة. |
returnsInfo |
تؤدي إلى إرجاع معلومات لهذا العنصر. في حال ترك هذه السياسة بدون ضبط، سيكتسب هذا العنصر معلومات إرجاع مستوى الطلب. |
fulfillmentInfo |
معلومات التنفيذ لهذا العنصر وفي حال ترك هذه السياسة بدون ضبط، سيكتسب هذا العنصر معلومات التنفيذ على مستوى الطلب. |
itemOptions[] |
إضافات أو عناصر فرعية إضافية |
productDetails |
تمثّل هذه السمة تفاصيل حول المنتج. |
extension |
أي حقول إضافية يتم تبادلها بين التاجر وGoogle ملاحظة: لا يُنصح باستخدام هذه الإضافة. بناءً على حالة الاستخدام أو الظروف، يجب مراعاة أي مما يلي: 1. حدِّد الحقول في purchaseItemExtension إذا كان من الممكن استخدامها لحالات استخدام أخرى (مثل الإمكانات/الوظائف العامة). 2. ويمكنك استخدام vertical_extension إذا كانت خاصة بحالة استخدام أو ميزة مخصّصة غير عامة. كائن يحتوي على حقول من نوع عشوائي يحتوي الحقل الإضافي |
PurchaseStatus
حالة الشراء المرتبطة بطلب الشراء أو بعنصر معيّن
عمليات التعداد | |
---|---|
PURCHASE_STATUS_UNSPECIFIED |
لم يتم تحديد الحالة. |
READY_FOR_PICKUP |
جاهز للاستلام. |
SHIPPED |
تم الشحن. |
DELIVERED |
تم استلامها |
OUT_OF_STOCK |
غير متوفّر. |
IN_PREPARATION |
IN_PREPARATION ويمكن أن يكون لها معنى مختلف في سياق مختلف. بالنسبة إلى طلب الطعام، قد يكون الطعام جاريًا. بالنسبة إلى البيع بالتجزئة، قد يكون سلعة يتم تغليفها. |
CREATED |
تم إنشاء الطلب. |
CONFIRMED |
أكّد التاجر الطلب. |
REJECTED |
رفض التاجر الطلب أو العنصر. |
RETURNED |
تم إرجاع السلعة من قِبل المستخدم. |
CANCELLED |
ألغى المستخدم الطلب أو العنصر. |
CHANGE_REQUESTED |
طلب المستخدم إجراء تغيير على الطلب، وتعالج شركة الدمج هذا التغيير. يجب نقل الطلب إلى حالة أخرى بعد معالجة الطلب. |
PurchaseType
فئة الشراء.
عمليات التعداد | |
---|---|
PURCHASE_TYPE_UNSPECIFIED |
قيمة غير معروفة. |
RETAIL |
ويشمل ذلك عمليات الشراء مثل السلع المادية. |
FOOD |
ويشمل ذلك شراء طلب الطعام. |
GROCERY |
شراء البقالة. |
MOBILE_RECHARGE |
عملية شراء إعادة شحن رصيد الهاتف الجوّال المدفوعة مسبقًا. |
MerchantUnitMeasure
مقياس تسعير وحدات التاجر
تمثيل JSON | |
---|---|
{
"measure": number,
"unit": enum ( |
الحقول | |
---|---|
measure |
القيمة: مثال 1.2. |
unit |
الوحدة: مثال على POUND، GRAM. |
الوحدة
عمليات التعداد | |
---|---|
UNIT_UNSPECIFIED |
لم يتم تحديد الوحدة. |
MILLIGRAM |
مليغرام. |
GRAM |
غرام |
KILOGRAM |
كيلوغرام |
OUNCE |
أوس. |
POUND |
جنيه. |
PurchaseReturnsInfo
عرض المعلومات المرتبطة بطلب أو بعنصر معيّن
تمثيل JSON | |
---|---|
{ "isReturnable": boolean, "daysToReturn": integer, "policyUrl": string } |
الحقول | |
---|---|
isReturnable |
إذا كانت القيمة true، يُسمح بالإرجاع. |
daysToReturn |
يُسمح بإرجاع السلع خلال هذه الأيام العديدة. |
policyUrl |
الرابط الذي يؤدي إلى سياسة الإرجاع |
PurchaseFulfillmentInfo
معلومات توصيل الطلب المرتبطة بطلب الشراء أو بعنصر معيّن
تمثيل JSON | |
---|---|
{ "id": string, "fulfillmentType": enum ( |
الحقول | |
---|---|
id |
معرّف فريد لخيار الخدمة هذا |
fulfillmentType |
مطلوب: نوع توصيل الطلب. |
expectedFulfillmentTime |
الإطار عند تحديد نطاق زمني أو الوقت المقدر للوصول إذا تم تحديد وقت واحد. الوقت المتوقَّع للتسليم أو الاستلام. |
expectedPreparationTime |
الإطار عند تحديد نطاق زمني أو الوقت المقدر للوصول إذا تم تحديد وقت واحد. الوقت المتوقع لإعداد الطعام. ويفضَّل أن يتم العرض مرة واحدة. |
location |
الموقع الجغرافي لاستلام الطلب أو التسليم. |
expireTime |
الوقت الذي تنتهي فيه صلاحية خيار توصيل الطلب هذا طابع زمني بتنسيق RFC3339 حسب التوقيت العالمي المنسَّق (UTC) "زولو" بدقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: |
price |
تكلفة هذا الخيار. |
fulfillmentContact |
معلومات اتصال المستخدم الخاصة بعملية التنفيذ هذه |
shippingMethodName |
اسم طريقة الشحن التي اختارها المستخدم |
storeCode |
رمز المتجر للموقع الجغرافي مثال: Walmart هو التاجر، وstoreCode هو متجر walmart الذي تم توصيل الطلب منه. https://support.google.com/business/answer/3370250?ref_topic=4596653. |
pickupInfo |
معلومات إضافية حول كيفية اختيار الطلب. لن يكون هذا الحقل ساريًا إلا عندما يكون نوع التنفيذ هو PICKUP. |
النوع
نوع توصيل الطلب.
عمليات التعداد | |
---|---|
TYPE_UNSPECIFIED |
لم يتم تحديد النوع. |
DELIVERY |
سيتم تسليم هذا الطلب. |
PICKUP |
يجب استلام هذا الطلب. |
الوقت
صيغة الوقت لتمثيل وقت الحدث لاستخدامه عند عرض طلب للمستخدم
تمثيل JSON | |
---|---|
{ "timeIso8601": string } |
الحقول | |
---|---|
timeIso8601 |
يمثّل وقت حدث الطلب، مثل وقت الحجز ووقت التسليم وما إلى ذلك. يمكن أن يتمثل في مدة (وقت البدء والانتهاء) أو التاريخ أو الوقت أو ما إلى ذلك. يُرجى الرجوع إلى https://en.wikipedia.org/wiki/ISO_8601 للاطّلاع على جميع التنسيقات المتوافقة. |
PickupInfo
تمثّل هذه السمة تفاصيل حول طريقة استلام الطلب. وهي تشمل تفاصيل مثل نوع استلام الطلب وبيانات وصفية إضافية مرفقة بكل نوع، إن توفّرت.
تمثيل JSON | |
---|---|
{ "pickupType": enum ( |
الحقول | |
---|---|
pickupType |
طريقة الاستلام، مثل INSTORE وCURBSIDE وما إلى ذلك |
curbsideInfo |
تفاصيل خاصة بمعلومات الرصيف. إذا لم يكن pickupType ليس "CURBSIDE"، سيتم تجاهل هذا الحقل. |
checkInInfo[] |
قائمة بالطرق المختلفة التي يعتمدها الشريك لدعم تسجيل الوصول. |
PickupType
قائمة بأنواع استلام الطلبات المتوافقة
عمليات التعداد | |
---|---|
UNSPECIFIED |
لم يتم تحديد نوع استلام الطلب. |
INSTORE |
لاستلام الطعام من داخل المطعم. |
CURBSIDE |
ركن السيارة في مكان محدد خارج المطعم يقوم شخص ما بتوصيل الطعام هناك. |
CurbsideInfo
تفاصيل حول كيفية تسهيل تقديم طلبات الإيصال إلى السيارة
تمثيل JSON | |
---|---|
{ "curbsideFulfillmentType": enum ( |
الحقول | |
---|---|
curbsideFulfillmentType |
يحتاج الشركاء إلى معلومات إضافية لتسهيل طلبات الاستلام من السيارة. وبناءً على نوع توصيل الطلب الذي يتم اختياره، سيتم جمع التفاصيل المقابلة من المستخدم. |
userVehicle |
تفاصيل المركبة الخاصة بالمستخدم الذي قدّم الطلب |
CurbsideFulfillmentType
القيم المحتملة لأنواع توصيل الطلبات إلى السيارة.
عمليات التعداد | |
---|---|
UNSPECIFIED |
لم يتم تحديد نوع تسليم السيارة إلى السيارة. |
VEHICLE_DETAIL |
يجب توفير تفاصيل المركبة لتسهيل الاستلام من السيارة. |
مركبة
تفاصيل حول مركبة
تمثيل JSON | |
---|---|
{
"make": string,
"model": string,
"licensePlate": string,
"colorName": string,
"image": {
object ( |
الحقول | |
---|---|
make |
العلامة التجارية للمركبة (مثل "هوندا"). يتم عرض هذه المعلومات للمستخدم ويجب ترجمتها. مطلوب. |
model |
طراز المركبة (مثل "الغروم"). يتم عرض هذه المعلومات للمستخدم ويجب ترجمتها. مطلوب. |
licensePlate |
رقم لوحة ترخيص المركبة (مثل "1ABC234") مطلوب. |
colorName |
اسم لون المركبة، مثل الأسود اختياري. |
image |
عنوان URL لصورة المركبة سيتم عرض الصورة بحجم 256×256 بكسل تقريبًا. يجب أن تكون بتنسيق jpg أو png. اختياريّ. |
CheckInInfo
البيانات الوصفية التي يطلبها الشريك لإتاحة طريقة تسجيل الوصول
تمثيل JSON | |
---|---|
{
"checkInType": enum ( |
الحقول | |
---|---|
checkInType |
الطريقة المستخدمة لإرسال تعليمات تسجيل الوصول. |
CheckInType
طرق عديدة مستخدمة لإرسال تعليمات تسجيل الوصول.
عمليات التعداد | |
---|---|
CHECK_IN_TYPE_UNSPECIFIED |
قيمة غير معروفة. |
EMAIL |
سيتم إرسال معلومات تسجيل الوصول عبر البريد الإلكتروني. |
SMS |
سيتم إرسال معلومات تسجيل الوصول عبر الرسائل القصيرة SMS. |
ItemOption
يمثل هذا الإعداد الإضافات أو العناصر الفرعية.
تمثيل JSON | |
---|---|
{ "id": string, "name": string, "prices": [ { object ( |
الحقول | |
---|---|
id |
بالنسبة إلى خيارات السلع، معرّف السلعة الفريد |
name |
اسم الخيار. |
prices[] |
السعر الإجمالي للخيار |
note |
ملاحظة ذات صلة بالخيار |
quantity |
بالنسبة إلى خيارات السلع والكمية. |
productId |
معرّف المنتج أو العرض المرتبط بهذا الخيار |
subOptions[] |
لتحديد خيارات فرعية متداخلة أخرى. |
ProductDetails
تمثّل هذه السمة تفاصيل حول المنتج.
تمثيل JSON | |
---|---|
{ "productId": string, "gtin": string, "plu": string, "productType": string, "productAttributes": { string: string, ... } } |
الحقول | |
---|---|
productId |
معرّف المنتج أو العرض المرتبط بهذا العنصر |
gtin |
تمثّل هذه السمة الرقم التجاري العالمي للسلعة للمنتج. ويكون هذا الخيار مفيدًا في حال عدم توفّر معرّف العرض في Merchant Center. اختياريّ. |
plu |
إنّ رموز البحث عن الأسعار، المعروفة عادةً برموز PLU أو أرقام PLU أو أرقام PLU أو رموز الإنتاج أو تصنيفات المنتجات، هي منظومة من الأرقام التي تحدّد بشكل فريد المنتجات المجمّعة التي يتم بيعها في متاجر البقالة ومحلات السوبرماركت. |
productType |
فئة المنتج التي حدّدها التاجر. مثلاً: الصفحة الرئيسية > بقالة > منتجات الألبان البيض > حليب > حليب كامل الدسم" |
productAttributes |
التفاصيل التي يقدّمها التاجر عن المنتج، مثل: { "allergen": "peanut" }. ويكون هذا الخيار مفيدًا في حال عدم توفّر معرّف العرض في Merchant Center. اختياريّ. عنصر يحتوي على قائمة بأزواج |
ReservationItemExtension
محتوى تفاصيل الإعلانات لطلبات الحجز، مثل المطعم أو قص الشعر وما إلى ذلك
تمثيل JSON | |
---|---|
{ "status": enum ( |
الحقول | |
---|---|
status |
مطلوب: حالة الحجز. |
userVisibleStatusLabel |
المطلوب: إظهار التصنيف/سلسلة للمستخدم لمعرفة الحالة. الحد الأقصى المسموح به للطول هو 50 حرفًا. |
type |
نوع الحجز. ويمكن إلغاء التعيين في حال عدم انطباق أي من خيارات النوع. |
reservationTime |
الوقت الذي تمت جدولة الخدمة/الحدث فيه لوقوع الخدمة/الحدث. يمكن أن يكون نطاقًا زمنيًا أو تاريخًا أو وقتًا محددًا. |
userAcceptableTimeRange |
النطاق الزمني المقبول للمستخدم |
confirmationCode |
رمز تأكيد هذا الحجز. |
partySize |
عدد الأشخاص. |
staffFacilitators[] |
منسّقو الموظفين الذين سيقدمون خدمة الحجز. مثال مصفّف الشعر. |
location |
الموقع الجغرافي للخدمة/الحدث. |
ReservationStatus
حالة الحجز.
عمليات التعداد | |
---|---|
RESERVATION_STATUS_UNSPECIFIED |
حالة غير محدّدة |
PENDING |
الحجز في انتظار المراجعة. |
CONFIRMED |
تم تأكيد الحجز. |
CANCELLED |
ألغى المستخدم الحجز. |
FULFILLED |
يتم الحجز. |
CHANGE_REQUESTED |
تمّ طلب تغيير الحجز |
REJECTED |
انتهت صلاحية الحجز أو رفضته شركة الدمج. |
ReservationType
نوع الحجز.
عمليات التعداد | |
---|---|
RESERVATION_TYPE_UNSPECIFIED |
نوع غير محدَّد. |
RESTAURANT |
حجز لمطعم. |
HAIRDRESSER |
حجز لمصفّف الشعر. |
StaffFacilitator
معلومات حول مقدّم الخدمة
تمثيل JSON | |
---|---|
{
"name": string,
"image": {
object ( |
الحقول | |
---|---|
name |
تمثّل هذه السمة اسم المُنسّق. مثال "جون سميث" |
image |
صور مؤدي الأداء |
PaymentData
بيانات الدفع المرتبطة بطلب معيّن
تمثيل JSON | |
---|---|
{ "paymentResult": { object ( |
الحقول | |
---|---|
paymentResult |
نتيجة الدفع التي تستخدمها شركة الدمج لإكمال معاملة ستتم تعبئة هذا الحقل بواسطة "المهام مع مساعد Google" إذا كانت تجربة الدفع مُدارة من خلال "المهام مع مساعد Google". |
paymentInfo |
معلومات الدفع المتعلقة بالطلب، والذي يكون مفيدًا للتفاعل الموجّه للمستخدمين |
PaymentResult
نتيجة الدفع التي تستخدمها شركة الدمج لإكمال معاملة
تمثيل JSON | |
---|---|
{ // Union field |
الحقول | ||
---|---|---|
حقل الاتحاد result . تمّ تقديم بيانات الدفع من Google أو طريقة الدفع الخاصة بالتاجر. يمكن أن يكون result واحدًا فقط مما يلي: |
||
googlePaymentData |
قدّمت Google بيانات طريقة الدفع. إذا كانت الجهة المسؤولة عن معالجة المعاملات مدرَجة كجهة معالجة دفعات معتمَدة من Google على هذا الرابط: https://developers.google.com/pay/api/، انتقِل إلى الجهة المسؤولة عن معالجة المعاملات من خلال الرابط للحصول على مزيد من التفاصيل. في الحالات الأخرى، يمكنك الاطّلاع على المستندات التالية للحصول على تفاصيل الحمولة. https://developers.google.com/pay/api/payment-data-cryptography |
|
merchantPaymentMethodId |
طريقة الدفع المقدّمة من التاجر/الإجراء والتي اختارها المستخدم |
PaymentInfo
معلومات الدفع المتعلقة بالطلب الذي يتم تقديمه. يجمع هذا النموذج المعلومات المفيدة للتفاعل المواجه للمستخدم.
تمثيل JSON | |
---|---|
{ "paymentMethodDisplayInfo": { object ( |
الحقول | |
---|---|
paymentMethodDisplayInfo |
المعلومات المعروضة حول طريقة الدفع المُستخدَمة في المعاملة |
paymentMethodProvenance |
مصدر طريقة الدفع المُستخدَمة في المعاملة من المحتمل أن يكون المستخدم قد سجَّل طريقة الدفع نفسها لدى كل من Google والتاجر. |
PaymentMethodDisplayInfo
نتيجة الدفع التي تستخدمها شركة الدمج لإكمال معاملة
تمثيل JSON | |
---|---|
{
"paymentType": enum ( |
الحقول | |
---|---|
paymentType |
تمثّل هذه السمة نوع الدفعة. |
paymentMethodDisplayName |
الاسم المرئي لطريقة الدفع على سبيل المثال، VISA **** 1234 Checkout acct **** 5678 |
paymentMethodVoiceName |
اسم طريقة الدفع الذي سيتم قوله للمستخدم على الأجهزة المزوّدة بخدمة "مساعد Google" بالصوت فقط مَثَلًا، "التأشيرة المنتهية بـ واحد اثنان ثلاثة أربعة" أو "الحساب الجاري ينتهي بخمسة ثمانية وثمانين". ملاحظة: هذه هي السلسلة المحسّنة للصوت التي سيتم استخدامها بدلاً من paymentMethodDisplayName للأجهزة المزوّدة بخدمة "مساعد Google" بالصوت فقط. في حال عدم ضبط هذه السلسلة، سيتم نطق paymentMethodDisplayName إلى المستخدم بدلاً من ذلك. |
PaymentType
يشير نوع الدفع إلى طريقة الدفع المستخدَمة لطريقة الدفع التي يقدّمها التاجر. يجب أن يقدّم الإجراء أيضًا اسمًا معروضًا لطريقة الدفع.
عمليات التعداد | |
---|---|
PAYMENT_TYPE_UNSPECIFIED |
طريقة دفع غير محدّدة |
PAYMENT_CARD |
بطاقة ائتمان أو بطاقة سحب آلي أو بطاقة دفع مسبق. |
BANK |
طريقة الدفع هي حساب مصرفي. |
LOYALTY_PROGRAM |
طريقة الدفع من برنامج الولاء. |
CASH |
طريقة الدفع نقدًا. |
GIFT_CARD |
طريقة الدفع هي بطاقة هدايا. |
WALLET |
محفظة تابعة لجهة خارجية، مثل PayPal |
PaymentMethodProvenance
تمثّل هذه السمة أصل طريقة الدفع المستخدَمة في المعاملة.
عمليات التعداد | |
---|---|
PAYMENT_METHOD_PROVENANCE_UNSPECIFIED |
عدم تحديد المصدر |
PAYMENT_METHOD_PROVENANCE_GOOGLE |
المصدر هو Google. |
PAYMENT_METHOD_PROVENANCE_MERCHANT |
المصدر هو التاجر. |
عرض ترويجي
العروض الترويجية أو العروض التي تمّت إضافتها إلى سلة التسوّق
تمثيل JSON | |
---|---|
{ "coupon": string } |
الحقول | |
---|---|
coupon |
مطلوب: رمز القسيمة المطبَّق على هذا العرض. |
PurchaseOrderExtension
إضافة الطلب لقطاع الشراء. تنطبق هذه السمات على جميع تفاصيل الطلب داخل الطلب، ما لم يتم تجاوزها في عنصر.
تمثيل JSON | |
---|---|
{ "status": enum ( |
الحقول | |
---|---|
status |
مطلوب: الحالة العامة للطلب |
userVisibleStatusLabel |
إظهار المستخدم للتصنيف/السلسلة للحالة. الحد الأقصى المسموح به للطول هو 50 حرفًا. |
type |
مطلوب: نوع عملية الشراء |
returnsInfo |
إرجاع معلومات الطلب |
fulfillmentInfo |
معلومات توصيل الطلب الخاصة بالطلب |
purchaseLocationType |
موقع عملية الشراء (في المتجر / على الإنترنت) |
errors[] |
اختياري: الأخطاء التي أدّت إلى رفض هذا الطلب. |
extension |
أي حقول إضافية يتم تبادلها بين التاجر وGoogle ملاحظة: لا يُنصح باستخدام هذه الإضافة. بناءً على حالة الاستخدام أو الظروف، يجب مراعاة أي مما يلي: 1. حدِّد الحقول في purchaseOrderExtension إذا كان من الممكن استخدامها لحالات استخدام أخرى (مثل الإمكانات/الوظائف العامة). 2. ويمكنك استخدام vertical_extension إذا كانت خاصة بحالة استخدام أو ميزة مخصّصة غير عامة. كائن يحتوي على حقول من نوع عشوائي يحتوي الحقل الإضافي |
PurchaseLocationType
نوع الموقع الجغرافي لعملية الشراء
عمليات التعداد | |
---|---|
UNSPECIFIED_LOCATION |
قيمة غير معروفة. |
ONLINE_PURCHASE |
جميع عمليات الشراء التي تم شراؤها على الإنترنت. |
INSTORE_PURCHASE |
جميع عمليات الشراء في المتجر |
PurchaseError
الأخطاء التي يمكن أن يتم رفض طلب الشراء بسببها
تمثيل JSON | |
---|---|
{ "type": enum ( |
الحقول | |
---|---|
type |
مطلوب: يمثّل هذا الحقل السبب الدقيق لرفض التاجر للطلب. |
description |
وصف إضافي للخطأ. |
entityId |
رقم تعريف الكيان الذي يتوافق مع الخطأ. مثال: يمكن أن تتوافق هذه القيمة مع LineItemId / ItemOptionId. |
updatedPrice |
هذه السمة مفيدة في حال نوع الخطأ PRICE_CHANGED / INCORRECT_PRICE. |
availableQuantity |
الكمية متوفرة الآن. سارٍ في حال AVAILABILITY_CHANGED. |
ErrorType
أنواع الأخطاء المحتملة.
عمليات التعداد | |
---|---|
ERROR_TYPE_UNSPECIFIED |
خطأ غير معروف |
NOT_FOUND |
لم يتم العثور على الكيان، ويمكن أن يكون العنصر أو FulfillmentOption أو العرض الترويجي. يجب إدخال رقم تعريف الكيان. |
INVALID |
بيانات الكيان غير صالحة. هي Item أو FulfillmentOption أو ترقية. يجب إدخال رقم تعريف الكيان. |
AVAILABILITY_CHANGED |
السلعة غير متوفرة، أو العناصر غير الكافية لتلبية الطلب. يجب إدخال رقم تعريف الكيان. |
PRICE_CHANGED |
سعر السلعة مختلفًا عن سعرها في كيان السلعة يجب إدخال رقم تعريف الكيان والسعر المعدَّل. |
INCORRECT_PRICE |
أخطاء الأسعار في الرسوم، الإجمالي يجب إدخال رقم تعريف الكيان والسعر المعدَّل. |
REQUIREMENTS_NOT_MET |
قيود قبول الطلب - الحد الأدنى لحجم سلة التسوّق إلخ |
TOO_LATE |
انتهت صلاحية FulfillmentOption. |
NO_CAPACITY |
لا تتوفّر سعة خدمة. استخدم رمز الخطأ هذا إذا لم ينطبق أي من أنواع الأخطاء الأكثر دقة. |
NO_COURIER_AVAILABLE |
تعذّر العثور على أي شركة نقل. نوع خطأ دقيق يمكن تصنيفه كـ NO_CAPAcity. |
INELIGIBLE |
المستخدم غير مؤهّل لتقديم طلب (تم إدراجه في القائمة السوداء). |
OUT_OF_SERVICE_AREA |
يتعذّر التسليم إلى العنوان المطلوب بسبب القواعد الحدودية وما إلى ذلك. |
CLOSED |
المطعم مغلق للعمل في وقت الطلب. |
PROMO_NOT_APPLICABLE |
رمز خطأ عام لرصد جميع حالات عدم استخدام الرمز الترويجي، إذا لم يكن أيّ من الحالات التالية مناسبًا. إضافة الرمز الترويجي كرقم تعريف الكيان. |
PROMO_NOT_RECOGNIZED |
لم يتعرّف الشريك على رمز القسيمة. إضافة الرمز الترويجي كرقم تعريف الكيان. |
PROMO_EXPIRED |
تعذّر تطبيق الطلب بسبب انتهاء صلاحية العرض الترويجي. إضافة الرمز الترويجي كرقم تعريف الكيان. |
PROMO_USER_INELIGIBLE |
المستخدم الحالي غير مؤهل للحصول على هذه القسيمة. إضافة الرمز الترويجي كرقم تعريف الكيان. |
PROMO_ORDER_INELIGIBLE |
الطلب الحالي غير مؤهّل للحصول على هذه القسيمة. إضافة الرمز الترويجي كرقم تعريف الكيان. |
UNAVAILABLE_SLOT |
خانة الطلب المسبق غير متاحة. |
FAILED_PRECONDITION |
قيود قبول الطلب - الحد الأدنى لحجم سلة التسوّق وما إلى ذلك |
PAYMENT_DECLINED |
دفعة غير صالحة. |
MERCHANT_UNREACHABLE |
لا يمكن الوصول إلى التاجر. ويساعد ذلك في الحالات التي يكون فيها الشريك مجمّع سلع ولا يمكنه الوصول إلى التاجر. |
ACCOUNT_LINKING_FAILED |
حاول التاجر ربط حساب مستخدم على Google بحساب في نظامه، ولكنّه واجه خطأً أثناء تنفيذ ذلك. |
TicketOrderExtension
اطلب محتوى طلبات التذاكر، مثل الأفلام والفعاليات الرياضية وغيرها.
تمثيل JSON | |
---|---|
{
"ticketEvent": {
object ( |
الحقول | |
---|---|
ticketEvent |
تم تطبيق الحدث على جميع تذاكر تفاصيل الإعلان. |
TicketEvent
ويمثل حدثًا واحدًا.
تمثيل JSON | |
---|---|
{ "type": enum ( |
الحقول | |
---|---|
type |
مطلوب: نوع حدث التذكرة، على سبيل المثال أو فيلم أو حفلة موسيقية. |
name |
مطلوب: اسم الفعالية. على سبيل المثال، إذا كان الحدث عبارة عن فيلم، يجب أن يكون هذا اسم الفيلم. |
description |
تمثّل هذه السمة وصف الفعالية. |
url |
عنوان URL لمعلومات الفعالية. |
location |
تمثّل هذه السمة الموقع الجغرافي الذي ستقام فيه الفعالية أو المؤسسة. |
eventCharacters[] |
تمثّل هذه السمة الشخصيات ذات الصلة بهذا الحدث. يمكن أن يكونوا مخرجين أو ممثلين لحدث فيلم، أو مقدمو حفلة موسيقية، وما إلى ذلك. |
startDate |
وقت البدء |
endDate |
وقت الانتهاء |
doorTime |
وقت الإدخال، الذي قد يختلف عن وقت بدء الحدث مثلاً: يبدأ الحدث في الساعة 9 صباحًا، ولكن وقت الدخول هو 8:30 صباحًا. |
النوع
نوع الحدث.
عمليات التعداد | |
---|---|
EVENT_TYPE_UNKNOWN |
نوع حدث غير معروف. |
MOVIE |
فيلم. |
CONCERT |
حفلة موسيقية. |
SPORTS |
الرياضة. |
EventCharacter
حرف حدث واحد، مثل المنظّم أو المؤدي وما إلى ذلك
تمثيل JSON | |
---|---|
{ "type": enum ( |
الحقول | |
---|---|
type |
نوع حرف الحدث، على سبيل المثال ممثل أو مخرج. |
name |
تمثّل هذه السمة اسم الشخصية. |
image |
صور الشخصية. |
النوع
نوع الحرف.
عمليات التعداد | |
---|---|
TYPE_UNKNOWN |
نوع غير معروف. |
ACTOR |
ممثل |
PERFORMER |
مؤدي عروض. |
DIRECTOR |
المخرِج |
ORGANIZER |
المنظِّم. |
UserNotification
إشعار اختياري للمستخدم يتم عرضه كجزء من تعديل الطلب.
تمثيل JSON | |
---|---|
{ "title": string, "text": string } |
الحقول | |
---|---|
title |
تمثّل هذه السمة عنوان إشعار المستخدم. الحد الأقصى المسموح به للطول هو 30 حرفًا. |
text |
محتوى الإشعار. الحد الأقصى المسموح به للطول هو 100 حرف. |
NextScene
يمثل المشهد الذي سيتم تنفيذه بعد ذلك.
تمثيل JSON | |
---|---|
{ "name": string } |
الحقول | |
---|---|
name |
اسم المشهد المطلوب تنفيذه بعد ذلك |
الجلسة
يحتوي على معلومات عن جلسة المحادثة الحالية
تمثيل JSON | |
---|---|
{
"id": string,
"params": {
string: value,
...
},
"typeOverrides": [
{
object ( |
الحقول | |
---|---|
id |
مطلوب. معرّف فريد عالمي لجلسة المحادثة الحالية. هذا الحقل للقراءة فقط. |
params |
مطلوب. قائمة بجميع المَعلمات التي يتم جمعها من النماذج والأهداف أثناء الجلسة المفتاح هو اسم المَعلمة. سيتم دمج المعلّمات المحدّدة هنا مع المَعلمات التي سبق أن تم تحديدها في الجلسة. وستتمّ إزالة المَعلمات ذات القيمة الفارغة من الجلسة. يمكنك الاطّلاع على مستندات مساحة تخزين الجلسة: https://developers.google.com/assistant/conversational/storage-session. عنصر يحتوي على قائمة بأزواج |
typeOverrides[] |
اختياريّ. الأنواع المحدّدة في الجلسة. يمكن أن تكمل تحديدات نوع الجلسة الأنواع الحالية أو تحل محلها. يجب أن تكون أسماء الأنواع فريدة. |
languageCode |
لغة جلسة المحادثة الحالية يتّبع رمز اللغة IETF BCP-47 http://www.rfc-editor.org/rfc/bcp/bcp47.txt. قد يختلف هذا الإعداد عن لغة المستخدم إذا كان الإجراء يستخدم ميزات لغات متعددة. على سبيل المثال، عندما يتم ضبط handler_response.required.language_code، يتمّ تغيير لغة المحادثة لجميع الأدوار التالية، وهو ما سينعكس في هذا الحقل. |
TypeOverride
يمثل تجاوزًا لنوع ما.
تمثيل JSON | |
---|---|
{ "name": string, "mode": enum ( |
الحقول | |
---|---|
name |
مطلوب. اسم النوع الذي يمكن استكماله أو إلغائه. |
mode |
مطلوب. كيفية دمج هذا النوع مع قيم الأنواع الأخرى |
synonym |
|
TypeOverrideMode
أنواع التعديلات لنوع كيان للجلسة.
عمليات التعداد | |
---|---|
TYPE_UNSPECIFIED |
لم يتم تحديده. يجب عدم استخدام هذه القيمة مطلقًا. |
TYPE_REPLACE |
ستحل تعريفات النوع في هذه الاستجابة محل تعريفات الأنواع التي تم تحديدها سابقًا. |
TYPE_MERGE |
سيتم دمج تعريفات الأنواع في هذا الرد مع تعريفات الأنواع التي تم تحديدها سابقًا. ستحل تعريفات الأنواع الجديدة محل تعريفات الأنواع الحالية. |
SynonymType
يمثل نوعًا مع المرادفات.
تمثيل JSON | |
---|---|
{
"entries": [
{
object ( |
الحقول | |
---|---|
entries[] |
مطلوب. قائمة إدخالات لنوع المرادف. |
إدخال
يمثل إدخالاً لنوع مرادف.
تمثيل JSON | |
---|---|
{
"name": string,
"synonyms": [
string
],
"display": {
object ( |
الحقول | |
---|---|
name |
مطلوب. اسم المدخل (على سبيل المثال، "دراجة"). يجب تضمين الإدخال في هذا الحقل في حقل المرادفات المتكررة ليتم التعرف على كقيمة نوع صالحة. |
synonyms[] |
مطلوب. قائمة مرادفات للإدخال (على سبيل المثال، "دراجة" أو "دورة"). |
display |
اختياريّ. معلومات عرض العنصر |
EntryDisplay
تمثيل JSON | |
---|---|
{ "title": string, "description": string, "image": { object ( |
الحقول | |
---|---|
title |
مطلوب. عنوان السلعة عند النقر على هذا النص، سيتم نشره مرة أخرى على المحادثة حرفيًا كما لو كان المستخدم قد كتبه. يجب أن يكون كل عنوان فريدًا من بين مجموعة عناصر المجموعة. |
description |
اختياريّ. النص الأساسي للبطاقة. |
image |
اختياريّ. الصورة التي تريد عرضها |
footer |
اختياريّ. نص التذييل لعنصر مجموعة التصفح، ويتم عرضه أسفل الوصف. سطر واحد من النص، تم اقتطاعه بعلامة الحذف. |
openUrl |
عنوان URL للمستند المرتبط بعنصر لوحة العرض الدوّارة للتصفّح مطلوب لتصفّح لوحة العرض الدوّارة. |
مستخدم
لتمثيل المستخدم الذي يقدّم طلبًا إلى الإجراء
تمثيل JSON | |
---|---|
{ "locale": string, "params": { string: value, ... }, "accountLinkingStatus": enum ( |
الحقول | |
---|---|
locale |
إعداد اللغة الأساسية للمستخدم الذي قدّم الطلب. يتّبع رمز اللغة IETF BCP-47 http://www.rfc-editor.org/rfc/bcp/bcp47.txt. ومع ذلك، لا يتم تضمين العلامة الفرعية للنص البرمجي. |
params |
اختياريّ. قائمة بجميع المَعلمات المرتبطة بالمستخدم الحالي يمكنك الاطّلاع على مستندات مساحة تخزين المستخدم: https://developers.google.com/assistant/conversational/storage-user. عنصر يحتوي على قائمة بأزواج |
accountLinkingStatus |
ما إذا كان حساب المستخدِم مرتبطًا بالتطبيق. |
verificationStatus |
تشير إلى حالة إثبات هوية المستخدم. |
lastSeenTime |
الطابع الزمني للتفاعل الأخير مع هذا المستخدم. سيتم حذف هذا الحقل إذا لم يسبق للمستخدم التفاعل مع الوكيل. طابع زمني بتنسيق RFC3339 حسب التوقيت العالمي المنسَّق (UTC) "زولو" بدقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: |
engagement |
تفاعل المستخدم الحالي، بما في ذلك أي اشتراكات في الأهداف. |
packageEntitlements[] |
استحقاقات المستخدم ذات الصلة بحزمة Android المرتبطة بالإجراء الحالي |
permissions[] |
يحتوي على الأذونات التي منحها المستخدم لهذا الإجراء. |
AccountLinkingStatus
تشير إلى ما إذا كان المستخدم النهائي قد ربط حسابه بهذا التطبيق. يمكنك الاطّلاع على مستندات ربط الحسابات: https://developers.google.com/assistant/identity.
عمليات التعداد | |
---|---|
ACCOUNT_LINKING_STATUS_UNSPECIFIED |
غير معروف. |
NOT_LINKED |
لم يربط المستخدم حسابه بهذا التطبيق. |
LINKED |
ربط المستخدم حسابه بهذا التطبيق. |
UserVerificationStatus
تشير هذه القيمة إلى ما إذا كانت Google قد تحقّقت من المستخدم أم لا. تشير حالة "تم التحقق من الصحة" إلى أنّه بإمكانك حفظ البيانات في المحادثات باستخدام حقل المَعلمات أو من خلال ربط الحساب.
عمليات التعداد | |
---|---|
USER_VERIFICATION_STATUS_UNSPECIFIED |
غير معروف. |
GUEST |
مستخدم ضيف. |
VERIFIED |
مستخدم تم إثبات هويته. |
الجذب
يوفر معلومات إضافية للقراءة فقط عن آليات التفاعل التي سجّل المستخدم الحالي لها. على سبيل المثال، قد يكون من المفيد معرفة النوايا التي اشترك فيها المستخدم بالفعل لتجنب مطالبته بالاشتراك في نفس النية مرة أخرى. على سبيل المثال، يمكن استخدام هذه المعلومات لتوجيه المشاهد بشكل مشروط إلى مشهد من أجل إعداد خدمة DailyUpdates أو PushNotifications، وذلك فقط في حال لم يسبق للمستخدم الاشتراك فيها. يمكنك الاطّلاع على مستندات تفاعل المستخدمين: https://developers.google.com/assistant/engagement.
تمثيل JSON | |
---|---|
{ "pushNotificationIntents": [ { object ( |
الحقول | |
---|---|
pushNotificationIntents[] |
تحتوي على قائمة بالأغراض التي فعّل المستخدم الإشعارات الفورية لها. |
dailyUpdateIntents[] |
يحتوي على قائمة بالأغراض التي فعّل المستخدم التحديث اليومي لها. |
IntentSubscription
يصف هذا المكوِّن IntentSubscription الحالي.
تمثيل JSON | |
---|---|
{ "intent": string, "contentTitle": string } |
الحقول | |
---|---|
intent |
تمثّل هذه السمة اسم الغرض الذي تم الاشتراك فيه. |
contentTitle |
اكتب وصفًا موجزًا للاشتراك. ويتم استخدامه كتصنيف للإشعار وعندما يطلب "مساعد Google" إذنًا من المستخدم. |
PackageEntitlements
قائمة بأذونات المستخدم المرتبطة باسم حزمة يمكنك الاطّلاع على مستندات المعاملات الرقمية الصالحة: https://developers.google.com/assistant/transactions/digital/dev-guide-digital-non-consumables.
تمثيل JSON | |
---|---|
{
"packageName": string,
"entitlements": [
{
object ( |
الحقول | |
---|---|
packageName |
اسم حزمة Android المحدّد في حزمة الإجراءات. |
entitlements[] |
استحقاقات المستخدم للحزمة المحدّدة. |
الاستحقاق
تحدِّد هذه السياسة الاستخدام الرقمي للمستخدم.
تمثيل JSON | |
---|---|
{ "sku": string, "skuType": enum ( |
الحقول | |
---|---|
sku |
رمز التخزين التعريفي للمنتج اسم حزمة التطبيق المدفوع، ولاحقة Finsky docid للشراء داخل التطبيق والاشتراك داخل التطبيق. طابِق الطريقة getSku() في واجهة برمجة التطبيقات Play InApp Billing API. يمكنك الاطّلاع على مستندات "الفوترة داخل التطبيق" في Play: https://developer.android.com/google/play/billing. |
skuType |
تمثّل هذه السمة نوع رمز التخزين التعريفي. |
inAppDetails |
العرض متاح فقط للشراء داخل التطبيق وللمشتركين داخل التطبيق. |
SkuType
عمليات التعداد | |
---|---|
SKU_TYPE_UNSPECIFIED |
|
IN_APP |
الشراء داخل التطبيق |
SUBSCRIPTION |
الاشتراكات |
APP |
التطبيقات المدفوعة |
SignedData
تمثيل JSON | |
---|---|
{ "inAppPurchaseData": { object }, "inAppDataSignature": string } |
الحقول | |
---|---|
inAppPurchaseData |
يحتوي على جميع بيانات الشراء داخل التطبيق بتنسيق JSON. يمكنك الاطّلاع على التفاصيل في الجدول 6 على الرابط https://developer.android.com/google/play/billing/billing_reference.html. |
inAppDataSignature |
يطابق IN_APP_DATA_SIGNATURE من طريقة getPurchases() في Play InApp Billing API. |
الإذن
القيم المحتملة للإذن.
عمليات التعداد | |
---|---|
PERMISSION_UNSPECIFIED |
إذن غير محدّد. |
DEVICE_PRECISE_LOCATION |
اطلب الموقع الجغرافي الدقيق للمستخدم وخط العرض/خط الطول والعنوان بالتنسيق. |
DEVICE_COARSE_LOCATION |
طلب الموقع الجغرافي التقريبي للمستخدم والرمز البريدي والمدينة ورمز البلد |
UPDATE |
طلب الأذونات لإرسال التحديثات. يُرجى الاطّلاع على https://developers.google.com/assistant/engagement/daily. |
الصفحة الرئيسية
يمثل بنية HomeGraph التي ينتمي إليها الجهاز المستهدف للمستخدم.
تمثيل JSON | |
---|---|
{ "params": { string: value, ... } } |
الحقول | |
---|---|
params |
اختياريّ. قائمة بالمعلَمات المرتبطة ببنية HomeGraph التي ينتمي إليها الجهاز المستهدف. يمكنك الاطّلاع على مستندات مساحة التخزين في المنزل: https://developers.google.com/assistant/conversational/storage-home. عنصر يحتوي على قائمة بأزواج |
الجهاز
يمثل الجهاز الذي يستخدمه المستخدم لتقديم طلب إلى الإجراء.
تمثيل JSON | |
---|---|
{ "capabilities": [ enum ( |
الحقول | |
---|---|
capabilities[] |
يجب ملء الحقل. إمكانات الجهاز الذي يرسل طلبًا إلى الإجراء. |
currentLocation |
اختياريّ. الموقع الجغرافي لجهاز المستخدم ملاحظة: لا تتم تعبئة هذا الحقل إلا بعد أن يمنح المستخدم النهائي أذونات تحديد الموقع الجغرافي. راجِع رسالة الموقع الجغرافي للحصول على مزيد من التفاصيل حول الحقول التي يتم ضبطها استنادًا إلى الإذن التقريبي مقابل الإذن الدقيق. يمكنك الاطّلاع على مستندات الأذونات: https://developers.google.com/assistant/conversational/permissions. |
timeZone |
اختياريّ. المنطقة الزمنية المرتبطة بجهاز العميل. ويمكن استخدامها لحل قيم التاريخ والوقت. |
الإمكانية
الإمكانات التي تتوافق مع مساحة عرض الجهاز في وقت الطلب.
عمليات التعداد | |
---|---|
UNSPECIFIED |
قدرات الجهاز غير محدّدة. |
SPEECH |
يمكن للجهاز التحدث إلى المستخدم عبر تحويل النص إلى كلام أو SSML. |
RICH_RESPONSE |
يمكن للجهاز عرض ردود مفيدة، مثل البطاقات والقوائم والجداول. |
LONG_FORM_AUDIO |
يمكن للجهاز تشغيل وسائط صوتية طويلة، مثل الموسيقى وملفات البودكاست. |
INTERACTIVE_CANVAS |
يمكن للجهاز عرض استجابة لوحة تفاعلية. |
WEB_LINK |
يمكن للجهاز استخدام روابط الويب في الردود المنسّقة لفتح متصفّح ويب. |
HOME_STORAGE |
يمكن أن يتيح الجهاز حفظ مساحة التخزين في المنزل واسترجاعها. |
الموقع الجغرافي
حاوية تمثّل موقعًا جغرافيًا
تمثيل JSON | |
---|---|
{ "coordinates": { object ( |
الحقول | |
---|---|
coordinates |
الإحداثيات الجغرافية يجب الحصول على إذن [DEVICE_PRECISE_LOCATION]. |
postalAddress |
العنوان البريدي. يجب الحصول على إذن [DEVICE_PRECISE_LOCATION] أو [DEVICE_COARSE_LOCATION]. عند منح إذن تحديد الموقع الجغرافي التقريبي، لا يتم استخدام سوى "postalCode" و"المنطقة المحلية" من المتوقع أن تتم تعبئة الحقول. سيؤدي "إذن تحديد الموقع الجغرافي الدقيق" إلى تعبئة حقول إضافية، مثل "administrativeArea". و"addressLines". |
TimeZone
تمثل هذه السمة منطقة زمنية من قاعدة بيانات المنطقة الزمنية IANA.
تمثيل JSON | |
---|---|
{ "id": string, "version": string } |
الحقول | |
---|---|
id |
المنطقة الزمنية لقاعدة بيانات المنطقة الزمنية التي منظمة IANA (المنظمة المعنية بأرقام الإنترنت المخصصة)، مثل: "أمريكا/نيويورك". |
version |
اختياريّ. رقم إصدار قاعدة بيانات المنطقة الزمنية الصادر عن IANA (المنظمة المعنية بأرقام الإنترنت المخصصة)، مثلاً "2019a". |
السياق
يحتوي على معلومات السياق عندما يُجري المستخدم طلب بحث يشمل هذا السياق، على سبيل المثال لا الحصر، معلومات حول جلسة الوسائط النشطة وحالة تطبيق الويب للوحة الرسم وما إلى ذلك.
تمثيل JSON | |
---|---|
{ "media": { object ( |
الحقول | |
---|---|
media |
يحتوي على معلومات سياقية حول جلسة الوسائط النشطة الحالية. |
canvas |
تحتوي على معلومات سياقية حول اللوحة الحالية. |
MediaContext
يحتوي على معلومات سياقية حول جلسة الوسائط النشطة الحالية.
تمثيل JSON | |
---|---|
{ "progress": string, "index": integer } |
الحقول | |
---|---|
progress |
مستوى تقدُّم الوسائط لملف الوسائط النشط الحالي مدة بالثواني مكونة من تسعة أرقام كسور كحد أقصى، ويتم إنهاؤها بعبارة " |
index |
فهرس يستند إلى 0 لملف الوسائط النشط الحالي في قائمة ملفات الوسائط في استجابة الوسائط. |
CanvasContext
تحتوي على معلومات سياقية حول اللوحة الحالية.
تمثيل JSON | |
---|---|
{ "state": value } |
الحقول | |
---|---|
state |
اختياريّ. الحالة التي تم ضبطها بواسطة تطبيق "لوحة الرسم التفاعلية" التابع لجهة خارجية ويتم ضبطها للطلب فقط، وليس للاستجابة. على سبيل المثال، إذا كان هذا تطبيق وصفات طعام، يمكن أن تكون الحالة قيمة struct : { "current_page" : 5، "last_page" : 3, } الحدّ الأقصى المسموح به للحجم هو 50 كيلوبايت. |
المتوقع
يصف التوقعات بشأن منعطف الحوار التالي.
تمثيل JSON | |
---|---|
{ "speech": [ string ] } |
الحقول | |
---|---|
speech[] |
تشير هذه السمة إلى قائمة العبارات التي يتوقّعها الإجراء من خلال قول المستخدم لانحياز الكلام. يُسمح باستخدام ما يصل إلى 1,000 عبارة. ملاحظة: يحمل هذا الحقل المعنى نفسه كما هو متوقع في واجهة برمجة التطبيقات v2 API. |