- طلب HTTP
- نص الطلب
- نص الاستجابة
- المعالج
- النية بالشراء
- IntentParameterValue
- المشهد
- SlotFillingStatus
- خانة
- الفتحة
- الفتحة
- رسالة مطالبة
- بسيطة
- المحتوى
- البطاقة
- صورة
- ملء الصورة
- الرابط
- OpenUrl
- UrlHint
- جدول
- TableTable
- المحاذاة الأفقية
- TableRow
- TableCell
- الوسائط
- MediaType
- OptionalMediaControls
- MediaObject
- MediaImage
- وضع التكرار
- المجموعة
- CollectionItem
- القائمة
- ListItem
- Collectionتصفّح
- العنصر
- الاقتراح
- لوحة الرسم
- مستمر في الإعداد
- العبارة المتوقعة
- OrderUpdate
- النوع
- الطلب
- UserInfo
- رقم الهاتف
- صورة
- التاجر
- الموقع الجغرافي
- خط الطول والعرض
- PostalAddress
- المحتوى
- LineItem
- PriceAttribute
- النوع
- الولاية
- المبلغ
- الإجراء
- النوع
- OpenUrlAction
- تطبيق Android
- إصدار الفلتر
- UrlTypeHint
- البيانات الوصفية للإجراءات
- الإفصاح
- نص الإفصاح
- TextLink
- الإفصاح عن العرض التقديمي
- متطلبات العرض التقديمي
- PurchaseItemExtension
- حالة الشراء
- نوع الشراء
- MerchantUnitMeasure
- الوحدة
- PurchaseReturnsInfo
- شراءFulfillmentInfo
- النوع
- الوقت
- معلومات استلام الطلب
- pickupupType
- CurbsideInfo
- CurbsideFulfillmentType
- المركبة
- CheckInInfo
- CheckInType
- ItemOption
- ProductDetails
- ReservationItemExtension
- حالة الحجز
- نوع الحجز
- منسق الجلسة
- بيانات الدفع
- PaymentResult
- معلومات الدفع
- PaymentMethodDisplayInfo
- PaymentType (نوع الدفع)
- مصدر طريقة الدفع
- العرض الترويجي
- PurchaseOrderExtension
- PurchaseLocationType
- PurchaseError
- نوع الخطأ
- TicketOrderExtension
- TicketEvent
- النوع
- الحرف
- النوع
- UserNotification
- NextScene
- الجلسة
- TypeOverride
- TypeTypeMode
- المترادفات
- إدخال
- إدخال العرض
- المستخدم
- AccountLinkingStatus
- حالة التحقّق من المستخدم
- التفاعل
- هدف الاشتراك
- تخويلات الحزمة
- التخويل
- SkuType
- SignedData
- إذن
- الصفحة الرئيسية
- الجهاز
- الإمكانية
- الموقع الجغرافي
- المنطقة الزمنية
- السياق
- MediaContext
- CanvasContext
- المتوقّعة
متوسط عائد النقرة الذي يمثّل واجهة برمجة تطبيقات تنفيذ الطلبات
طلب 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 |
اختياريّ. الإدخال المكتوب أو المنطوق من المستخدم الذي يطابق هذا القصد. ستتم تعبئة هذا الحقل عند مطابقة هدف، بناءً على إدخال المستخدم. |
قيمة المعلمة Intent
تمثل قيمة لمعلمة intent. راجِع https://developers.google.com/assistant/conversational/types.
تمثيل JSON | |
---|---|
{ "original": string, "resolved": value } |
الحقول | |
---|---|
original |
مطلوبة. تم استخراج قيمة النص الأصلي من كلام المستخدم. |
resolved |
مطلوبة. قيمة منظّمة للمعلمة المستخلصة من إدخال المستخدم. لن تتم تعبئة هذا الحقل إلا إذا تم تحديد المعلمة في الهدف من المطابقة، ويمكن تحديد قيمة المعلمة أثناء مطابقة الأهداف. |
أجواء الإضاءة
تمثيل مشهد يمكن أن تطلب المشاهد تنفيذ الطلبات وإضافة رسائل المطالبة وجمع قيم الشرائح الإعلانية من المستخدم. يتم تشغيل المشاهد من خلال الأحداث أو الرغبات ويمكنها تشغيل الأحداث ومطابقة الرغبات عند الانتقال إلى مشاهد أخرى.
تمثيل JSON | |
---|---|
{ "name": string, "slotFillingStatus": enum ( |
الحقول | |
---|---|
name |
مطلوبة. اسم المشهد الحالي. |
slotFillingStatus |
مطلوبة. الوضع الحالي لتعبئة الخانة. هذا الحقل للقراءة فقط. |
slots |
الشرائح المرتبطة بالمشهد الحالي. لا يمكن لردود المعالجات عرض خانات لم يتم إرسالها في الطلب. كائن يحتوي على قائمة بأزواج |
next |
اختياريّ. المعلومات التي سيتم تنفيذها على المشهد بعد ذلك. |
حالة ملء الشرائح الإعلانية
يمثل الحالة الحالية لتعبئة الشرائح.
عمليات التعداد | |
---|---|
UNSPECIFIED |
القيمة الاحتياطية عند عدم تعبئة حقل الاستخدام. |
INITIALIZED |
تم إعداد الخانات ولكن لم تبدأ تعبئة الخانة. |
COLLECTING |
جارٍ جمع قيم الشريحة. |
FINAL |
جميع قيم الفتحات نهائية ولا يمكن تغييرها. |
الحيز
يمثل خانة.
تمثيل JSON | |
---|---|
{ "mode": enum ( |
الحقول | |
---|---|
mode |
وضع الخانة (مطلوب أو اختياري). يمكن إعدادها بواسطة مطوّر البرامج. |
status |
حالة الخانة. |
value |
قيمة الخانة. سيؤدي تغيير هذه القيمة في الاستجابة إلى تعديل القيمة في ملء الخانة. |
updated |
يشير إلى ما إذا كان قد تم جمع قيمة الفتحة في المنعطف الأخير. هذا الحقل للقراءة فقط. |
prompt |
اختياريّ. ويتم إرسال رسالة المطالبة هذه إلى المستخدم عند الحاجة لملء خانة مطلوبة. تلغي هذه الرسالة المطالبة الحالية المحددة في وحدة التحكم. لم يتم تضمين هذا الحقل في طلب الرد التلقائي على الويب. |
وضع الشريحة الإعلانية
يمثل وضع فتحة، أي إذا كان ذلك مطلوبًا أم لا.
عمليات التعداد | |
---|---|
MODE_UNSPECIFIED |
القيمة الاحتياطية عند عدم تعبئة حقل الاستخدام. |
OPTIONAL |
للإشارة إلى أن الخانة غير مطلوبة لإكمال ملء الخانة. |
REQUIRED |
للإشارة إلى أن الخانة مطلوبة لإكمال ملء الشريحة. |
حالة الشريحة الإعلانية
تمثّل هذه السمة حالة الخانة.
عمليات التعداد | |
---|---|
SLOT_UNSPECIFIED |
القيمة الاحتياطية عند عدم تعبئة حقل الاستخدام. |
EMPTY |
يشير إلى أن الفتحة لا تتضمن أي قيم. لا يمكن تعديل هذه الحالة من خلال الاستجابة. |
INVALID |
تشير إلى أن قيمة الشريحة غير صالحة. يمكن ضبط هذه الحالة من خلال الاستجابة. |
FILLED |
يشير إلى أن الفتحة لها قيمة. لا يمكن تعديل هذه الحالة من خلال الاستجابة. |
سؤال
تمثل ردًا على أحد المستخدمين. راجِع https://developers.google.com/assistant/conversational/prompts.
تمثيل JSON | |
---|---|
{ "override": boolean, "firstSimple": { object ( |
الحقول | |
---|---|
override |
اختياريّ. وضع لكيفية دمج هذه الرسائل مع الرسائل المحددة سابقًا. يؤدي اختيار "true" إلى محو جميع الرسائل التي تم تحديدها سابقًا (أولاً وأخيرًا بسيطًا، ورابط محتوى واقتراحات ولوحة رسم) وإضافة رسائل تم تحديدها في رسالة المطالبة هذه. يضيف "false" الرسائل المحددة في رسالة المطالبة هذه إلى الرسائل المحددة في الردود السابقة. يؤدي ترك هذا الحقل على "false" أيضًا إلى تمكين الإلحاق ببعض الحقول داخل المطالبات البسيطة ومطالبة الاقتراحات ولوحة الرسم (جزء من مطالبة المحتوى). يتم دائمًا استبدال رسائل "المحتوى" و"الرابط" إذا تم تحديدها في المطالبة. القيمة الافتراضية هي "false". |
firstSimple |
اختياريّ. الاستجابة الأولى للصوت والنص فقط. |
content |
اختياريّ. محتوى مثل بطاقة أو قائمة أو وسائط ليتم عرضه للمستخدم. |
lastSimple |
اختياريّ. آخر رد صوتي ورسالة نصية فقط. |
suggestions[] |
اختياريّ. الاقتراحات التي سيتم عرضها للمستخدم والتي ستظهر دائمًا في نهاية الاستجابة. إذا كان الحقل "إلغاء" في المطالبة التي تظهر مضبوطة على "false"، فستتم إضافة العناوين المحددة في هذا الحقل إلى العناوين المحدّدة في أي مطالبات اقتراحات سابقة محدّدة، كما ستتم إزالة القيم المكرّرة. |
link |
اختياريّ. شريحة اقتراحات إضافية يمكن ربطها بالتطبيق أو الموقع الإلكتروني المرتبط وسيتم عرض الشريحة بالعنوان "فتح (اسم)". 20 حرفًا كحد أقصى. |
canvas |
اختياريّ. تُمثِّل استجابة "لوحة الرسم التفاعلية" التي سيتم إرسالها إلى المستخدم. |
orderUpdate |
يستجيب الإجراء الاختياري من خلال OrderUpdate بعد استلام الطلب أثناء تدفق المعاملات. وعند استلام ذلك، تُسجل Google هذا التحديث في الطلب، وفي حالة نجاح هذا الأمر، يتم عرض بطاقة إيصال بالإضافة إلى تقنية تحويل النص إلى كلام (TTS) المرسلة على أجهزة العرض. |
بسيط
يمثل مطالبة بسيطة ليتم إرسالها إلى مستخدم. راجِع https://developers.google.com/assistant/conversational/prompts-simple.
تمثيل JSON | |
---|---|
{ "speech": string, "text": string } |
الحقول | |
---|---|
speech |
اختياريّ. تمثّل هذه الخاصية الكلام الذي يتم التحدث به للمستخدم. يمكن أن يكون SSML أو نصًا إلى كلام. إذا كان الحقل "إلغاء" في المطالبة التي تحتوي على "صحيح"، فسيتم استبدال الكلام المحدد في هذا الحقل بخطاب المطالبة البسيطة السابقة. راجِع https://developers.google.com/assistant/conversational/ssml. |
text |
نص اختياري للعرض في فقاعة المحادثة. إذا لم يتم تقديمه، فسيتم استخدام عرض عرض لحقل الكلام أعلاه. يقتصر على 640 حرفًا. إذا كان الحقل "تجاوز" في المطالبة المضمنة "true"، فسيحل النص المحدد في هذا الحقل محل نص المطالبة البسيطة السابقة. |
المحتوى
كائن الحاوية للمطالبات المنسقة أو المطالبات المحددة.
تمثيل 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 |
النص الأساسي للبطاقة. دعم مجموعة محدودة من بنية التنسيق للتنسيق. مطلوبة، ما لم تكن الصورة موجودة. |
image |
صورة رئيسية للبطاقة. تم تثبيت الارتفاع على 192dp. اختياريّ. |
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 |
عرض الصورة بالبكسل. اختياريّ. |
ملء الصورة
خيارات عرض الصورة المحتملة للتأثير في عرض الصورة. وينبغي استخدام هذه الطريقة عندما لا تتطابق نسبة العرض إلى الارتفاع للصورة مع نسبة العرض إلى الارتفاع لحاوية الصورة.
عمليات التعداد | |
---|---|
UNSPECIFIED |
|
GRAY |
املأ الفجوات بين الصورة وحاوية الصورة بأشرطة رمادية. |
WHITE |
املأ الفجوات بين الصورة وحاوية الصورة بأشرطة بيضاء. |
CROPPED |
ويتم تغيير حجم الصورة بحيث يتطابق عرض وارتفاع الصورة مع أبعاد الحاوية أو يتجاوزها. وقد يؤدي هذا إلى اقتصاص الجزء العلوي والسفلي من الصورة إذا كان ارتفاع الصورة الذي تم تغيير حجمه أكبر من ارتفاع الحاوية، أو اقتصاص يسار ويمين الصورة إذا كان عرض الصورة الذي تم تغيير حجمه أكبر من عرض الحاوية. يشبه هذا "وضع التكبير/التصغير" على تلفزيون بشاشة عريضة عند تشغيل فيديو بنسبة 3:4. |
رابط
شريحة اقتراحات إضافية يمكن ربطها بالتطبيق أو الموقع الإلكتروني المرتبط وسيتم عرض الشريحة بالعنوان "فتح (اسم)".
تمثيل JSON | |
---|---|
{
"name": string,
"open": {
object ( |
الحقول | |
---|---|
name |
اسم الرابط. 20 حرفًا كحد أقصى. |
open |
ما يحدث عندما يفتح المستخدم الرابط |
عنوان URL المفتوح
تمثيل 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[] |
بيانات صف الجدول. يمكن ضمان عرض الصفوف الثلاثة الأولى، ولكن قد يتم قص صفوف أخرى على أسطح معيّنة. يُرجى إجراء الاختبار باستخدام المحاكي لمعرفة الصفوف التي سيتم عرضها لسطح معيّن. على الأسطح التي تدعم إمكانية WEB_BROWSER، يمكنك توجيه المستخدم إلى صفحة ويب تتضمن مزيدًا من البيانات. |
button |
زرّ |
عمود الجدول
تمثيل JSON | |
---|---|
{
"header": string,
"align": enum ( |
الحقول | |
---|---|
header |
نص رأس العمود. |
align |
المحاذاة الأفقية لعمود المحتوى. إذا لم يتم تحديده، فستتم محاذاة المحتوى إلى الحافة الأمامية. |
محاذاة أفقية
محاذاة المحتوى داخل الخلية.
عمليات التعداد | |
---|---|
UNSPECIFIED |
|
LEADING |
الحافة البادئة للخلية. هذا هو الخيار التلقائي. |
CENTER |
وتتم محاذاة المحتوى إلى مركز العمود. |
TRAILING |
تتم محاذاة المحتوى مع الحافة اللاحقة من العمود. |
صف الجدول
يصف صفًا في الجدول.
تمثيل JSON | |
---|---|
{
"cells": [
{
object ( |
الحقول | |
---|---|
cells[] |
الخلايا في هذا الصف. من المؤكّد ظهور أول 3 خلايا، ولكن قد يتم قص خلايا أخرى على أسطح معيّنة. يُرجى إجراء الاختبار باستخدام المحاكي لمعرفة الخلايا التي سيتم عرضها لسطح معيّن. |
divider |
يشير إلى ما إذا كان يجب وضع حاجز بعد كل صف أم لا. |
خلية الجدول
لوصف خلية في صف.
تمثيل JSON | |
---|---|
{ "text": string } |
الحقول | |
---|---|
text |
محتوى النص للخلية. |
الوسائط
يمثل كائن وسائط واحدًا. يحتوي على معلومات عن الوسائط، مثل الاسم والوصف وعنوان URL وغير ذلك. يمكنك الاطّلاع على https://developers.google.com/assistant/conversational/prompts-media.
تمثيل JSON | |
---|---|
{ "mediaType": enum ( |
الحقول | |
---|---|
mediaType |
|
startOffset |
بدء الإزاحة لكائن الوسائط الأول. عبارة عن مدة بالثواني تحتوي على ما يصل إلى تسعة أرقام كسرية، ويتم إنهاؤها بـ " |
optionalMediaControls[] |
أنواع التحكُّم في الوسائط الاختيارية التي يمكن أن تدعمها جلسة استجابة الوسائط هذه. إذا تم ضبط السياسة، سيتم إرسال الطلب إلى الجهة الخارجية في حال وقوع حدث معيّن للوسائط. وفي حال تم ترك السياسة بدون ضبط، يجب أن تستمرّ الجهات الخارجية في معالجة نوعَين تلقائيَين من عناصر التحكّم: FINISHED وFAILED. |
mediaObjects[] |
قائمة كائنات الوسائط |
repeatMode |
وضع التكرار لقائمة كائنات الوسائط. |
firstMediaObjectIndex |
فهرس يستند إلى 0 لأول كائن وسائط في MediaObjects لتشغيله. إذا لم يتم تحديد قيمة، أو كان صفرًا أو تم تجاوز الحدود، يبدأ التشغيل عند كائن الوسائط الأول في mediaObjects. |
نوع الوسائط
نوع الوسائط لهذا الرد.
عمليات التعداد | |
---|---|
MEDIA_TYPE_UNSPECIFIED |
|
AUDIO |
الملف الصوتي. |
MEDIA_STATUS_ACK |
الاستجابة للإقرار بتقرير حالة الوسائط |
عناصر التحكم في الوسائط الاختيارية
أنواع التحكّم في الوسائط الاختيارية التي يمكن أن تدعمها استجابة الوسائط
عمليات التعداد | |
---|---|
OPTIONAL_MEDIA_CONTROLS_UNSPECIFIED |
قيمة غير محددة |
PAUSED |
تم إيقاف الحدث مؤقتًا. يتم تشغيله عندما يوقف المستخدم الوسائط مؤقتًا. |
STOPPED |
تم إيقاف الحدث. يتم تشغيله عندما يخرج المستخدم من جلسة 3p أثناء تشغيل الوسائط. |
MediaObject
تمثل كائن وسائط واحدًا
تمثيل JSON | |
---|---|
{
"name": string,
"description": string,
"url": string,
"image": {
object ( |
الحقول | |
---|---|
name |
اسم عنصر الوسائط هذا. |
description |
وصف كائن الوسائط هذا. |
url |
عنوان URL الذي يشير إلى محتوى الوسائط. يجب استضافة ملفات MP3 على خادم ويب وأن تكون متاحة للجميع من خلال عنوان URL عبر بروتوكول HTTPS. لا يتوافق البث المباشر إلا مع تنسيق MP3. |
image |
صورة لعرضها مع بطاقة الوسائط. |
صورة وسائط
تمثيل JSON | |
---|---|
{ // Union field |
الحقول | ||
---|---|---|
حقل الاتحاد يمكن أن يكون |
||
large |
صورة كبيرة، مثل غلاف الألبوم، وما إلى ذلك |
|
icon |
رمز صورة صغيرة يظهر على يسار العنوان. ويتم تغيير حجمها إلى 36×36 بكسل مستقل الكثافة. |
وضع التكرار
أنواع وضع التكرار لقائمة من كائنات الوسائط.
عمليات التعداد | |
---|---|
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 |
كيفية ملء خلفيات الصور لعناصر المجموعة اختياريّ. |
عنصر المجموعة
عنصر في المجموعة
تمثيل 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 الذي يطابق اسم مفتاح الإدخال في النوع المرتبط. |
تصفّح المجموعات
لتقديم مجموعة من مستندات الويب كمجموعة من العناصر ذات المربعات الكبيرة. يمكن تحديد عناصر لتشغيل مستند الويب المقترن بها في عارض الويب. راجِع 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 |
مطلوبة. يفتح معرّف الموارد المنتظم إذا تم تحديد العنصر. |
اقتراح
توفّر الاقتراحات للمستخدمين الذين لديهم أجهزة تحتوي على شرائح اقتراحات عندما يعرض "مساعد 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 التي يتم تمريرها إلى صفحة تجربة الاستخدام المجسم كحدث. إذا كان الحقل "إلغاء" في المطالبة المتضمّنة هو "خطأ" في قيم البيانات المحدّدة في رسالة المطالبة هذه بشأن "لوحة الرسم"، ستتم إضافتها بعد قيم البيانات المحدّدة في المطالبات السابقة في "لوحة الرسم". |
suppressMic |
اختياريّ. القيمة التلقائية: false. |
continuousMatchConfig |
التهيئة المستخدمة لبدء وضع المطابقة المستمرة. |
مطابقة مستمرة للإعداد
التهيئة المستخدمة لبدء وضع المطابقة المستمرة.
تمثيل JSON | |
---|---|
{
"expectedPhrases": [
{
object ( |
الحقول | |
---|---|
expectedPhrases[] |
جميع العبارات المتوقعة المحتملة خلال جلسة وضع المطابقة المستمرة. |
durationSeconds |
المدة الزمنية لإبقاء وضع التطابق المستمر مفعّلاً. في حال تحديده، سيتم إغلاق الميكروفون عند انتهاء الوقت. الحد الأقصى للقيمة المسموح بها هي 180. |
عبارة متوقعة
تمثيل JSON | |
---|---|
{ "phrase": string, "alternativePhrases": [ string ] } |
الحقول | |
---|---|
phrase |
العبارة المطلوب مطابقتها أثناء جلسة وضع المطابقة المستمرة. |
alternativePhrases[] |
قد يتم التعرف على بعض العبارات بشكل غير صحيح من خلال نموذج الكلام حتى مع انحياز الكلام. يتيح ذلك لمطوّري البرامج تحديد مشغِّلات بديلة لهواتف المثليين. |
تحديث الطلب
تعديل إلى طلب.
تمثيل JSON | |
---|---|
{ "type": enum ( |
الحقول | |
---|---|
type |
تم الإيقاف: يمكنك استخدام OrderUpdate.update_mask بدلاً من ذلك. إذا كان النوع = SNAPSHOT، يجب أن يكون OrderUpdate.order الطلب بالكامل. إذا كان النوع = ORDER_STATUS، فهذا هو تغيير حالة مستوى الطلب. يتم فقط طلب order.last_update_time وهذه الحالة الرأسية. ملاحظة: لا يتوافق type.ORDER_STATUS إلا مع تحديثات حالة PurcahaseOrderExtension ولا توجد خطة لتمديد هذا الدعم. بدلاً من ذلك، ننصحك باستخدام 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 المُقدّم أو على أي قيمة فريدة أخرى. تجدر الإشارة إلى أن المعرّف المقدّم للمستخدمين هو userUserOrderId، والذي قد يكون قيمة مختلفة وسهلة الاستخدام. الحد الأقصى للطول المسموح به هو 128 حرفًا. |
|
userVisibleOrderId |
رقم تعريف المستخدم الذي يشير إلى الطلب الحالي. ويجب أن يكون هذا المعرّف متوافقًا مع المعرّف المعروض لهذا الطلب في سياقات أخرى، بما في ذلك المواقع الإلكترونية والتطبيقات والبريد الإلكتروني. |
|
userVisibleStateLabel |
مهمل: استخدم حالة OrderExtensions بدلاً من ذلك. تصنيف مرئي للمستخدم لحالة هذا الطلب. |
|
buyerInfo |
معلومات حول المشتري. |
|
image |
الصورة المرتبطة بالطلب. |
|
createTime |
مطلوب: تاريخ إنشاء الطلب ووقته. طابع زمني بتنسيق RFC3339 UTC "Zulu"، مع دقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: |
|
lastUpdateTime |
تاريخ ووقت آخر تعديل للطلب مطلوب لـ OrderUpdate. طابع زمني بتنسيق RFC3339 UTC "Zulu"، مع دقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: |
|
transactionMerchant |
التاجر الذي سهّل عملية الدفع. يمكن أن يختلف هذا عن مقدّم مستوى العنصر. مثال: طلب Expedia مع بند من ANA. |
|
contents |
مطلوبة: محتويات الطلب وهي عبارة عن مجموعة من البنود. |
|
priceAttributes[] |
السعر والخصومات والضرائب وما إلى ذلك. |
|
followUpActions[] |
إجراءات المتابعة على مستوى الطلب. |
|
paymentData |
البيانات المرتبطة بالدفع الخاصة بالطلب |
|
termsOfServiceUrl |
رابط إلى بنود الخدمة التي تنطبق على الطلب/الطلب المقترح. |
|
note |
ملاحظات مرفقة بطلب. |
|
promotions[] |
جميع العروض الترويجية المرتبطة بهذا الطلب. |
|
disclosures[] |
الإفصاحات المرتبطة بهذا الطلب. |
|
vertical |
مهمل: استخدم مواضع إعلان بدلاً من ذلك. سيتم تطبيق هذه الخصائص على جميع العناصر، ما لم يتم إلغاؤها في بعض العناصر. ويجب أن يتطابق هذا القطاع مع نوع موضع الإعلان على مستوى العنصر. القيم المحتملة: كائن يحتوي على حقول من نوع عشوائي. يحتوي الحقل الإضافي |
|
حقل الاتحاد verticals . سيتم تطبيق هذه الخصائص على جميع العناصر، ما لم يتم إلغاؤها في بعض العناصر. ويجب أن يتطابق هذا القطاع مع نوع موضع الإعلان على مستوى العنصر. يمكن أن يكون verticals واحدًا مما يلي فقط: |
||
purchase |
طلب الشراء |
|
ticket |
طلب تذكرة |
معلومات المستخدم
معلومات حول المستخدم. يُستخدَم هذا الإذن لتمثيل معلومات المستخدم المرتبط بطلب.
تمثيل JSON | |
---|---|
{
"email": string,
"firstName": string,
"lastName": string,
"displayName": string,
"phoneNumbers": [
{
object ( |
الحقول | |
---|---|
email |
البريد الإلكتروني للمستخدم، على سبيل المثال: janedoe@gmail.com. |
firstName |
الاسم الأول للمستخدم. |
lastName |
اسم العائلة للمستخدم. |
displayName |
قد يكون الاسم المعروض للمستخدم مختلفًا عن الاسم الأول أو اسم العائلة. |
phoneNumbers[] |
أرقام هواتف المستخدم. |
PhoneNumber
تمثيل رقم الهاتف القياسي.
تمثيل JSON | |
---|---|
{ "e164PhoneNumber": string, "extension": string, "preferredDomesticCarrierCode": string } |
الحقول | |
---|---|
e164PhoneNumber |
رقم الهاتف بتنسيق E.164، كما تم تعريفه في الاتحاد الدولي للاتصالات (ITU)، مقترح E.164. رابط wiki: https://en.wikipedia.org/wiki/E.164 |
extension |
لا يتم توحيد الإضافة في توصيات الاتحاد الدولي للاتصالات، باستثناء أن يتم تحديدها كسلسلة من الأرقام يبلغ الحد الأقصى لطولها 40 رقمًا. ويتم تعريفه كسلسلة هنا لاستيعاب الاستخدام المحتمل لصفر بادئ في الإضافة (تتمتع المؤسسات بحرية كاملة لإجراء ذلك، لأنه لا يوجد معيار محدد). بخلاف الأرقام، قد يتم تخزين بعض أحرف الاتصال الأخرى مثل "," (مما يشير إلى الانتظار) هنا. على سبيل المثال، في xxx-xxx-xxxx الملحق 123، فإن "123" هي الامتداد. |
preferredDomesticCarrierCode |
رمز تحديد مشغل شبكة الجوال المفضل عند الاتصال برقم الهاتف هذا محليًا. ويشمل ذلك أيضًا الرموز التي يلزم طلبها في بعض البلدان عند الاتصال من الخطوط الأرضية إلى الهواتف الجوّالة أو العكس. على سبيل المثال، في كولومبيا، يجب طلب الرقم "3" قبل رقم الهاتف نفسه عند الاتصال من هاتف جوّال إلى هاتف أرضي محلي والعكس صحيح. https://en.wikipedia.org/wiki/Phone_numbers_in_كولومبيا 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 مع واجهة برمجة تطبيقات الأماكن لجلب تفاصيل المكان. يُرجى الاطِّلاع على https://developers.google.com/places/web-service/place-id |
خط الطول والعرض
كائن يمثل زوج خط العرض/خط الطول. يتم التعبير عن هذا كزوج من زوجي لتمثيل الدرجات خط الطول وخط الدرجات بالدرجات. يجب أن يتوافق هذا الكائن مع معيار 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" للصغار والكبيرين). وبهذه الطريقة، يمكن تحديد السطر الأكثر تحديدًا في العنوان استنادًا إلى اللغة. يتكون الحد الأدنى المسموح به للبنية الهيكلية للعنوان من رمز المنطقة مع جميع المعلومات المتبقية الموضوعة في LineLines. سيكون من الممكن تنسيق هذا العنوان إلى حد كبير جدًا بدون ترميز جغرافي، ولكن لا يمكن إجراء أي سبب دلالي حول أي من مكونات العنوان حتى يتم حله جزئيًا على الأقل. إن إنشاء عنوان يحتوي فقط على رمز المنطقة وسطر العناوين، ثم الترميز الجغرافي هو الطريقة الموصى بها للتعامل مع العناوين غير المنظمة تمامًا (بدلاً من تخمين أجزاء العنوان التي يجب أن تكون مناطق محلية أو مناطق إدارية). |
recipients[] |
اختياريّ. المستلم في العنوان. قد يحتوي هذا الحقل، في ظروف معينة، على معلومات متعددة الأسطر. على سبيل المثال، قد يحتوي على معلومات "الاهتمام". |
organization |
اختياريّ. اسم المؤسسة في العنوان. |
الفهرس
التفاف للعناصر.
تمثيل JSON | |
---|---|
{
"lineItems": [
{
object ( |
الحقول | |
---|---|
lineItems[] |
قائمة عناصر الطلب. يلزم وجود عنصر عنصر واحد على الأقل ومسموح بخمسين كحد أقصى. يجب أن تنتمي جميع العناصر إلى قطاع واحد. |
تفاصيل الإعلان
يحتوي بند واحد على قطاع واحد. يمكن أن يحتوي الطلب أو سلة التسوق على عناصر متعددة لقطاع واحد. يجب تحديد العناصر/الإضافات الفرعية وما إلى ذلك في النماذج الأولية بحسب موضع الإعلان حسب حالات استخدامها. ملاحظة: 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 |
طلبات الحجز، مثل المطعم وقص الشعر وما إلى ذلك |
سمة السعر
سمة السعر لطلب أو بند.
تمثيل JSON | |
---|---|
{ "type": enum ( |
الحقول | ||
---|---|---|
type |
مطلوبة: نوع سمة الأموال. |
|
name |
مطلوبة: عرض المستخدم سلسلة من سمة السعر. ويرسل التاجر هذه اللغة ويترجمها. |
|
id |
اختياري: معرّف العنصر الذي يتوافق معه هذا السعر. |
|
state |
مطلوب: حالة السعر: تقدير في مقابل الفعلية. |
|
taxIncluded |
ما إذا كان السعر يشمل الضريبة |
|
حقل الاتحاد spec . يمثل المبلغ النقدي أو النسبة المئوية بالمللي. يمكن أن يكون spec واحدًا مما يلي فقط: |
||
amount |
المبلغ النقدي |
|
amountMillipercentage |
مواصفات النسبة المئوية، إلى 1/1000 من النسبة المئوية. على سبيل المثال: يتم تمثيل 8.750% على أنها 8750، وتمثل النسب المئوية السلبية خصومات بالنسبة المئوية. جارٍ إيقاف هذا الحقل. يمكنك الإضافة مرة أخرى عند الحاجة إلى حالة استخدام ثابتة. |
النوع
يمثل نوع الأموال.
عمليات التعداد | |
---|---|
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 |
إجراء عبر البريد الإلكتروني. تم إيقاف نوعي البريد الإلكتروني وCALL. يمكن استخدام openUrlAction.url كرقم هاتف أو بريد إلكتروني. |
CALL |
إجراء الحث على الشراء. |
REORDER |
إعادة ترتيب الإجراء. |
REVIEW |
مراجعة إجراء الطلب |
CUSTOMER_SERVICE |
يُرجى التواصل مع خدمة العملاء. |
FIX_ISSUE |
يمكنك الانتقال إلى الموقع الإلكتروني أو التطبيق الخاص بالتاجر لحلّ المشكلة. |
DIRECTION |
رابط الاتجاهات. |
إجراء OpenUrl
لفتح عنوان URL المحدد.
تمثيل JSON | |
---|---|
{ "url": string, "androidApp": { object ( |
الحقول | |
---|---|
url |
حقل عنوان URL الذي قد يكون أيًا مما يلي: - http/https عناوين url لفتح تطبيق مرتبط بتطبيق أو صفحة ويب |
androidApp |
معلومات حول تطبيق Android إذا كان من المتوقع تنفيذ عنوان URL بواسطة تطبيق Android. |
urlTypeHint |
تشير إلى تلميح لنوع عنوان URL. |
تطبيق Android
مواصفات تطبيق Android لقيود تلبية الطلبات
تمثيل JSON | |
---|---|
{
"packageName": string,
"versions": [
{
object ( |
الحقول | |
---|---|
packageName |
اسم الحزمة يجب تحديد اسم الحزمة عند تحديد توصيل الطلب على Android. |
versions[] |
عند تحديد فلاتر متعددة، سيؤدي أي فلتر مطابق إلى تشغيل التطبيق. |
فلتر الإصدار
يجب تضمين 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"> |
بيانات وصفية للإجراء
البيانات الوصفية ذات الصلة لكل إجراء.
تمثيل JSON | |
---|---|
{ "expireTime": string } |
الحقول | |
---|---|
expireTime |
وقت انتهاء صلاحية هذا الإجراء. طابع زمني بتنسيق RFC3339 UTC "Zulu"، مع دقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: |
الإفصاح
الإفصاح عن المنتج أو الخدمة أو السياسة التي قد يتم تقديمها للمستخدم.
تمثيل JSON | |
---|---|
{ "title": string, "disclosureText": { object ( |
الحقول | |
---|---|
title |
عنوان مستند الإفصاح. مثال: "معلومات الأمان". |
disclosureText |
محتوى مستند الإفشاء. روابط الويب مسموح بها. |
presentationOptions |
خيارات العرض التقديمي للإفصاح. |
نص الإفصاح
يمثل نصًا عاديًا مع روابط ويب.
تمثيل JSON | |
---|---|
{
"template": string,
"textLinks": [
{
object ( |
الحقول | |
---|---|
template |
نص للعرض، يحتوي على عناصر نائبة مثل "{0}" و"{1}" لكل رابط نصي يجب إدراجه. مثال: "تحذير: قد يعرضك هذا المنتج لمواد كيميائية معروفة في ولاية كاليفورنيا بأنها مسبّبة للسرطان. لمزيد من المعلومات، انتقل إلى {0}." يجب ألا يحتوي نص الإفصاح هذا على أي محتوى ترويجي أو مماثل للإعلان. |
textLinks[] |
الروابط النصية التي يجب استبدالها في النموذج. سيتم استبدال الأول بـ "{0}" في سلسلة النموذج، والثاني لـ "{1}"، وهكذا. |
رابط نصي
رابط نصي يجب استبداله بالنموذج.
تمثيل JSON | |
---|---|
{ "displayText": string, "url": string } |
الحقول | |
---|---|
displayText |
النص الذي يجب عرضه للمستخدمين. |
url |
عنوان URL الذي يجب توجيه المستخدمين إليه عند تفعيل الرابط. |
خيارات عرض الإفصاح
خيارات تقديم مستند الإفشاء.
تمثيل JSON | |
---|---|
{
"presentationRequirement": enum ( |
الحقول | |
---|---|
presentationRequirement |
شرط العرض التقديمي لبيان الإفصاح. |
initiallyExpanded |
ما إذا كان يجب توسيع محتوى مستند الإفشاء في البداية أم لا. وبشكل افتراضي، يتم تصغيرها مبدئيًا. |
متطلبات العرض التقديمي
متطلبات تقديم مستند الإفشاء.
عمليات التعداد | |
---|---|
REQUIREMENT_UNSPECIFIED |
شرط غير محدد. يجب عدم تحديد ذلك صراحةً. |
REQUIREMENT_OPTIONAL |
الإفصاح اختياري. ويمكن تخطيها إذا كان الجهاز لا يتيح عرض بيانات الإفصاح. |
REQUIREMENT_REQUIRED |
الإفصاح مطلوب. سيتم إرسال المحادثة إلى الهاتف إذا كان الجهاز لا يتيح عرض بيانات الإفصاح. |
إضافة العنصر
محتوى العنصر لقطاع الشراء.
تمثيل JSON | |
---|---|
{ "status": enum ( |
الحقول | |
---|---|
status |
مطلوب: حالة مستوى العنصر. |
userVisibleStatusLabel |
مطلوب: تصنيف/سلسلة مرئية للمستخدم للحالة. الحد الأقصى للطول المسموح به هو 50 حرفًا. |
type |
مطلوب: نوع الشراء. |
productId |
معرّف المنتج أو العرض المرتبط بهذا العنصر. |
quantity |
كمية السلعة |
unitMeasure |
قياس الوحدة. لتحديد حجم العنصر في الوحدات المختارة. ويتم استخدام الحجم والسعر النشط لتحديد سعر الوحدة. |
returnsInfo |
لعرض معلومات لهذا العنصر. في حال ترك السياسة بدون ضبط، سيكتسب هذا العنصر معلومات المرتجعات على مستوى الطلب. |
fulfillmentInfo |
معلومات استيفاء هذا العنصر. في حال ترك السياسة بدون ضبط، سيكتسب هذا العنصر معلومات توصيل الطلبات. |
itemOptions[] |
إضافات أو عناصر فرعية إضافية. |
productDetails |
تفاصيل المنتج. |
extension |
أي حقول إضافية يتم تبادلها بين التاجر وGoogle ملاحظة: لا يُنصح باستخدام هذه الإضافة بشدة. بناءً على حالة الاستخدام/الظروف، فكّر في واحد مما يلي: 1- حدّد الحقول في PurchaseItemExtension إذا كان من الممكن استخدامها لحالات استخدام أخرى (أي إمكانية/وظائف عامة). 2- يمكنك استخدام vertical_extension إذا كانت مُحدَّدة لحالة استخدام/ميزة مخصّصة غير عامة. كائن يحتوي على حقول من نوع عشوائي. يحتوي الحقل الإضافي |
حالة الشراء
حالة الشراء المرتبطة بطلب شراء أو بند معيّن.
عمليات التعداد | |
---|---|
PURCHASE_STATUS_UNSPECIFIED |
لم يتم تحديد الحالة. |
READY_FOR_PICKUP |
جاهز للاستلام. |
SHIPPED |
تم الشحن. |
DELIVERED |
تم التسليم. |
OUT_OF_STOCK |
غير متوفّر. |
IN_PREPARATION |
يمكن أن يكون لـ "IN_PREPARATION" معانٍ مختلفة في سياق مختلف. بالنسبة إلى طلب الطعام، قد يكون الطعام قيد التحضير. بالنسبة إلى البيع بالتجزئة، يمكن أن يكون العنصر موضوعًا في حزمة. |
CREATED |
تم إنشاء الطلب. |
CONFIRMED |
أكّد التاجر الطلب. |
REJECTED |
رفض التاجر الطلب أو العنصر. |
RETURNED |
تم إرجاع العنصر بواسطة المستخدم. |
CANCELLED |
تم إلغاء الطلب أو العنصر بواسطة المستخدم. |
CHANGE_REQUESTED |
لقد طلب المستخدم إجراء تغيير على الطلب، وتقوم الشركة المختصة بعملية التكامل بهذا التغيير. ويجب نقل الطلب إلى حالة أخرى بعد معالجة الطلب. |
نوع الشراء
فئة الشراء.
عمليات التعداد | |
---|---|
PURCHASE_TYPE_UNSPECIFIED |
قيمة غير معروفة. |
RETAIL |
ويشمل ذلك عمليات الشراء مثل السلع المادية. |
FOOD |
ويشمل ذلك شراء طلبات الطعام. |
GROCERY |
شراء البقالة. |
MOBILE_RECHARGE |
شراء رصيد هاتف جوّال مسبق الدفع. |
وحدة القياس الخاصة بالتاجر
مقياس تسعير وحدات التجّار.
تمثيل JSON | |
---|---|
{
"measure": number,
"unit": enum ( |
الحقول | |
---|---|
measure |
القيمة: المثال 1.2. |
unit |
الوحدة: Example POUND، GRAM. |
الوحدة
عمليات التعداد | |
---|---|
UNIT_UNSPECIFIED |
الوحدة غير محددة. |
MILLIGRAM |
مليغرام. |
GRAM |
غرام. |
KILOGRAM |
كيلوغرام. |
OUNCE |
أونْس |
POUND |
رطل. |
معلومات إرجاع المشتريات
لعرض معلومات مرتبطة بطلب أو ببند معين.
تمثيل JSON | |
---|---|
{ "isReturnable": boolean, "daysToReturn": integer, "policyUrl": string } |
الحقول | |
---|---|
isReturnable |
في حال التعيين على "true"، يتم السماح بالإرجاع. |
daysToReturn |
يُسمح بإرجاع السلع خلال هذه الأيام العديدة. |
policyUrl |
رابط ينقل إلى سياسة الإرجاع |
معلومات شراء تلبية الطلبات
معلومات توصيل الطلب المرتبطة بطلب الشراء أو تفاصيل معيّنة
تمثيل JSON | |
---|---|
{ "id": string, "fulfillmentType": enum ( |
الحقول | |
---|---|
id |
المعرّف الفريد لخيار الخدمة هذا. |
fulfillmentType |
مطلوب: نوع توصيل الطلب. |
expectedFulfillmentTime |
نافذة في حال تحديد نطاق زمني أو الوقت المقدر للوصول في حال تحديد وقت واحد. الوقت المتوقّع للتسليم أو الاستلام. |
expectedPreparationTime |
نافذة في حال تحديد نطاق زمني أو الوقت المقدر للوصول في حال تحديد وقت واحد. الوقت المتوقع لإعداد الطعام. يُفضل مرة واحدة فقط. |
location |
مكان الاستلام أو مكان التسليم. |
expireTime |
وقت انتهاء صلاحية خيار تنفيذ الطلب هذا. طابع زمني بتنسيق RFC3339 UTC "Zulu"، مع دقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: |
price |
تكلفة هذا الخيار. |
fulfillmentContact |
جهة اتصال المستخدم لتنفيذ هذه العملية. |
shippingMethodName |
اسم طريقة الشحن التي اختارها المستخدم. |
storeCode |
رمز المتجر للموقع. مثال: Walmart هو التاجر ورمز المتجر هو متجر 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 لجميع التنسيقات المتوافقة. |
معلومات استلام الطلب
تفاصيل حول طريقة استلام الطلب وهو يتضمن تفاصيل مثل نوع الاستلام والبيانات الوصفية الإضافية المرفقة بكل نوع، إن وُجدت.
تمثيل JSON | |
---|---|
{ "pickupType": enum ( |
الحقول | |
---|---|
pickupType |
طريقة الاستلام، مثل INSTORE أو CURBSIDE أو غير ذلك |
curbsideInfo |
التفاصيل المتعلقة بمعلومات الرصيف. إذا كان pickupType ليس "CURBSIDE"، سيتم تجاهل هذا الحقل. |
checkInInfo[] |
قائمة بالطرق المختلفة التي يوفرها الشريك لدعم تسجيل الوصول. |
نوع الركوب
قائمة بأنواع الاستلام المسموح بها.
عمليات التعداد | |
---|---|
UNSPECIFIED |
لم يتم تحديد نوع وسيلة النقل. |
INSTORE |
يمكنك استلام الطعام من داخل المطعم. |
CURBSIDE |
ركن المركبة في مكان مخصص خارج المطعم وسيتولى شخص ما توصيل الطعام إليه. |
معلومات الإيصال إلى السيارة
تفاصيل حول كيفية تسهيل عملية الإيصال إلى السيارة
تمثيل JSON | |
---|---|
{ "curbsideFulfillmentType": enum ( |
الحقول | |
---|---|
curbsideFulfillmentType |
يحتاج الشركاء إلى معلومات إضافية لتسهيل طلبات الاستلام من السيارة. استنادًا إلى نوع التنفيذ الذي تم اختياره، سيتم جمع التفاصيل ذات الصلة من المستخدم. |
userVehicle |
تفاصيل المركبة الخاصة بالمستخدم الذي قدّم الطلب |
نوع الإيصال إلى السيارة
القيم المحتملة لأنواع خدمات الإيصال إلى السيارة
عمليات التعداد | |
---|---|
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. اختياريّ. |
معلومات CheckIn
البيانات الوصفية التي يطلبها الشريك لإتاحة طريقة تسجيل الوصول
تمثيل JSON | |
---|---|
{
"checkInType": enum ( |
الحقول | |
---|---|
checkInType |
الطريقة المستخدمة لإرسال تعليمات تسجيل الوصول. |
نوع تسجيل الدخول
الطرق المختلفة المستخدمة لإرسال تعليمات تسجيل الوصول.
عمليات التعداد | |
---|---|
CHECK_IN_TYPE_UNSPECIFIED |
قيمة غير معروفة. |
EMAIL |
سيتم إرسال معلومات تسجيل الوصول عبر البريد الإلكتروني. |
SMS |
سيتم إرسال معلومات تسجيل الوصول عبر الرسائل القصيرة SMS. |
خيار العنصر
يمثل الإضافات أو العناصر الفرعية.
تمثيل JSON | |
---|---|
{ "id": string, "name": string, "prices": [ { object ( |
الحقول | |
---|---|
id |
بالنسبة إلى الخيارات التي تمثّل عناصر، معرّف سلعة فريد. |
name |
اسم الخيار. |
prices[] |
السعر الإجمالي للخيار. |
note |
ملاحظة ذات صلة بالخيار |
quantity |
بالنسبة إلى الخيارات التي تتمثل في السلع والكمية |
productId |
معرّف المنتج أو العرض المرتبط بهذا الخيار. |
subOptions[] |
لتحديد خيارات فرعية متداخلة أخرى. |
تفاصيل المنتج
تفاصيل المنتج.
تمثيل JSON | |
---|---|
{ "productId": string, "gtin": string, "plu": string, "productType": string, "productAttributes": { string: string, ... } } |
الحقول | |
---|---|
productId |
معرّف المنتج أو العرض المرتبط بهذا العنصر. |
gtin |
رقم السلعة التجاري العالمي للمنتج ويكون ذلك مفيدًا في حال عدم توفّر معرّف العرض في Merchant Center. اختياريّ. |
plu |
إن رموز البحث عن الأسعار، والتي يُطلق عليها عادةً رموز PLU أو أرقام PLU أو PLU أو رموز المنتجات أو تصنيفات المنتجات، هي نظام للأرقام التي تعرّف بشكل فريد المنتجات المجمّعة التي يتم بيعها في متاجر البقالة والسوبرماركت. |
productType |
فئة المنتج التي حدّدها التاجر على سبيل المثال "الصفحة الرئيسية > البقالة > منتجات الألبان والبيض > الحليب > الحليب الكامل الدسم" |
productAttributes |
التفاصيل التي يقدّمها التاجر عن المنتج، مثل { "allergen": "peanut" }، ويُعدّ ذلك مفيدًا في حال عدم توفّر promotionId في Merchant Center اختياريّ. كائن يحتوي على قائمة بأزواج |
ItemItemExtension
محتويات العنصر لطلبات الحجز مثل المطعم، أو قص الشعر، وما إلى ذلك
تمثيل JSON | |
---|---|
{ "status": enum ( |
الحقول | |
---|---|
status |
مطلوب: حالة الحجز. |
userVisibleStatusLabel |
مطلوب: تصنيف/سلسلة مرئية للمستخدم للحالة. الحد الأقصى للطول المسموح به هو 50 حرفًا. |
type |
نوع الحجز. قد يتم إلغاء ضبطها إذا لم يكن أي من خيارات النوع ساريًا. |
reservationTime |
الوقت الذي تمت جدولة الخدمة/الحدث فيه. يمكن أن يكون نطاقًا زمنيًا أو تاريخًا أو وقتًا زمنيًا محددًا. |
userAcceptableTimeRange |
النطاق الزمني المقبول للمستخدم. |
confirmationCode |
رمز التأكيد لهذا الحجز. |
partySize |
عدد الأشخاص. |
staffFacilitators[] |
منسّقو الاجتماعات الذين سيتولون خدمة الحجز. مثال مصفف الشعر. |
location |
موقع الخدمة/الحدث. |
حالة الحجز
حالة الحجز.
عمليات التعداد | |
---|---|
RESERVATION_STATUS_UNSPECIFIED |
حالة غير محدّدة |
PENDING |
الحجز معلّق. |
CONFIRMED |
تم تأكيد الحجز. |
CANCELLED |
تم إلغاء الحجز من قِبل المستخدم. |
FULFILLED |
يتم تنفيذ الحجز. |
CHANGE_REQUESTED |
طلب الحجز |
REJECTED |
انتهت صلاحية الحجز أو تم رفضه من قِبل عملية الدمج. |
نوع الحجز
نوع الحجز.
عمليات التعداد | |
---|---|
RESERVATION_TYPE_UNSPECIFIED |
نوع غير محدد. |
RESTAURANT |
الحجز في المطعم. |
HAIRDRESSER |
حجز لمصفِّف شعر. |
مسؤول الجلسة
معلومات عن الشخص المختصّ بالخدمة
تمثيل JSON | |
---|---|
{
"name": string,
"image": {
object ( |
الحقول | |
---|---|
name |
اسم مسؤول الجلسة. مثال "سامح رضا" |
image |
صور المؤدي. |
بيانات الدفع
بيانات الدفع المرتبطة بطلب
تمثيل JSON | |
---|---|
{ "paymentResult": { object ( |
الحقول | |
---|---|
paymentResult |
نتيجة الدفع التي تستخدمها جهة التكامل لإتمام المعاملة. ستتم تعبئة هذا الحقل من خلال "المهام مع مساعد Google" في حال إدارة تجربة الدفع من خلال "المهام مع مساعد Google". |
paymentInfo |
معلومات الدفع المتعلقة بالطلب والتي تفيد في التفاعل مع المستخدم. |
نتيجة الدفع
نتيجة الدفع التي تستخدمها شركة التكامل لإتمام المعاملة.
تمثيل 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 |
طريقة الدفع المقدمة من التاجر/الإجراء التي اختارها المستخدم. |
معلومات الدفع
معلومات الدفع المتعلقة بالطلب المُقدَّم. يلتقط هذا النموذج الأولي معلومات مفيدة للتفاعل الذي يواجهه المستخدم.
تمثيل JSON | |
---|---|
{ "paymentMethodDisplayInfo": { object ( |
الحقول | |
---|---|
paymentMethodDisplayInfo |
يعرض هذا العمود معلومات طريقة الدفع المستخدَمة في المعاملة. |
paymentMethodProvenance |
مصدر طريقة الدفع المستخدمة في المعاملة. يمكن أن يكون المستخدم قد سجّل طريقة الدفع نفسها في كل من Google وMerchant. |
معلومات طريقة الدفع
نتيجة الدفع التي تستخدمها شركة التكامل لإتمام المعاملة.
تمثيل JSON | |
---|---|
{
"paymentType": enum ( |
الحقول | |
---|---|
paymentType |
نوع الدفعة. |
paymentMethodDisplayName |
الاسم الذي يظهر للمستخدم لطريقة الدفع. على سبيل المثال، VISA **** 1234 جارٍ التحقق من الحساب **** 5678 |
paymentMethodVoiceName |
اسم طريقة الدفع لنطقه للمستخدم على الأجهزة المزوّدة بخدمة "مساعد Google" بالصوت فقط. على سبيل المثال: "التأشيرة تنتهي بواحد أو اثنين أو أربعة" أو "جارٍ التحقق من الحساب الذي ينتهي بخمسة وستة وثمانية". ملاحظة: هذه هي السلسلة المحسَّنة للصوت التي سيتم استخدامها بدلاً من paymentMethodDisplayName في الأجهزة المزوّدة بخدمة المساعد الصوتي فقط. وإذا لم يتم ضبط هذه السلسلة، سيتم نطق PaymentMethodDisplayName للمستخدم بدلاً من ذلك. |
طريقة الدفع
تشير PaymentType إلى طريقة الدفع المستخدمة في طريقة الدفع التي يوفرها التاجر. يجب أيضًا أن يتضمّن الإجراء اسم عرض لطريقة الدفع.
عمليات التعداد | |
---|---|
PAYMENT_TYPE_UNSPECIFIED |
طريقة دفع غير محدّدة |
PAYMENT_CARD |
بطاقة ائتمان/خصم مباشر أو بطاقة دفع مسبق. |
BANK |
طريقة الدفع هي حساب مصرفي. |
LOYALTY_PROGRAM |
إنّ طريقة الدفع هي برنامج ولاء. |
CASH |
طريقة الدفع نقدًا |
GIFT_CARD |
طريقة الدفع هي بطاقة هدايا. |
WALLET |
محفظة تابعة لجهة خارجية، مثل Paypal |
مصدر طريقة الدفع
تمثّل هذه الخاصية مصدر طريقة الدفع المستخدَم في المعاملة.
عمليات التعداد | |
---|---|
PAYMENT_METHOD_PROVENANCE_UNSPECIFIED |
الأصل غير محدد. |
PAYMENT_METHOD_PROVENANCE_GOOGLE |
المصدر هو Google. |
PAYMENT_METHOD_PROVENANCE_MERCHANT |
المصدر هو التاجر. |
الترويج
العروض الترويجية/العروض التي تمت إضافتها إلى سلة التسوّق
تمثيل JSON | |
---|---|
{ "coupon": string } |
الحقول | |
---|---|
coupon |
مطلوب: تم تطبيق رمز القسيمة على هذا العرض. |
إضافة طلب الشراء
امتداد الطلب لقطاع الشراء. تسري هذه الخصائص على جميع العناصر الموجودة داخل الطلب، ما لم يتم تجاوزها في عنصر السطر.
تمثيل JSON | |
---|---|
{ "status": enum ( |
الحقول | |
---|---|
status |
مطلوب: الحالة العامة للطلب. |
userVisibleStatusLabel |
تصنيف/سلسلة مرئية للمستخدم للحالة. الحد الأقصى للطول المسموح به هو 50 حرفًا. |
type |
مطلوب: نوع الشراء. |
returnsInfo |
إرجاع معلومات الطلب |
fulfillmentInfo |
معلومات توصيل الطلب |
purchaseLocationType |
موقع عملية الشراء (في المتجر / على الإنترنت) |
errors[] |
اختياري: حدثت أخطاء بسبب رفض هذا الطلب. |
extension |
أي حقول إضافية يتم تبادلها بين التاجر وGoogle ملاحظة: لا يُنصح باستخدام هذه الإضافة بشدة. بناءً على حالة الاستخدام/الظروف، فكّر في واحد مما يلي: 1- حدّد الحقول في PurchaseOrderExtension إذا كان يمكن استخدامها لحالات استخدام أخرى (أي إمكانية/وظائف عامة). 2- يمكنك استخدام vertical_extension إذا كانت مُحدَّدة لحالة استخدام/ميزة مخصّصة غير عامة. كائن يحتوي على حقول من نوع عشوائي. يحتوي الحقل الإضافي |
نوع موقع الشراء
موقع عملية الشراء.
عمليات التعداد | |
---|---|
UNSPECIFIED_LOCATION |
قيمة غير معروفة. |
ONLINE_PURCHASE |
جميع عمليات الشراء التي تم شراؤها على الإنترنت. |
INSTORE_PURCHASE |
جميع عمليات الشراء في المتجر. |
خطأ في الشراء
الأخطاء التي يمكن رفض طلب شراء لها
تمثيل JSON | |
---|---|
{ "type": enum ( |
الحقول | |
---|---|
type |
مطلوب: يمثل ذلك السبب الدقيق وراء رفض التاجر للطلب. |
description |
وصف إضافي للخطأ. |
entityId |
رقم تعريف الكيان الذي يتوافق مع الخطأ. مثال: يمكن أن يتطابق ذلك مع LineItemId / ItemOptionId. |
updatedPrice |
ينطبق على نوع الخطأ PRICE_CHANGED / INCORRECT_PRICE. |
availableQuantity |
الكمية المتاحة الآن. سارٍ في حالة AVAILABILITY_CHANGED. |
نوع الخطأ
أنواع الأخطاء المحتملة.
عمليات التعداد | |
---|---|
ERROR_TYPE_UNSPECIFIED |
خطأ غير معروف |
NOT_FOUND |
لم يتم العثور على الكيان، ويمكن أن تكون السلعة أو FulfillmentOption أو العرض الترويجي. رقم تعريف الكيان مطلوب. |
INVALID |
بيانات الكيان غير صالحة. يمكن أن تكون السلعة أو FulfillmentOption أو Promotion. رقم تعريف الكيان مطلوب. |
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 بحساب على نظامه، ولكن حدث خطأ أثناء إجراء ذلك. |
طلب إضافة التذكرة
محتويات الطلب لطلبات التذاكر، مثل الأفلام والرياضة وغيرها
تمثيل JSON | |
---|---|
{
"ticketEvent": {
object ( |
الحقول | |
---|---|
ticketEvent |
تم تطبيق الحدث على جميع تذاكر العناصر. |
حدث التذكرة
يمثل حدثًا واحدًا.
تمثيل JSON | |
---|---|
{ "type": enum ( |
الحقول | |
---|---|
type |
مطلوب: نوع حدث التذكرة، على سبيل المثال، فيلم، حفلة موسيقية. |
name |
مطلوب: اسم الحدث. على سبيل المثال، إذا كان الحدث عبارة عن فيلم، فيجب أن يكون هذا اسم الفيلم. |
description |
تمثّل هذه السمة وصف الفعالية. |
url |
عنوان URL لمعلومات الحدث. |
location |
الموقع الجغرافي الذي يقع فيه الحدث أو المؤسسة |
eventCharacters[] |
الأحرف ذات الصلة بهذا الحدث. ويمكن أن تكون مخرجًا أو ممثلاً لحدث فيلم أو فنانًا لحفلة موسيقية وغير ذلك. |
startDate |
وقت البدء |
endDate |
وقت الانتهاء |
doorTime |
وقت الإدخال، والذي قد يختلف عن وقت بدء الحدث. على سبيل المثال، يبدأ الحدث في الساعة 9 صباحًا، ولكن وقت الدخول هو 8:30 صباحًا. |
النوع
نوع الحدث.
عمليات التعداد | |
---|---|
EVENT_TYPE_UNKNOWN |
نوع الحدث غير معروف. |
MOVIE |
فيلم. |
CONCERT |
حفلة موسيقية. |
SPORTS |
الرياضة. |
حرف الحدث
حرف حدث واحد، مثل المنظِّم أو المؤدي أو غير ذلك
تمثيل JSON | |
---|---|
{ "type": enum ( |
الحقول | |
---|---|
type |
نوع حرف الحدث، مثل الممثل أو المخرج. |
name |
اسم الحرف. |
image |
صور الشخصية. |
النوع
نوع الحرف.
عمليات التعداد | |
---|---|
TYPE_UNKNOWN |
نوع غير معروف. |
ACTOR |
المُنفِّذ |
PERFORMER |
المؤدي. |
DIRECTOR |
المخرِج |
ORGANIZER |
المنظِّم. |
إشعار المستخدم
إشعار اختياري من المستخدم لعرضه كجزء من تعديل الطلب.
تمثيل JSON | |
---|---|
{ "title": string, "text": string } |
الحقول | |
---|---|
title |
عنوان إشعار المستخدم. الحد الأقصى للطول المسموح به هو 30 حرفًا. |
text |
محتويات الإشعار. الحد الأقصى للطول المسموح به هو 100 حرف. |
المشهد التالي
يمثّل المشهد المطلوب تنفيذه بعد ذلك.
تمثيل 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. وقد يختلف هذا عن لغة المستخدم إذا كان الإجراء يستخدم ميزات متعددة اللغات. على سبيل المثال، عند تعيين Wizard_response.language_code، يتم تغيير لغة المحادثة لكل المنعطفات التالية، وسينعكس ذلك في هذا الحقل. |
تجاوز النوع
تمثل تجاوزًا لنوع ما.
تمثيل JSON | |
---|---|
{ "name": string, "mode": enum ( |
الحقول | |
---|---|
name |
مطلوبة. اسم النوع المكمّل أو الملغي. |
mode |
مطلوبة. كيفية دمج هذا النوع مع قيم الأنواع الأخرى. |
synonym |
|
TypeOverrideMode
أنواع التعديلات لنوع كيان الجلسة.
عمليات التعداد | |
---|---|
TYPE_UNSPECIFIED |
غير محدد. ويجب عدم استخدام هذه القيمة مطلقًا. |
TYPE_REPLACE |
وستحل تعريفات الأنواع في هذه الاستجابة محل تعريفات النوع التي سبق تعريفها. |
TYPE_MERGE |
سيتم دمج تعريفات النوع في هذه الاستجابة مع تعريفات الأنواع التي تم تحديدها سابقًا. ستحل تعريفات الأنواع الجديدة محل تعريفات الأنواع الحالية. |
نوع المرادفات
يمثل نوعًا مع مرادفات.
تمثيل JSON | |
---|---|
{
"entries": [
{
object ( |
الحقول | |
---|---|
entries[] |
مطلوبة. قائمة إدخالات نوع المرادفات. |
تذكرة الدخول
يمثل إدخالاً لنوع المرادفات.
تمثيل JSON | |
---|---|
{
"name": string,
"synonyms": [
string
],
"display": {
object ( |
الحقول | |
---|---|
name |
مطلوبة. اسم الإدخال (مثل "دراجة"). يجب تضمين الإدخال في هذا الحقل في حقل المرادفات المتكررة حتى يتم التعرُّف عليه كقيمة صالحة للنوع. |
synonyms[] |
مطلوبة. قائمة المرادفات للإدخال (مثل "دراجة" أو "دورة"). |
display |
اختياريّ. معلومات عرض السلعة. |
شاشة الإدخال
تمثيل 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 "Zulu"، مع دقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: |
engagement |
تفاعل المستخدم الحالي، بما في ذلك أي اشتراكات في الأهداف. |
packageEntitlements[] |
استحقاقات المستخدم ذات الصلة بحزمة Android المرتبطة بالإجراء الحالي. |
permissions[] |
يحتوي على الأذونات التي منحها المستخدم إلى هذا الإجراء. |
حالة ربط الحساب
تشير إلى ما إذا كان المستخدم قد ربط حسابه بهذا التطبيق. راجع مستندات ربط الحساب: https://developers.google.com/assistant/identity.
عمليات التعداد | |
---|---|
ACCOUNT_LINKING_STATUS_UNSPECIFIED |
غير معروف. |
NOT_LINKED |
لم يربط المستخدم حسابه بهذا التطبيق. |
LINKED |
ربط المستخدم حسابه بهذا التطبيق. |
حالة التحقق من المستخدم
يشير إلى ما إذا كانت Google قد تحققت من المستخدم. تشير الحالة "تم التحقق" إلى أنه يمكنك حفظ البيانات عبر المحادثات باستخدام حقل المعلمات أو باستخدام ربط الحساب.
عمليات التعداد | |
---|---|
USER_VERIFICATION_STATUS_UNSPECIFIED |
غير معروف. |
GUEST |
مستخدم ضيف. |
VERIFIED |
مستخدم معتمد. |
التفاعل
يوفر معلومات إضافية للقراءة فقط حول آليات التفاعل التي سجّل المستخدم الحالي للحصول عليها. على سبيل المثال، قد يكون من المفيد معرفة الأهداف التي اشترك فيها المستخدم من أجل تجنّب مطالبته بالاشتراك في الهدف نفسه مرة أخرى. على سبيل المثال، يمكن استخدام هذه المعلومات لتوجيه المشاهد بشكل مشروط إلى مشهد لإعداد التحديثات اليومية أو الإشعارات الفورية فقط في حال لم يسبق للمستخدم الاشتراك. اطّلع على مستندات تفاعل المستخدمين: https://developers.google.com/assistant/engagement.
تمثيل JSON | |
---|---|
{ "pushNotificationIntents": [ { object ( |
الحقول | |
---|---|
pushNotificationIntents[] |
يحتوي على قائمة بالأهداف التي فعَّل المستخدم إشعار الدفع لها. |
dailyUpdateIntents[] |
يحتوي على قائمة بالأهداف التي فعَّل المستخدم التحديث اليومي لها. |
اشتراك Intent
وصف اشتراك حالي في Intent
تمثيل JSON | |
---|---|
{ "intent": string, "contentTitle": string } |
الحقول | |
---|---|
intent |
اسم الهدف من الاشتراك. |
contentTitle |
وصف قصير للاشتراك. ويتم استخدامه كتصنيف للإشعار وعندما يطلب "مساعد Google" إذنًا من المستخدم. |
استحقاقات الحِزم
قائمة بتخويلات المستخدم ذات الصلة باسم الحزمة يمكنك الاطلاع على مستندات المعاملات الرقمية الجيدة: 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 |
التطبيقات المدفوعة |
البيانات الموقَّعة
تمثيل 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. |
الإذن
القيم المحتملة للإذن
عمليات التعداد | |
---|---|
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" و"locality" فقط. سيؤدي إذن تحديد الموقع الجغرافي الدقيق إلى تعبئة حقول إضافية مثل "administrativeArea" و"addressLines". |
TimeZone
يمثل منطقة زمنية من قاعدة بيانات المناطق الزمنية (IANA).
تمثيل JSON | |
---|---|
{ "id": string, "version": string } |
الحقول | |
---|---|
id |
المنطقة الزمنية لقاعدة بيانات IANA الزمنية، مثل "America/New_York". |
version |
اختياريّ. رقم إصدار قاعدة بيانات المنطقة الزمنية من IANA، مثل "2019a" |
السياق
يحتوي على معلومات سياقية عندما يُجري المستخدم طلب بحث. ويشمل هذا السياق، على سبيل المثال لا الحصر، المعلومات المتعلقة بجلسة الوسائط النشطة، وحالة تطبيق لوحة الرسم على الويب، وما إلى ذلك.
تمثيل JSON | |
---|---|
{ "media": { object ( |
الحقول | |
---|---|
media |
يحتوي على معلومات سياقية عن جلسة الوسائط النشطة الحالية. |
canvas |
يحتوي على معلومات سياقية حول اللوحة الحالية. |
سياق الوسائط
يحتوي على معلومات سياقية عن جلسة الوسائط النشطة الحالية.
تمثيل JSON | |
---|---|
{ "progress": string, "index": integer } |
الحقول | |
---|---|
progress |
تقدم الوسائط لملف الوسائط النشطة حاليًا. عبارة عن مدة بالثواني تحتوي على ما يصل إلى تسعة أرقام كسرية، ويتم إنهاؤها بـ " |
index |
0-الاستناد إلى ملف الوسائط النشطة الحالي في قائمة ملفات الوسائط في استجابة الوسائط. |
لوحة الرسم
يحتوي على معلومات سياقية حول اللوحة الحالية.
تمثيل JSON | |
---|---|
{ "state": value } |
الحقول | |
---|---|
state |
اختياريّ. تم ضبط الحالة بواسطة تطبيق "لوحة الرسم التفاعلية" التابع لطرف ثالث. ويتم ضبط ذلك على الطلب فقط، وليس للاستجابة. على سبيل المثال، إذا كان هذا تطبيق وصفة، يمكن أن تكون الحالة قيمة للبنية : { "current_page" : 5, "last_page" : 3, } الحد الأقصى للحجم هو 50 كيلوبايت. |
القيمة المتوقعة
يصف توقعات المنعطف التالي في مربع الحوار.
تمثيل JSON | |
---|---|
{ "speech": [ string ] } |
الحقول | |
---|---|
speech[] |
قائمة بالعبارات التي يتوقعها الإجراء من كلام المستخدم لانحياز الكلام. يُسمح باستخدام ما يصل إلى 1,000 عبارة. ملاحظة: يحمل هذا الحقل المعنى نفسه كالمدقّقة المتوقَّعة في واجهة برمجة التطبيقات v2 API. |