Method: fulfill

استدعاء إجراء عن بُعد (RPC) الذي يمثل واجهة برمجة التطبيقات المتعلقة بالتنفيذ

طلب HTTP

POST https://webhook_handler_service.googleapis.com/fulfill

يستخدِم عنوان URL بنية تحويل ترميز gRPC.

نص الطلب

يحتوي نص الطلب على بيانات بالبنية التالية:

تمثيل JSON
{
  "handler": {
    object (Handler)
  },
  "intent": {
    object (Intent)
  },
  "scene": {
    object (Scene)
  },
  "session": {
    object (Session)
  },
  "user": {
    object (User)
  },
  "home": {
    object (Home)
  },
  "device": {
    object (Device)
  },
  "context": {
    object (Context)
  }
}
الحقول
handler

object (Handler)

مطلوبة. معلومات التنفيذ حول كيفية معالجة الطلب. على سبيل المثال، قد يتضمّن الطلب الذي يهدف إلى الحصول على حقيقة معالجًا باسم "getFact".

intent

object (Intent)

مطلوبة. تمثل آخر هدف مطابق. يُرجى الاطّلاع على https://developers.google.com/assistant/conversational/intents.

scene

object (Scene)

اختياريّ. معلومات عن المشهد الحالي والمشهد التالي عند استدعاء الدالة. سيتم ملء هذا الحقل عند إجراء طلب التنفيذ ضمن نطاق المشهد. يُرجى الاطّلاع على https://developers.google.com/assistant/conversational/scenes.

session

object (Session)

مطلوبة. يحتفظ ببيانات الجلسات مثل رقم تعريف الجلسة ومعلَمات الجلسة.

user

object (User)

مطلوبة. المستخدم الذي بدأ المحادثة.

home

object (Home)

اختياريّ. معلومات تتعلّق ببنية HomeGraph التي ينتمي إليها الجهاز المستهدَف يمكنك الاطّلاع على https://developers.google.com/actions/smarthome/concepts/homegraph.

device

object (Device)

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

context

object (Context)

اختياريّ. معلومات السياق الحالي للطلب يشمل ذلك، على سبيل المثال لا الحصر، معلومات جلسات الوسائط النشطة أو معلومات اللوحات.

نص الاستجابة

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

ويمثِّل ردًا تم إرساله من تنفيذ مطوّر برامج إلى "المهام مع مساعد Google".

تمثيل JSON
{
  "prompt": {
    object (Prompt)
  },
  "scene": {
    object (Scene)
  },
  "session": {
    object (Session)
  },
  "user": {
    object (User)
  },
  "home": {
    object (Home)
  },
  "device": {
    object (Device)
  },
  "expected": {
    object (Expected)
  }
}
الحقول
prompt

object (Prompt)

اختياريّ. تمثّل هذه السمة رسائل المطالبة التي سيتم إرسالها إلى المستخدم، وستُضاف إلى الرسائل التي سبق أن أضفتها، ما لم يتم استبدالها بشكل صريح.

scene

object (Scene)

اختياريّ. يُمثِّل المشهد الحالي والتالي. إذا تم ضبط Scene.next، سينتقل وقت التشغيل على الفور إلى المشهد المحدد.

session

object (Session)

اختياريّ. يصف بيانات الجلسة الحالية، ويمكن إنشاء مَعلمات الجلسة أو تعديلها أو إزالتها من خلال عملية التنفيذ.

user

object (User)

اختياريّ. استخدِمها لتحديد مَعلمات المستخدمين لإرسالها مرة أخرى.

home

object (Home)

اختياريّ. يتم استخدامه لتحديد المعلَمات ذات الصلة ببنية HomeGraph التي ينتمي إليها الجهاز المستهدَف. يمكنك الاطّلاع على https://developers.google.com/actions/smarthome/concepts/homegraph.

device

object (Device)

اختياريّ. تُستخدم للتنقّل بين الأجهزة المزوّدة بخدمة "مساعد Google" التي يمكن للمستخدم الوصول إليها.

expected

object (Expected)

اختياريّ. يصف التوقعات المتعلقة بالمنعطف التالي في الحوار.

المعالِج

يمثل معالج التنفيذ الذي يربط معلومات الأحداث من "المهام مع مساعد Google" بالتنفيذ. استخدم اسم المعالج لتحديد التعليمة البرمجية التي يجب أن تقوم بتشغيلها في التنفيذ. على سبيل المثال، يمكن استخدام معالج للحصول على معلومات عن معلومات طلب المستخدم باستخدام اسم معالج مثل "OrderLookup"، بينما قد يحصل مستخدم آخر على معلومات المنتج من قاعدة بيانات، مع اسم معالج مثل "GetProductInfo".

تمثيل JSON
{
  "name": string
}
الحقول
name

string

اختياريّ. اسم المعالج.

النيّة بالشراء

يمثل هدفًا. يُرجى الاطّلاع على https://developers.google.com/assistant/conversational/intents.

تمثيل JSON
{
  "name": string,
  "params": {
    string: {
      object (IntentParameterValue)
    },
    ...
  },
  "query": string
}
الحقول
name

string

مطلوبة. اسم آخر هدف مطابق.

params

map (key: string, value: object (IntentParameterValue))

مطلوبة. تمثّل المَعلمات التي تم تحديدها كجزء من مطابقة الهدف. هذه خريطة لاسم المَعلمة المحدّدة بقيمة المَعلمة المحدّدة من البيانات التي أدخلها المستخدم. ستُعرَض هنا جميع المَعلمات المحدّدة في الغرض المطابق والمحدّدة.

عنصر يحتوي على قائمة من أزواج "key": value. مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" }

query

string

اختياريّ. الإدخال المكتوب أو الشفهي من المستخدم النهائي الذي طابق هذا الهدف. وستتم تعبئة هذه البيانات عند مطابقة هدف، استنادًا إلى البيانات التي أدخلها المستخدم.

IntentParameterValue

تُمثِّل قيمةً لمَعلمة الغرض. يمكنك الاطّلاع على https://developers.google.com/assistant/conversational/types.

تمثيل JSON
{
  "original": string,
  "resolved": value
}
الحقول
original

string

مطلوبة. قيمة النص الأصلي المستخلصة من كلام المستخدم.

resolved

value (Value format)

مطلوبة. قيمة منظَّمة للمَعلمة المستخلصة من البيانات التي أدخلها المستخدم لن تتم تعبئة هذا الحقل إلا إذا تم تحديد المَعلمة في الغرض المطابِق وكان من الممكن تحديد قيمة المَعلمة أثناء مطابقة الغرض.

أجواء الإضاءة

تمثيل مشهد. يمكن للمشاهِد طلب تنفيذ الطلب وإضافة الطلبات وجمع قيم الخانات من المستخدم. تبدأ المَشاهِد من خلال الأحداث أو الأغراض ويمكن أن تؤدي إلى تشغيل الأحداث ومطابقة الأهداف للانتقال إلى مشاهد أخرى.

تمثيل JSON
{
  "name": string,
  "slotFillingStatus": enum (SlotFillingStatus),
  "slots": {
    string: {
      object (Slot)
    },
    ...
  },
  "next": {
    object (NextScene)
  }
}
الحقول
name

string

مطلوبة. اسم المشهد الحالي

slotFillingStatus

enum (SlotFillingStatus)

مطلوبة. الحالة الحالية لملء الخانة. هذا الحقل للقراءة فقط.

slots

map (key: string, value: object (Slot))

الخانات المرتبطة بالمشهد الحالي. ولا يمكن لردود المعالِج عرض الخانات التي لم يتم إرسالها في الطلب.

عنصر يحتوي على قائمة من أزواج "key": value. مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" }

next

object (NextScene)

اختياريّ. المعلومات حول المشهد التي سيتم تنفيذها بعد ذلك.

SlotFillingStatus

تُمثِّل هذه السمة الحالة الحالية لملء الخانة.

عمليات التعداد
UNSPECIFIED القيمة الاحتياطية عند عدم تعبئة حقل الاستخدام.
INITIALIZED تم إعداد الخانات ولكن لم يبدأ ملء الخانات.
COLLECTING يجري جمع قيم الخانات.
FINAL جميع قيم الخانات نهائية ولا يمكن تغييرها.

الحيز

يمثّل هذا النوع خانة.

تمثيل JSON
{
  "mode": enum (SlotMode),
  "status": enum (SlotStatus),
  "value": value,
  "updated": boolean,
  "prompt": {
    object (Prompt)
  }
}
الحقول
mode

enum (SlotMode)

وضع الخانة (مطلوب أو اختياري). يمكن ضبطه من قِبل مطوّر البرامج.

status

enum (SlotStatus)

حالة الخانة.

value

value (Value format)

قيمة الخانة. سيؤدي تغيير هذه القيمة في الاستجابة إلى تعديل القيمة في تعبئة الخانة.

updated

boolean

يشير إلى ما إذا كان قد تم جمع قيمة الخانة عند المنعطف الأخير. هذا الحقل للقراءة فقط.

prompt

object (Prompt)

اختياريّ. يتم إرسال هذه المطالبة إلى المستخدم عند الحاجة لملء خانة مطلوبة. تلغي هذه المطالبة الطلب الحالي المحدّد في وحدة التحكّم. لم يتم تضمين هذا الحقل في طلب الرد التلقائي على الويب.

SlotMode

تمثّل هذه السمة وضع الخانة، أي ما إذا كانت مطلوبة أم لا.

عمليات التعداد
MODE_UNSPECIFIED القيمة الاحتياطية عند عدم تعبئة حقل الاستخدام.
OPTIONAL تشير هذه السمة إلى أنّ هذه الفتحة غير مطلوبة لإكمال ملء الخانة.
REQUIRED تشير هذه السمة إلى أنّ المساحة مطلوبة لإكمال ملء الخانة.

SlotStatus

تُمثِّل هذه السمة حالة الخانة.

عمليات التعداد
SLOT_UNSPECIFIED القيمة الاحتياطية عند عدم تعبئة حقل الاستخدام.
EMPTY يشير إلى عدم احتواء الخانة على أي قيم. لا يمكن تعديل هذه الحالة من خلال الردّ.
INVALID يشير إلى أن قيمة الخانة غير صالحة. ويمكن تحديد هذه الحالة من خلال الردّ.
FILLED يشير إلى أن الخانة تتضمن قيمة. لا يمكن تعديل هذه الحالة من خلال الردّ.

سؤال

تمثيل رد لمستخدم. يمكنك الاطّلاع على https://developers.google.com/assistant/conversational/prompts.

تمثيل JSON
{
  "override": boolean,
  "firstSimple": {
    object (Simple)
  },
  "content": {
    object (Content)
  },
  "lastSimple": {
    object (Simple)
  },
  "suggestions": [
    {
      object (Suggestion)
    }
  ],
  "link": {
    object (Link)
  },
  "canvas": {
    object (Canvas)
  },
  "orderUpdate": {
    object (OrderUpdate)
  }
}
الحقول
override

boolean

اختياريّ. وضع لكيفية دمج هذه الرسائل مع الرسائل المحددة مسبقًا يؤدي تحديد الخيار "true" إلى محو جميع الرسائل المحددة مسبقًا (الأولى والأخير، ورابط المحتوى ورابط الاقتراحات، ولوحة الرسم) وإضافة الرسائل المحددة في هذا الطلب. تضيف القيمة "خطأ" الرسائل المحددة في هذا الطلب إلى الرسائل المحددة في الردود السابقة. يؤدي ترك هذا الحقل على "خطأ" أيضًا إلى تفعيل إمكانية إلحاق بعض الحقول داخل "المطالبات البسيطة" ومطالبة "الاقتراحات" ومطالبة "لوحة الرسم" (جزء من مطالبة المحتوى). يتم دائمًا استبدال رسائل المحتوى والرابط إذا تم تحديدها في الطلب. والقيمة التلقائية هي "خطأ".

firstSimple

object (Simple)

اختياريّ. الاستجابة الأولى بالصوت والنص فقط.

content

object (Content)

اختياريّ. محتوى مثل بطاقة أو قائمة أو وسائط يتم عرضها للمستخدم.

lastSimple

object (Simple)

اختياريّ. الرد الأخير بالصوت والنص فقط.

suggestions[]

object (Suggestion)

اختياريّ. الاقتراحات التي يتم عرضها للمستخدم والتي ستظهر دائمًا في نهاية الرد. إذا كان الحقل "إلغاء" في الطلب الذي يتضمّن عبارة "خطأ"، ستتم إضافة العناوين المحدّدة في هذا الحقل إلى العناوين المحدّدة في أي طلبات مقترَحة تم تحديدها سابقًا، وستتم إزالة القيم المكرّرة.

canvas

object (Canvas)

اختياريّ. يُمثِّل استجابة "لوحة الرسم التفاعلية" التي سيتم إرسالها إلى المستخدم.

orderUpdate

object (OrderUpdate)

يستجيب "الإجراء الاختياري" بـ OrderUpdate (تحديث الطلب) بعد استلام الطلب أثناء تدفق المعاملات. عند استلام هذا الإشعار، تسجِّل Google هذا التعديل في الطلب، وفي حال نجاحه، تعرض بطاقة إيصال بالإضافة إلى تقنية "تحويل النص إلى كلام" التي تم إرسالها على أجهزة العرض.

بسيط

يمثِّل طلبًا بسيطًا لإرساله إلى أحد المستخدمين. يمكنك الاطّلاع على https://developers.google.com/assistant/conversational/prompts-simple.

تمثيل JSON
{
  "speech": string,
  "text": string
}
الحقول
speech

string

اختياريّ. تمثِّل الكلام الذي سيتم قوله إلى المستخدم. يمكن أن يكون تنسيق SSML أو نص إلى كلام. إذا كان الحقل "إلغاء" في الطلب الذي يتضمّن النص "صحيحًا"، سيحلّ الخطاب المحدّد في هذا الحقل محلّ الكلام السابق لـ "الطلب البسيط". يمكنك الاطّلاع على https://developers.google.com/assistant/conversational/ssml.

text

string

نص اختياري يتم عرضه في فقاعة المحادثة. في حال عدم توفيره، سيتم عرض حقل الكلام أعلاه. تقتصر على 640 حرفًا. إذا كان الحقل "إلغاء" في الطلب الذي يتضمّن الطلب هو "صحيح"، يتم استبدال النص المحدّد في هذا الحقل بنص "الطلب البسيط" السابق.

المحتوى

كائن حاوية للمطالبات المنسّقة أو طلبات الاختيار

تمثيل JSON
{

  // Union field content can be only one of the following:
  "card": {
    object (Card)
  },
  "image": {
    object (Image)
  },
  "table": {
    object (Table)
  },
  "media": {
    object (Media)
  },
  "collection": {
    object (Collection)
  },
  "list": {
    object (List)
  },
  "collectionBrowse": {
    object (CollectionBrowse)
  }
  // End of list of possible types for union field content.
}
الحقول

حقل الاتحاد content

يمكن أن تكون السمة "content" واحدة فقط مما يلي:

card

object (Card)

بطاقة أساسية.

image

object (Image)

صورة.

table

object (Table)

بطاقة جدول.

media

object (Media)

استجابة تشير إلى مجموعة من الوسائط التي سيتم تشغيلها.

collection

object (Collection)

بطاقة تعرِض مجموعة من الخيارات للاختيار من بينها.

list

object (List)

بطاقة تعرِض قائمة بالخيارات التي يمكنك الاختيار من بينها.

collectionBrowse

object (CollectionBrowse)

بطاقة تعرض مجموعة من صفحات الويب لتفتحها

بطاقة

بطاقة أساسية لعرض بعض المعلومات، مثل صورة و/أو نص. يُرجى الاطّلاع على https://developers.google.com/assistant/conversational/prompts-rich#basic_card.

تمثيل JSON
{
  "title": string,
  "subtitle": string,
  "text": string,
  "image": {
    object (Image)
  },
  "imageFill": enum (ImageFill),
  "button": {
    object (Link)
  }
}
الحقول
title

string

العنوان العام للبطاقة. اختياريّ.

subtitle

string

اختياريّ.

text

string

النص الأساسي للبطاقة. تدعم مجموعة محدودة من بنية markdown للتنسيق. مطلوبة ما لم تكن الصورة متوفّرة.

image

object (Image)

صورة الجزء الرئيسي للبطاقة. ويتم تثبيت الارتفاع على 192 بكسل مستقل الكثافة. اختياريّ.

imageFill

enum (ImageFill)

كيفية ملء خلفية الصورة اختياريّ.

button

object (Link)

زرّ يتضمّن رابطًا صادرًا. اختياريّ.

صورة

صورة معروضة في البطاقة. يُرجى الاطّلاع على https://developers.google.com/assistant/conversational/prompts-rich#image-cards.

تمثيل JSON
{
  "url": string,
  "alt": string,
  "height": integer,
  "width": integer
}
الحقول
url

string

عنوان URL المصدر للصورة ويمكن أن تكون الصور بتنسيق JPG وPNG وGIF (الرسوم المتحركة وغير المتحركة). مثلاً،https://www.agentx.com/logo.png. مطلوبة.

alt

string

وصف نصي للصورة الذي سيتم استخدامه لتسهيل الاستخدام، مثل برامج قراءة الشاشة. مطلوبة.

height

integer

ارتفاع الصورة بالبكسل. اختياريّ.

width

integer

عرض الصورة بالبكسل. اختياريّ.

ImageFill

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

عمليات التعداد
UNSPECIFIED
GRAY املأ الفجوات بين الصورة وحاوية الصورة بأشرطة رمادية.
WHITE املأ الفجوات بين الصورة وحاوية الصورة باستخدام أشرطة بيضاء.
CROPPED يتم تغيير حجم الصورة بحيث يتطابق عرض الصورة وارتفاعها مع أبعاد الحاوية أو يتجاوزها. قد يؤدي ذلك إلى اقتصاص الجزء العلوي والسفلي من الصورة إذا كان ارتفاع الصورة التي تم تغيير حجمها أكبر من ارتفاع الحاوية، أو اقتصاص الجزء الأيسر والأيمن من الصورة إذا كان عرض الصورة التي تم تغيير حجمها أكبر من عرض الحاوية. يشبه هذا "وضع التكبير/التصغير" على تلفزيون بشاشة عريضة عند تشغيل فيديو بنسبة عرض إلى ارتفاع 4:3.

OpenUrl

تمثيل JSON
{
  "url": string,
  "hint": enum (UrlHint)
}
الحقول
url

string

حقل عنوان URL الذي يمكن أن يكون أيًا مما يلي: - عناوين URL التي تستخدم http/https لفتح تطبيق مرتبط بتطبيق أو صفحة ويب

hint

enum (UrlHint)

تشير هذه السمة إلى نوع عنوان URL.

UrlHint

أنواع مختلفة من تلميحات عناوين URL.

عمليات التعداد
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 (Image)
  },
  "columns": [
    {
      object (TableColumn)
    }
  ],
  "rows": [
    {
      object (TableRow)
    }
  ],
  "button": {
    object (Link)
  }
}
الحقول
title

string

العنوان العام للجدول. اختيارية، ولكن يجب ضبطها في حال ضبط الترجمة.

subtitle

string

العنوان الفرعي للجدول. اختياريّ.

image

object (Image)

صورة مرتبطة بالجدول اختياريّ.

columns[]

object (TableColumn)

العناوين ومحاذاة الأعمدة.

rows[]

object (TableRow)

بيانات الصف في الجدول. نضمن ظهور أول 3 صفوف، ولكن قد يتم قص بعضها الآخر على مساحات عرض معيّنة. يُرجى الاختبار باستخدام المحاكي لمعرفة الصفوف التي سيتم عرضها لسطح معيّن. على مساحات العرض التي تتيح إمكانية WEB_BROWSER، يمكنك توجيه المستخدِم إلى صفحة ويب تحتوي على مزيد من البيانات.

button

object (Link)

زرّ

TableColumn

تمثيل JSON
{
  "header": string,
  "align": enum (HorizontalAlignment)
}
الحقول
header

string

نص العنوان للعمود.

align

enum (HorizontalAlignment)

محاذاة أفقية للمحتوى w.r.t العمود وإذا لم يتم تحديده، ستتم محاذاة المحتوى مع الحافة البادئة.

HorizontalAlignment

محاذاة المحتوى داخل الخلية.

عمليات التعداد
UNSPECIFIED
LEADING الحافة البادئة للخلية. وهذا هو الخيار التلقائي.
CENTER تتم محاذاة المحتوى مع وسط العمود.
TRAILING تتم محاذاة المحتوى مع حافة العمود.

TableRow

تصف صفًا في الجدول.

تمثيل JSON
{
  "cells": [
    {
      object (TableCell)
    }
  ],
  "divider": boolean
}
الحقول
cells[]

object (TableCell)

الخلايا في هذا الصف. نضمن ظهور أول 3 خلايا، ولكن قد يتم قص الخلايا الأخرى على أسطح معينة. يُرجى الاختبار باستخدام المحاكي لمعرفة الخلايا التي سيتم عرضها لسطح معين.

divider

boolean

يشير إلى ما إذا كان يجب وجود مُقسّم بعد كل صف.

TableCell

لوصف خلية في صف واحد.

تمثيل JSON
{
  "text": string
}
الحقول
text

string

المحتوى النصي للخلية.

الوسائط

ويمثل عنصر وسائط واحدًا. يحتوي على معلومات عن الوسائط، مثل الاسم والوصف وعنوان URL وما إلى ذلك. يمكنك الاطّلاع على https://developers.google.com/assistant/conversational/prompts-media.

تمثيل JSON
{
  "mediaType": enum (MediaType),
  "startOffset": string,
  "optionalMediaControls": [
    enum (OptionalMediaControls)
  ],
  "mediaObjects": [
    {
      object (MediaObject)
    }
  ],
  "repeatMode": enum (RepeatMode),
  "firstMediaObjectIndex": integer
}
الحقول
mediaType

enum (MediaType)

startOffset

string (Duration format)

بدء إزاحة كائن الوسائط الأول

مدة بالثواني مؤلفة من تسعة أرقام كسور كحد أقصى، وتم إنهاؤها بـ "s". مثال: "3.5s".

optionalMediaControls[]

enum (OptionalMediaControls)

أنواع عناصر تحكّم اختيارية في الوسائط يمكن أن توفّرها جلسة الاستجابة للوسائط هذه. وفي حال ضبط هذه السياسة، سيتم إرسال الطلب إلى 3p عند وقوع حدث معيّن على الوسائط. إذا لم يتم ضبط السياسة، يجب أن تعالج جهة 3p نوعَي التحكّم التلقائيَّين، وهما "تم الانتهاء" و"تعذّر التحقق".

mediaObjects[]

object (MediaObject)

قائمة كائنات الوسائط

repeatMode

enum (RepeatMode)

وضع التكرار لقائمة كائنات الوسائط.

firstMediaObjectIndex

integer

فهرس مستند إلى 0 لأول عنصر وسائط في MediaObjects سيتم تشغيله. إذا لم يتم تحديد أي عنصر أو كان خارج الحدود، سيبدأ التشغيل عند العنصر الأول من الوسائط في فئة MediaObjects.

MediaType

نوع الوسائط لهذا الرد

عمليات التعداد
MEDIA_TYPE_UNSPECIFIED
AUDIO ملف صوتي
MEDIA_STATUS_ACK ردّ للإقرار بتقرير حالة الوسائط

OptionalMediaControls

أنواع التحكّم في الوسائط الاختيارية التي يمكن الاستجابة لها في الوسائط

عمليات التعداد
OPTIONAL_MEDIA_CONTROLS_UNSPECIFIED قيمة غير محدّدة
PAUSED حدث متوقف مؤقتًا. يتم تشغيله عندما يوقِف المستخدم الوسائط مؤقتًا.
STOPPED تم إيقاف الحدث. يتم تشغيله عندما يخرج المستخدم من جلسة 3p أثناء تشغيل الوسائط.

MediaObject

يمثل عنصر وسائط واحدًا

تمثيل JSON
{
  "name": string,
  "description": string,
  "url": string,
  "image": {
    object (MediaImage)
  }
}
الحقول
name

string

اسم عنصر الوسائط هذا

description

string

وصف عنصر الوسائط هذا.

url

string

تمثّل هذه السمة عنوان URL الذي يشير إلى محتوى الوسائط. يجب استضافة ملفات MP3 على خادم ويب وأن تكون متاحة للجميع من خلال عنوان URL يستخدم HTTPS. لا يتوفّر البث المباشر إلا بتنسيق MP3.

image

object (MediaImage)

الصورة التي سيتم عرضها مع بطاقة الوسائط.

MediaImage

تمثيل JSON
{

  // Union field image can be only one of the following:
  "large": {
    object (Image)
  },
  "icon": {
    object (Image)
  }
  // End of list of possible types for union field image.
}
الحقول

حقل الاتحاد image

يمكن أن تكون السمة "image" واحدة فقط مما يلي:

large

object (Image)

صورة كبيرة، مثل غلاف الألبوم وما إلى ذلك

icon

object (Image)

رمز صورة صغير معروض على يسار العنوان يتم تغيير حجمه إلى 36x36 بكسل مستقل الكثافة.

RepeatMode

أنواع وضع التكرار لقائمة من عناصر الوسائط.

عمليات التعداد
REPEAT_MODE_UNSPECIFIED يعادل إيقاف التشغيل.
OFF إنهاء جلسة تشغيل الوسائط في نهاية عنصر الوسائط الأخير.
ALL التكرار الحلقي إلى بداية كائن الوسائط الأول عند الوصول إلى نهاية آخر كائن وسائط.

المجموعة

بطاقة لمشاركة عرض مجموعة من الخيارات التي يمكنك الاختيار من بينها. يُرجى الاطّلاع على https://developers.google.com/assistant/conversational/prompts-selection#collection

تمثيل JSON
{
  "title": string,
  "subtitle": string,
  "items": [
    {
      object (CollectionItem)
    }
  ],
  "imageFill": enum (ImageFill)
}
الحقول
title

string

عنوان المجموعة اختياريّ.

subtitle

string

العنوان الفرعي للمجموعة. اختياريّ.

items[]

object (CollectionItem)

تمثّل هذه السمة قائمة بالعناصر. يمكن أن يكون الحد الأدنى 2 و10 كحد أقصى.

imageFill

enum (ImageFill)

كيفية ملء خلفيات الصورة لعناصر المجموعة اختياريّ.

CollectionItem

عنصر في المجموعة

تمثيل JSON
{
  "key": string
}
الحقول
key

string

مطلوبة. مفتاح NLU الذي يطابق اسم مفتاح الإدخال في النوع المرتبط به.

قائمة

بطاقة لمشاركة عرض قائمة خيارات للاختيار من بينها. يُرجى الاطّلاع على https://developers.google.com/assistant/conversational/prompts-selection#list

تمثيل JSON
{
  "title": string,
  "subtitle": string,
  "items": [
    {
      object (ListItem)
    }
  ]
}
الحقول
title

string

عنوان القائمة اختياريّ.

subtitle

string

العنوان الفرعي للقائمة. اختياريّ.

items[]

object (ListItem)

تمثّل هذه السمة قائمة بالعناصر. يمكن أن يكون الحد الأدنى 2 و30 كحد أقصى.

ListItem

عنصر في القائمة

تمثيل JSON
{
  "key": string
}
الحقول
key

string

مطلوبة. مفتاح NLU الذي يطابق اسم مفتاح الإدخال في النوع المرتبط به.

CollectionBrowse

يقدم مجموعة من مستندات الويب كمجموعة من عناصر المربعات الكبيرة. يمكن اختيار عناصر لتشغيل مستند الويب المرتبط بها في عارض الويب. يُرجى الاطّلاع على https://developers.google.com/assistant/conversational/prompts-selection#collectionBrowse.

تمثيل JSON
{
  "items": [
    {
      object (Item)
    }
  ],
  "imageFill": enum (ImageFill)
}
الحقول
items[]

object (Item)

تمثّل هذه السمة قائمة بالعناصر. يمكن أن يكون الحد الأدنى 2 و10 كحد أقصى.

imageFill

enum (ImageFill)

نوع خيار عرض الصورة

المنتج/الخدمة

العنصر في المجموعة

تمثيل JSON
{
  "title": string,
  "description": string,
  "footer": string,
  "image": {
    object (Image)
  },
  "openUriAction": {
    object (OpenUrl)
  }
}
الحقول
title

string

مطلوبة. عنوان عنصر المجموعة.

description

string

وصف عنصر المجموعة.

footer

string

نص تذييل عنصر المجموعة، معروض أسفل الوصف. سطر واحد من النص، تم اقتطاعه بعلامة حذف.

image

object (Image)

صورة لعنصر المجموعة

openUriAction

object (OpenUrl)

مطلوبة. معرّف موارد منتظم (URI) لفتحه في حال اختيار العنصر.

الاقتراح

توفّر ميزة "الاقتراحات" للمستخدمين على الأجهزة التي تتيح إمكانية العرض شرائح اقتراحات عندما يعرض "مساعد Google" رسالة الطلب. يمكنك استخدام شرائح الاقتراحات للتلميح إلى ردود المستخدمين بهدف متابعة المحادثة أو تغييرها. عند النقر على شريحة الاقتراح، تعرض شريحة الاقتراح النص المعروض في المحادثة الحرفية، كما لو كان المستخدم قد كتبها. يُرجى الاطّلاع على https://developers.google.com/assistant/conversational/prompts#suggestions،

تمثيل JSON
{
  "title": string
}
الحقول
title

string

مطلوبة. النص المعروض في شريحة الاقتراح. عند النقر على هذا النص، سيتم مشاركته مرة أخرى في المحادثة كما لو كان المستخدم قد كتبه. يجب أن يكون كل عنوان فريدًا بين مجموعة شرائح الاقتراحات. 25 حرفًا بحد أقصى

اللوحة

يُمثِّل ردّ "لوحة الرسم التفاعلية" لإرسالها إلى المستخدِم. ويمكن استخدامه إلى جانب الحقل "firstSimple" في الطلب الذي يتضمن للتحدث إلى المستخدم بالإضافة إلى عرض استجابة لوحة رسم تفاعلية. الحد الأقصى لحجم الاستجابة هو 50 كيلو بايت. يمكنك الاطّلاع على https://developers.google.com/assistant/interactivecanvas.

تمثيل JSON
{
  "url": string,
  "data": [
    value
  ],
  "suppressMic": boolean,
  "continuousMatchConfig": {
    object (ContinuousMatchConfig)
  }
}
الحقول
url

string

عنوان URL لتطبيق الويب التفاعلي للوحة الرسم الذي تريد تحميله. إذا لم يتم ضبط السياسة، ستتم إعادة استخدام عنوان URL من لوحة الرسم النشطة الحالية.

data[]

value (Value format)

اختياريّ. بيانات JSON التي يتم تمريرها إلى صفحة الويب الخاصة بالتجربة الشاملة على أنّها فعالية إذا كان الحقل "إلغاء" في الطلب الذي يتضمّن تلك اللوحة هو "خطأ"، ستتم إضافة قيم البيانات المحدّدة في هذا الطلب بعد قيم البيانات المحدّدة في طلبات لوحة الرسم السابقة.

suppressMic

boolean

اختياريّ. القيمة التلقائية: خطأ.

continuousMatchConfig

object (ContinuousMatchConfig)

الإعدادات المستخدَمة لبدء وضع المطابقة المستمرة.

ContinuousMatchConfig

الإعدادات المستخدَمة لبدء وضع المطابقة المستمرة.

تمثيل JSON
{
  "expectedPhrases": [
    {
      object (ExpectedPhrase)
    }
  ],
  "durationSeconds": integer
}
الحقول
expectedPhrases[]

object (ExpectedPhrase)

جميع العبارات المتوقّعة المحتملة خلال جلسة وضع المطابقة المستمرة هذه.

durationSeconds

integer

مدة للحفاظ على وضع المطابقة المستمرة مفعَّلاً. في حال تحديد ذلك، سيتم إغلاق الميكروفون عند انتهاء الوقت. الحد الأقصى للقيمة المسموح به هو 180.

ExpectedPhrase

تمثيل JSON
{
  "phrase": string,
  "alternativePhrases": [
    string
  ]
}
الحقول
phrase

string

العبارة المطلوب مطابقتها أثناء جلسة وضع المطابقة المستمرة.

alternativePhrases[]

string

قد يتم التعرُّف بشكل خاطئ على بعض العبارات من خلال نموذج الكلام حتى في حال انحياز الكلام. ويسمح هذا للمطوّرين بتحديد مشغّلات بديلة للمرادفات الصوتية.

OrderUpdate

تعديل الطلب

تمثيل JSON
{
  "type": enum (Type),
  "order": {
    object (Order)
  },
  "updateMask": string,
  "userNotification": {
    object (UserNotification)
  },
  "reason": string
}
الحقول
type
(deprecated)

enum (Type)

مهملة: يمكنك استخدام OrderUpdate.update_mask بدلاً من ذلك. إذا كان النوع = SNAPSHOT، يجب أن يكون OrderUpdate.order الطلب بالكامل. إذا كان النوع = ORDER_STATUS، فهذا هو التغيير في حالة مستوى الطلب. لا يتم اختيار سوى order.last_update_time وكذلك هذه الحالة الرأسية. ملاحظة: لا يتوافق type.ORDER_STATUS إلا مع تحديثات حالة PurcahaseOrderExtension، وليست هناك خطة لتمديد هذا الدعم. بدلاً من ذلك، ننصح باستخدام updateMask لأنه أكثر عمومية وقابلاً للتوسع ويمكن استخدامه لجميع المجالات.

order

object (Order)

updateMask

string (FieldMask format)

ملاحظة: هناك توصيات/توصيات في ما يلي للحقول الخاصة التالية: 1. سيتم دائمًا تعديل order.last_update_time كجزء من طلب التعديل. 2- سيتم تجاهل order.create_time وorder.google_order_id وorder.merchant_order_id إذا تم توفيرهما كجزء من قناع التحديث.

هذه قائمة مفصولة بفواصل تضم أسماء الحقول المؤهلة بالكامل. مثال: "user.displayName,photo"

userNotification

object (UserNotification)

في حال تحديد هذه السمة، يتم عرض إشعار للمستخدم بالعنوان والنص المحدَّدين. تحديد إشعار هو اقتراح للإشعار ولا يمكن ضمان أن ينتج عنه إشعار.

reason

string

سبب التغيير/التحديث.

Type

مهملة: يمكنك استخدام OrderUpdate.update_mask بدلاً من ذلك. تم السماح بالتحديثات لأحد الطلبات.

عمليات التعداد
TYPE_UNSPECIFIED النوع غير محدّد، ويجب عدم ضبط هذه السمة بشكلٍ صريح.
ORDER_STATUS عدِّل حالة الطلب فقط.
SNAPSHOT تعديل نبذة عن الطلب

طلب

كيان الطلب. ملاحظة: 1. يجب أن تكون جميع السلاسل في جميع المستويات أقل من 1000 حرف ما لم يتم تحديد خلاف ذلك. 2. يجب أن تكون جميع الحقول المتكرّرة في جميع المستويات أقل من 50 في العدد ما لم يتم تحديد خلاف ذلك. 3. يجب أن تكون جميع الطوابع الزمنية على جميع المستويات، إذا تم تحديدها، طوابع زمنية صالحة.

تمثيل JSON
{
  "googleOrderId": string,
  "merchantOrderId": string,
  "userVisibleOrderId": string,
  "userVisibleStateLabel": string,
  "buyerInfo": {
    object (UserInfo)
  },
  "image": {
    object (Image)
  },
  "createTime": string,
  "lastUpdateTime": string,
  "transactionMerchant": {
    object (Merchant)
  },
  "contents": {
    object (Contents)
  },
  "priceAttributes": [
    {
      object (PriceAttribute)
    }
  ],
  "followUpActions": [
    {
      object (Action)
    }
  ],
  "paymentData": {
    object (PaymentData)
  },
  "termsOfServiceUrl": string,
  "note": string,
  "promotions": [
    {
      object (Promotion)
    }
  ],
  "disclosures": [
    {
      object (Disclosure)
    }
  ],
  "vertical": {
    "@type": string,
    field1: ...,
    ...
  },

  // Union field verticals can be only one of the following:
  "purchase": {
    object (PurchaseOrderExtension)
  },
  "ticket": {
    object (TicketOrderExtension)
  }
  // End of list of possible types for union field verticals.
}
الحقول
googleOrderId

string

مُعرّف الطلب المخصّص لشركة Google

merchantOrderId

string

مطلوب: حصل التاجر على مُعرّف الطلب الداخلي. يجب أن يكون هذا المعرّف فريدًا ومطلوبًا لعمليات تعديل الطلبات اللاحقة. ويمكن ضبط هذا المعرّف على قيمة googleOrderId المقدَّمة أو أي قيمة فريدة أخرى. يُرجى العلم أنّ رقم التعريف المعروض للمستخدمين هو uservisibleOrderId، وقد يكون هذا المعرّف قيمة مختلفة وسهلة الاستخدام. الحد الأقصى المسموح به للطول هو 128 حرفًا.

userVisibleOrderId

string

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

userVisibleStateLabel
(deprecated)

string

مهملة: يمكنك استخدام حالة OrderExtensions بدلاً من ذلك. تصنيف مرئي للمستخدم لحالة هذا الطلب.

buyerInfo

object (UserInfo)

معلومات حول المشتري.

image

object (Image)

صورة مرتبطة بالطلب

createTime

string (Timestamp format)

مطلوب: تاريخ ووقت إنشاء الطلب

طابع زمني بتنسيق RFC3339 UTC "Zulu" ، بدقة نانو ثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "2014-10-02T15:01:23Z" و"2014-10-02T15:01:23.045123456Z"

lastUpdateTime

string (Timestamp format)

تاريخ ووقت آخر تعديل للطلب مطلوبة من أجل OrderUpdate

طابع زمني بتنسيق RFC3339 UTC "Zulu" ، بدقة نانو ثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "2014-10-02T15:01:23Z" و"2014-10-02T15:01:23.045123456Z"

transactionMerchant

object (Merchant)

التاجر الذي سهّل عملية الدفع وقد يختلف هذا عن مقدّم الخدمات على مستوى العنصر. مثال: طلب Expedia يحتوي على بند من ANA.

contents

object (Contents)

مطلوب: محتوى الطلب الذي هو مجموعة من العناصر.

priceAttributes[]

object (PriceAttribute)

السعر والخصومات والضرائب وما إلى ذلك.

followUpActions[]

object (Action)

إجراءات المتابعة على مستوى الطلب

paymentData

object (PaymentData)

البيانات المتعلّقة بالدفع مقابل الطلب

termsOfServiceUrl

string

رابط لبنود الخدمة التي تنطبق على الطلب/الطلب المقترح.

note

string

الملاحظات المرفقة بالطلب

promotions[]

object (Promotion)

جميع العروض الترويجية المرتبطة بهذا الطلب.

disclosures[]

object (Disclosure)

الإفصاحات المرتبطة بهذا الطلب

vertical
(deprecated)

object

مهملة: يمكنك استخدام مواضع الإعلانات بدلاً من ذلك. وسيتم تطبيق هذه السمات على جميع العناصر، ما لم يتم إلغاؤها في بعض العناصر. يجب أن يتطابق هذا المجال مع نوع موضع الإعلان على مستوى العنصر. القيم المتاحة: google.actions.orders.v3.verticals.purchase.PurchaseOrderExtension google.actions.orders.v3.verticals.ticket.TicketOrderExtension

كائن يحتوي على حقول من نوع عشوائي. يحتوي الحقل الإضافي "@type" على معرّف موارد منتظم (URI) يحدّد النوع. مثال: { "id": 1234, "@type": "types.example.com/standard/id" }

حقل الاتحاد verticals وسيتم تطبيق هذه السمات على جميع العناصر، ما لم يتم إلغاؤها في بعض العناصر. يجب أن يتطابق هذا المجال مع نوع موضع الإعلان على مستوى العنصر. يمكن أن تكون السمة "verticals" واحدة فقط مما يلي:
purchase

object (PurchaseOrderExtension)

طلب الشراء

ticket

object (TicketOrderExtension)

طلب التذكرة

UserInfo

معلومات حول المستخدم تُستخدَم هذه البيانات لتمثيل معلومات المستخدم المرتبط بطلب معيّن.

تمثيل JSON
{
  "email": string,
  "firstName": string,
  "lastName": string,
  "displayName": string,
  "phoneNumbers": [
    {
      object (PhoneNumber)
    }
  ]
}
الحقول
email

string

البريد الإلكتروني للمستخدم، على سبيل المثال: janedoe@gmail.com.

firstName

string

الاسم الأوّل للمستخدِم

lastName

string

اسم العائلة للمستخدِم.

displayName

string

قد يكون الاسم المعروض للمستخدم مختلفًا عن الاسم الأول أو اسم العائلة.

phoneNumbers[]

object (PhoneNumber)

أرقام هواتف المستخدم

PhoneNumber

التمثيل القياسي لرقم الهاتف.

تمثيل JSON
{
  "e164PhoneNumber": string,
  "extension": string,
  "preferredDomesticCarrierCode": string
}
الحقول
e164PhoneNumber

string

رقم الهاتف بالتنسيق E.164، على النحو المحدَّد في اقتراح الاتحاد الدولي للاتصالات (ITU) رقم E.164. رابط wiki: https://en.wikipedia.org/wiki/E.164

extension

string

لم يتم توحيد الامتداد في توصيات الاتحاد الدولي للاتصالات، باستثناء تعريفه على أنه سلسلة من الأرقام يبلغ طولها 40 رقمًا بحد أقصى. وتعريفها كسلسلة هنا لتلائم الاستخدام المحتمل لصفر بادئ في الإضافة (للمؤسسات حرية كاملة لإجراء ذلك، لأنه لا يوجد معيار محدد). بخلاف الأرقام، قد يتم تخزين بعض أحرف الاتصال الأخرى، مثل "," (التي تشير إلى الانتظار) هنا. على سبيل المثال، في xxx-xxx-xxxx الرقم الداخلي 123، يمثل الرقم "123" امتدادًا.

preferredDomesticCarrierCode

string

رمز اختيار مشغل شبكة الجوّال المفضل عند الاتصال برقم الهاتف هذا محليًا. ويشمل هذا أيضًا الرموز التي يجب الاتصال بها في بعض البلدان عند الاتصال من الخطوط الأرضية إلى الهواتف الجوّالة أو العكس. على سبيل المثال، في كولومبيا، يجب الاتصال بالرقم "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

string

عنوان URL المصدر للصورة ويمكن أن تكون الصور بتنسيق JPG وPNG وGIF (الرسوم المتحركة وغير المتحركة). مثلاً،https://www.agentx.com/logo.png. مطلوبة.

accessibilityText

string

وصف نصي للصورة الذي سيتم استخدامه لتسهيل الاستخدام، مثل برامج قراءة الشاشة. مطلوبة.

height

integer

ارتفاع الصورة بالبكسل. اختياريّ.

width

integer

عرض الصورة بالبكسل. اختياريّ.

التاجر

التاجر لسلة التسوق/الطلب/العنصر.

تمثيل JSON
{
  "id": string,
  "name": string,
  "image": {
    object (Image)
  },
  "phoneNumbers": [
    {
      object (PhoneNumber)
    }
  ],
  "address": {
    object (Location)
  }
}
الحقول
id

string

معرّف اختياري تم تعيينه للتاجر إن توفّر

name

string

اسم التاجر مثل "Panera Bread".

image

object (Image)

الصورة المرتبطة بالتاجر

phoneNumbers[]

object (PhoneNumber)

أرقام هواتف التاجر

address

object (Location)

عنوان التاجر:

الموقع الجغرافي

حاوية تمثّل موقعًا جغرافيًا.

تمثيل JSON
{
  "coordinates": {
    object (LatLng)
  },
  "formattedAddress": string,
  "zipCode": string,
  "city": string,
  "postalAddress": {
    object (PostalAddress)
  },
  "name": string,
  "phoneNumber": string,
  "notes": string,
  "placeId": string
}
الحقول
coordinates

object (LatLng)

الإحداثيات الجغرافية. يتطلب ذلك [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION].

formattedAddress

string

العنوان المعروض، على سبيل المثال "1600 Amphitheatre Pkwy, Mountain View, CA 94043". يتطلب ذلك [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION].

zipCode

string

الرمز البريدي يتطلب إذن [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] أو [DEVICE_COARSE_LOCATION] إذن [google.actions.v2.Permission.DEVICE_COARSE_LOCATION].

city

string

المدينة يتطلب إذن [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] أو [DEVICE_COARSE_LOCATION] إذن [google.actions.v2.Permission.DEVICE_COARSE_LOCATION].

postalAddress

object (PostalAddress)

العنوان البريدي. يتطلب إذن [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] أو [DEVICE_COARSE_LOCATION] إذن [google.actions.v2.Permission.DEVICE_COARSE_LOCATION].

name

string

اسم المكان.

phoneNumber

string

رقم هاتف الموقع الجغرافي، مثل رقم جهة الاتصال بالموقع الجغرافي للنشاط التجاري أو رقم هاتف لموقع التسليم

notes

string

ملاحظات حول الموقع الجغرافي

placeId

string

يتم استخدام رقم تعريف المكان مع واجهة برمجة تطبيقات الأماكن لجلب تفاصيل أحد الأماكن. لمعرفة مزيد من المعلومات، يُرجى الانتقال إلى https://developers.google.com/places/web-service/place-id.

LatLng

تمثّل هذه السمة كائنًا يمثّل زوجًا من خطوط الطول/العرض. يتم التعبير عن ذلك كزوج من الازدواج لتمثيل درجات خطوط الطول والعرض. يجب أن يتوافق هذا الكائن مع معيار WGS84 ما لم يتم تحديد خلاف ذلك. يجب أن تكون القيم ضمن نطاقات تمت تسويتها.

تمثيل JSON
{
  "latitude": number,
  "longitude": number
}
الحقول
latitude

number

تمثّل هذه السمة خط العرض بالدرجات. يجب أن يكون ضِمن نطاق [ -90.0 أو +90.0].

longitude

number

خط الطول بالدرجات. يجب أن يكون ضمن النطاق [-180.0، +180.0].

PostalAddress

يمثل عنوانًا بريديًا، على سبيل المثال، لعناوين التسليم البريدي أو الدفع. يمكن لخدمة بريدية تسليم السلع إلى المبنى أو صندوق البريد أو ما شابه ذلك من خلال استخدام عنوان بريدي. ليس الغرض منها تصميم نماذج للمواقع الجغرافية (الطرق والمدن والجبال).

في الاستخدام النموذجي، يتم إنشاء العنوان عن طريق البيانات التي يُدخلها المستخدم أو من استيراد البيانات الحالية، بناءً على نوع العملية.

نصائح حول إدخال أو تعديل العنوان: - استخدِم أداة عنوان جاهزة للاستخدام، مثل 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

integer

النسخة السابقة من المخطط من PostalAddress. يجب الضبط على 0، وهي آخر نسخة.

يجب أن تكون جميع النُسخ الجديدة متوافقة مع الإصدارات القديمة.

regionCode

string

مطلوبة. رمز CLDR للمنطقة للدولة/المنطقة حيث يقع العنوان لا يتم استنتاج هذه المعلومات على الإطلاق، وعلى المستخدم التأكّد من صحة القيمة. يمكنك الانتقال إلى http://cldr.unicode.org/ وhttp://www.unicode.org/cldr/charts/30/supplemental/territory_information.html للحصول على مزيد من التفاصيل. على سبيل المثال: "CH" لسويسرا.

languageCode

string

اختياريّ. رمز اللغة BCP-47 لمحتوى هذا العنوان (إذا كان معروفًا). وغالبًا ما تكون هذه اللغة هي لغة واجهة المستخدم في نموذج الإدخال، أو يُتوقّع أن تتطابق مع إحدى اللغات المستخدَمة في بلد أو منطقة العنوان أو ما يكافئها صوتيًا. يمكن أن يؤثر هذا على التنسيق في بلدان معينة، لكنه ليس بالغ الأهمية لصحة البيانات ولن يؤثر أبدًا على أي عمليات تحقق أو عمليات أخرى غير متعلقة بالتنسيق.

إذا كانت هذه القيمة غير معروفة، يجب حذفها (بدلاً من تحديد قيمة تلقائية قد تكون غير صحيحة).

أمثلة: "sa-Hant" و"ja" و"ja-Latn" و"en".

postalCode

string

اختياريّ. الرمز البريدي للعنوان لا تستخدم جميع البلدان الرموز البريدية أو تشترطها، ولكن في أماكن استخدامها، قد تبدأ عملية تحقّق إضافية من خلال استخدام أجزاء أخرى من العنوان (مثل إثبات صحة البيانات حسب الولاية أو الرمز البريدي في الولايات المتحدة الأمريكية).

sortingCode

string

اختياريّ. رمز ترتيب إضافي خاص بالبلد ولا يتم استخدام هذه الطريقة في معظم المناطق. وعند استخدامها، تكون القيمة إما سلسلة مثل "CEDEX"، متبوعة برقم اختياري (مثل "CEDEX 7")، أو رقم فقط يمثّل "رمز القطاع" (Jamaica) أو "مؤشر منطقة التسليم" (مالاوي) أو "مؤشر مكتب البريد" (مثل ساحل العاج).

administrativeArea

string

اختياريّ. أعلى تقسيم فرعي إداري يُستخدم للعناوين البريدية لبلد أو منطقة. على سبيل المثال، يمكن أن تكون ولاية أو مقاطعة أو مقاطعة أو محافظة. وعلى وجه التحديد، بالنسبة إلى إسبانيا، تكون هذه المقاطعة وليست المجتمع المستقل (مثل "برشلونة" وليس "كاتالونيا"). لا يستخدم العديد من البلدان منطقة إدارية في العناوين البريدية. في سويسرا مثلاً، يجب ترك هذا الحقل فارغًا.

locality

string

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

sublocality

string

اختياريّ. المنطقة المحلية الفرعية للعنوان. على سبيل المثال، يمكن أن يشمل ذلك الأحياء والأحياء والأحياء.

addressLines[]

string

أسطر عناوين غير مهيكلة تصف المستويات الأدنى من العنوان.

نظرًا لأن القيم في addressLines لا تحتوي على معلومات النوع وقد تحتوي أحيانًا على قيم متعددة في حقل واحد (على سبيل المثال، "Austin, TX")، من المهم أن يكون ترتيب الأسطر واضحًا. يجب أن يكون ترتيب سطور العنوان هو "ترتيب المغلف" للبلد/منطقة العنوان. وفي الأماكن التي يمكن أن يختلف فيها ذلك (مثل اليابان)، يتم استخدام address_language لجعله واضحًا (مثل "ja" للطلبات الكبيرة إلى الصغيرة و "ja-Latn" أو "en" للأحجام الصغيرة إلى الكبيرة). وبهذه الطريقة، يمكن تحديد السطر الأكثر تحديدًا في العنوان استنادًا إلى اللغة.

يتألف الحد الأدنى المسموح به من التمثيل الهيكلي للعنوان من رمز المنطقة مع وضع جميع المعلومات المتبقية في سطور العنوان. وكان من الممكن تنسيق مثل هذا العنوان بشكل تقريبي بدون ترميز جغرافي، ولكن لا يمكن الاستدلال على أي من مكونات العنوان حتى يتم حله جزئيًا على الأقل.

إنشاء عنوان يحتوي فقط على رمز المنطقة وaddressLines، ومن ثم الترميز الجغرافي هو الطريقة الموصى بها للتعامل مع العناوين غير المنظَّمة تمامًا (بدلاً من تخمين أجزاء العنوان التي يجب أن تكون مناطق محلية أو مناطق إدارية).

recipients[]

string

اختياريّ. المستلم في العنوان. قد يحتوي هذا الحقل، في ظروف معيّنة، على معلومات متعددة الأسطر. على سبيل المثال، قد تحتوي على معلومات حول "الاهتمام".

organization

string

اختياريّ. اسم المؤسسة في العنوان.

الفهرس

برنامج تغليف العناصر.

تمثيل JSON
{
  "lineItems": [
    {
      object (LineItem)
    }
  ]
}
الحقول
lineItems[]

object (LineItem)

قائمة عناصر الطلب. يجب إدخال عنصر واحد على الأقل و50 عنصرًا كحدّ أقصى. يجب أن تنتمي جميع البنود إلى المجال نفسه.

LineItem

يحتوي عنصر واحد على موضع إعلان واحد. يمكن أن يحتوي الطلب أو سلة التسوق على عناصر متعددة من المجال نفسه. يجب تحديد عناصر الأسطر الفرعية/الإضافات وما إلى ذلك في النماذج الأوّلية الرأسية اعتمادًا على حالات استخدامها. ملاحظة: 1. يجب أن تكون جميع السلاسل في جميع المستويات أقل من 1000 حرف ما لم يتم تحديد خلاف ذلك. 2. يجب أن تكون جميع الحقول المتكرّرة في جميع المستويات أقل من 50 في العدد ما لم يتم تحديد خلاف ذلك. 3. يجب أن تكون جميع الطوابع الزمنية على جميع المستويات، إذا تم تحديدها، طوابع زمنية صالحة.

تمثيل JSON
{
  "id": string,
  "name": string,
  "userVisibleStateLabel": string,
  "provider": {
    object (Merchant)
  },
  "priceAttributes": [
    {
      object (PriceAttribute)
    }
  ],
  "followUpActions": [
    {
      object (Action)
    }
  ],
  "recipients": [
    {
      object (UserInfo)
    }
  ],
  "image": {
    object (Image)
  },
  "description": string,
  "notes": [
    string
  ],
  "disclosures": [
    {
      object (Disclosure)
    }
  ],
  "vertical": {
    "@type": string,
    field1: ...,
    ...
  },

  // Union field verticals can be only one of the following:
  "purchase": {
    object (PurchaseItemExtension)
  },
  "reservation": {
    object (ReservationItemExtension)
  }
  // End of list of possible types for union field verticals.
}
الحقول
id

string

مطلوب: معرّف التاجر الذي عيّنه للعنصر. تُستخدَم لتحديد العنصر الحالي عند تطبيق التعديلات الجزئية. الحد الأقصى المسموح به للطول هو 64 حرفًا.

name

string

اسم البند كما هو معروض في الإيصال. الحد الأقصى المسموح به للطول هو 100 حرف.

userVisibleStateLabel
(deprecated)

string

تمّ الإيقاف. استخدِم الحالة على المستوى العمودي بدلاً من ذلك. على سبيل المثال، بالنسبة إلى عمليات الشراء، يمكنك استخدام purchaseOrderExtension.status. تصنيف مرئي للمستخدم لحالة هذا العنصر.

provider

object (Merchant)

تمثّل هذه السمة موفِّر العنصر المعيّن، إذا كان مختلفًا عن الطلب الكلي. مثال: طلب Expedia من خلال مزوّد تفاصيل الإعلانات ANA

priceAttributes[]

object (PriceAttribute)

السعر والتسويات على مستوى العنصر

followUpActions[]

object (Action)

إجراءات المتابعة على البند.

recipients[]

object (UserInfo)

للعملاء على مستوى العنصر، قد يختلف هذا العنصر عن المشتري على مستوى الطلب. مثال: أجرى المستخدم "س" حجز مطعم باسم المستخدم "ص".

image

object (Image)

صورة صغيرة مرتبطة بهذا العنصر، إن توفّرت.

description

string

وصف العنصر.

notes[]

string

ملاحظات إضافية تنطبق على هذا العنصر تحديدًا، على سبيل المثال سياسة الإلغاء.

disclosures[]

object (Disclosure)

الإفصاحات المرتبطة بهذا العنصر

vertical
(deprecated)

object

مهملة: يمكنك استخدام مواضع الإعلانات بدلاً من ذلك. مطلوب: المحتوى الدلالي للعنصر بناءً على نوعه أو مجاله. يجب أن يتضمن كل مجال تفاصيل توصيله. يجب استخدام إحدى القيمتَين التاليتَين: google.actions.orders.v3.verticals.purchase.PurchaseItemExtension google.actions.orders.v3.verticals.reservation.ReservationItemExtension google.actions.orders.v3.verticals.ticket.TicketItemExtension

كائن يحتوي على حقول من نوع عشوائي. يحتوي الحقل الإضافي "@type" على معرّف موارد منتظم (URI) يحدّد النوع. مثال: { "id": 1234, "@type": "types.example.com/standard/id" }

حقل الاتحاد verticals مطلوب: المحتوى الدلالي للعنصر بناءً على نوعه أو مجاله. يجب أن يتضمن كل مجال تفاصيل توصيله. يمكن أن تكون السمة "verticals" واحدة فقط مما يلي:
purchase

object (PurchaseItemExtension)

طلبات الشراء مثل السلع والأطعمة وغيرها

reservation

object (ReservationItemExtension)

طلبات الحجز مثل المطاعم وقص الشعر وما إلى ذلك

PriceAttribute

سمة السعر لطلب أو عنصر.

تمثيل JSON
{
  "type": enum (Type),
  "name": string,
  "id": string,
  "state": enum (State),
  "taxIncluded": boolean,

  // Union field spec can be only one of the following:
  "amount": {
    object (Money)
  },
  "amountMillipercentage": integer
  // End of list of possible types for union field spec.
}
الحقول
type

enum (Type)

مطلوب: سمة نوع الأموال.

name

string

مطلوب: يعرض المستخدم سلسلة سمة السعر. يُرسل التاجر هذه المعلومات وترجمتها.

id

string

اختياري: معرّف العنصر الذي يتوافق معه هذا السعر.

state

enum (State)

مطلوب: حالة السعر: تقديري في مقابل الفعلي.

taxIncluded

boolean

ما إذا كان السعر يشمل الضريبة.

حقل الاتحاد spec يمثل مبلغًا نقديًا أو نسبة مئوية بالمللي ثانية. يمكن أن تكون السمة "spec" واحدة فقط مما يلي:
amount

object (Money)

المبلغ النقدي

amountMillipercentage
(deprecated)

integer

مواصفات النسبة المئوية، حتى 1/1000 من النسبة المئوية. على سبيل المثال: 8.750% يتم تمثيلها كـ 8750، والنسب المئوية السالبة تمثل خصومات بالنسبة المئوية. جارٍ إيقاف هذا الحقل. يمكن إضافة مرة أخرى عند الحاجة إلى حالة استخدام قوية.

Type

يمثل نوع الأموال.

عمليات التعداد
TYPE_UNSPECIFIED لم يتم تحديد النوع، ولا يجب على العملاء ضبط هذا النوع صراحةً.
REGULAR السعر المعروض العادي قبل تطبيق أي خصومات وما إلى ذلك
DISCOUNT يجب طرحها من الإجمالي الفرعي.
TAX ستُضاف إلى الإجمالي الفرعي.
DELIVERY ستُضاف إلى الإجمالي الفرعي.
SUBTOTAL قد تتم إضافة الإجمالي الفرعي قبل بعض الرسوم.
FEE أي رسوم إضافية.
GRATUITY ستُضاف إلى الإجمالي الفرعي.
TOTAL عرض سعر الطلب أو العنصر

الحالة

يمثل حالة السعر.

عمليات التعداد
STATE_UNSPECIFIED غير محدَّد.
ESTIMATE السعر تقديري، ولكن سيكون المبلغ النهائي قريبًا من هذا المبلغ. على سبيل المثال: في الحالات التي لا تكون فيها الضريبة معروفة بدقة في وقت المعاملة، سيكون الإجمالي عبارة عن مبلغ quantity.
ACTUAL السعر الفعلي الذي سيتم تحصيله من المستخدم

مبالغ مالية

تمثّل هذه السمة مبلغًا من المال مع نوع العملة الخاص به.

تمثيل JSON
{
  "currencyCode": string,
  "amountInMicros": string
}
الحقول
currencyCode

string

تمثّل هذه السمة رمز العملة المكوَّن من 3 أحرف والمحدد في ISO 4217.

amountInMicros

string (int64 format)

المبلغ بوحدات المايكرو. على سبيل المثال، يجب ضبط هذا الحقل على 1990000 مقابل 1.99 دولار أمريكي (أو ما يعادله بالعملة المحلية).

الإجراء

إجراء متابعة مرتبط بالطلب أو العنصر.

تمثيل JSON
{
  "type": enum (Type),
  "title": string,
  "openUrlAction": {
    object (OpenUrlAction)
  },
  "actionMetadata": {
    object (ActionMetadata)
  }
}
الحقول
type

enum (Type)

مطلوب: نوع الإجراء

title

string

عنوان الإجراء أو تصنيفه، المعروض للمستخدم. الحد الأقصى المسموح به للطول هو 100 حرف.

openUrlAction

object (OpenUrlAction)

الإجراء المطلوب اتخاذه.

actionMetadata

object (ActionMetadata)

البيانات الوصفية المرتبطة بإجراء

Type

إجراءات المتابعة المحتملة

عمليات التعداد
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 (AndroidApp)
  },
  "urlTypeHint": enum (UrlTypeHint)
}
الحقول
url

string

حقل عنوان URL الذي يمكن أن يكون أيًا مما يلي: - عناوين URL التي تستخدم http/https لفتح تطبيق مرتبط بتطبيق أو صفحة ويب

androidApp

object (AndroidApp)

هي معلومات عن تطبيق Android إذا كان من المتوقّع أن يستوفي أحد تطبيقات Android عنوان URL.

urlTypeHint

enum (UrlTypeHint)

تشير هذه السمة إلى نوع عنوان URL.

AndroidApp

مواصفات تطبيق Android للقيود المفروضة على تنفيذ الطلبات

تمثيل JSON
{
  "packageName": string,
  "versions": [
    {
      object (VersionFilter)
    }
  ]
}
الحقول
packageName

string

اسم الحزمة يجب تحديد اسم الحزمة عند تحديد Android Fulfillment.

versions[]

object (VersionFilter)

عند تحديد فلاتر متعددة، ستؤدي أي مطابقة للفلتر إلى تشغيل التطبيق.

VersionFilter

يجب تضمين VersionFilter إذا كانت هناك إصدارات معيَّنة من التطبيق مطلوبة.

تمثيل JSON
{
  "minVersion": integer,
  "maxVersion": integer
}
الحقول
minVersion

integer

رمز الإصدار الأدنى أو 0، شامل.

maxVersion

integer

رمز الإصدار الأقصى، شامل. النطاق الذي يتم أخذه في الاعتبار هو [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

string (Timestamp format)

الوقت الذي ستنتهي فيه صلاحية هذا الإجراء.

طابع زمني بتنسيق RFC3339 UTC "Zulu" ، بدقة نانو ثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "2014-10-02T15:01:23Z" و"2014-10-02T15:01:23.045123456Z"

الإفصاح

هو الإفصاح عن المنتج أو الخدمة أو السياسة التي يمكن تقديمها للمستخدم.

تمثيل JSON
{
  "title": string,
  "disclosureText": {
    object (DisclosureText)
  },
  "presentationOptions": {
    object (DisclosurePresentationOptions)
  }
}
الحقول
title

string

عنوان الإفصاح. مثال: "معلومات السلامة".

disclosureText

object (DisclosureText)

محتوى الإفصاح: يُسمح باستخدام روابط الويب.

presentationOptions

object (DisclosurePresentationOptions)

خيارات العرض التقديمي لبيان الإفصاح

DisclosureText

تُمثِّل نصًا عاديًا يتضمّن روابط ويب.

تمثيل JSON
{
  "template": string,
  "textLinks": [
    {
      object (TextLink)
    }
  ]
}
الحقول
template

string

نص للعرض، يحتوي على عناصر نائبة مثل "{0}" و "{1}" لكل رابط نصي يجب إدراجه. مثال: "تحذير: يمكن أن يعرّضك هذا المنتج للمواد الكيميائية المعروفة لولاية كاليفورنيا بأنها تسبب السرطان. لمزيد من المعلومات، يُرجى الانتقال إلى {0}." يجب ألا يتضمّن نص الإفصاح هذا أي محتوى ترويجي أو يشبه الإعلانات.

DisclosurePresentationOptions

خيارات عرض الإفصاح.

تمثيل JSON
{
  "presentationRequirement": enum (PresentationRequirement),
  "initiallyExpanded": boolean
}
الحقول
presentationRequirement

enum (PresentationRequirement)

متطلبات العرض التقديمي للإفصاح:

initiallyExpanded

boolean

ما إذا كان يجب توسيع محتوى بيان الإفصاح في البداية أم لا. ويتم تصغيرها مبدئيًا تلقائيًا.

PresentationRequirement

متطلبات تقديم الإفصاح.

عمليات التعداد
REQUIREMENT_UNSPECIFIED مطلب غير محدد. يجب عدم ضبط هذه السمة بشكل صريح.
REQUIREMENT_OPTIONAL الإفصاح اختياري. ويمكن تخطّيه إذا كان الجهاز لا يتيح عرض بيانات الإفصاح.
REQUIREMENT_REQUIRED يجب الإفصاح عن جهة تمويل الإعلان. سيتم توجيه المحادثة إلى الهاتف إذا كان الجهاز لا يتيح عرض الإفصاحات.

PurchaseItemExtension

محتوى العنصر في قطاع الشراء

تمثيل JSON
{
  "status": enum (PurchaseStatus),
  "userVisibleStatusLabel": string,
  "type": enum (PurchaseType),
  "productId": string,
  "quantity": integer,
  "unitMeasure": {
    object (MerchantUnitMeasure)
  },
  "returnsInfo": {
    object (PurchaseReturnsInfo)
  },
  "fulfillmentInfo": {
    object (PurchaseFulfillmentInfo)
  },
  "itemOptions": [
    {
      object (ItemOption)
    }
  ],
  "productDetails": {
    object (ProductDetails)
  },
  "extension": {
    "@type": string,
    field1: ...,
    ...
  }
}
الحقول
status

enum (PurchaseStatus)

مطلوب: الحالة على مستوى العنصر.

userVisibleStatusLabel

string

مطلوب: تصنيف/سلسلة مرئية للمستخدم للحالة. الحد الأقصى المسموح به للطول هو 50 حرفًا.

type

enum (PurchaseType)

مطلوب: نوع الشراء

productId
(deprecated)

string

معرّف المنتج أو العرض المرتبط بهذا العنصر.

quantity

integer

كمية السلعة

unitMeasure

object (MerchantUnitMeasure)

قياس الوحدة. تحدّد حجم السلعة في الوحدات المختارة. يتمّ استخدام المقاس والسعر النشط لتحديد سعر الوحدة.

returnsInfo

object (PurchaseReturnsInfo)

تعرض معلومات لهذا العنصر. في حال ترك هذه السياسة بدون ضبط، يكتسب هذا العنصر معلومات حول مستوى الطلب.

fulfillmentInfo

object (PurchaseFulfillmentInfo)

معلومات توصيل الطلب لهذا العنصر. في حال ترك هذه السياسة بدون ضبط، يكتسب هذا العنصر معلومات طريقة التنفيذ على مستوى الطلب.

itemOptions[]

object (ItemOption)

العناصر الفرعية أو الإضافات الإضافية

productDetails

object (ProductDetails)

تفاصيل عن المنتج.

extension
(deprecated)

object

أي حقول إضافية يتم تبادلها بين التاجر وGoogle. ملاحظة: لا يُنصح بشدة باستخدام هذه الإضافة. يُرجى مراعاة أي ممّا يلي، وذلك حسب حالة أو ظروف الاستخدام: 1- حدِّد الحقول في PurchaseItemExtension إذا كان من الممكن استخدامها لحالات استخدام أخرى (مثل إمكانية/وظائف عامة). 2. يجب استخدام العمود_extension إذا كان محددًا لحالة/استخدام مخصّصة غير عامة.

كائن يحتوي على حقول من نوع عشوائي. يحتوي الحقل الإضافي "@type" على معرّف موارد منتظم (URI) يحدّد النوع. مثال: { "id": 1234, "@type": "types.example.com/standard/id" }

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 (Unit)
}
الحقول
measure

number

القيمة: المثال 1.2.

unit

enum (Unit)

الوحدة: مثال على POUND وGRAM

الوحدة

عمليات التعداد
UNIT_UNSPECIFIED لم يتم تحديد الوحدة.
MILLIGRAM مليغرام.
GRAM "غرام".
KILOGRAM كيلوغرام.
OUNCE Ounce
POUND جنيه

PurchaseReturnsInfo

تعرض معلومات مرتبطة بطلب أو عنصر معيّن.

تمثيل JSON
{
  "isReturnable": boolean,
  "daysToReturn": integer,
  "policyUrl": string
}
الحقول
isReturnable

boolean

وفي حال اختيار "صحيح"، يُسمح بالإرجاع.

daysToReturn

integer

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

policyUrl

string

رابط يؤدي إلى سياسة الإرجاع

PurchaseFulfillmentInfo

معلومات توصيل الطلبات المرتبطة بطلب شراء أو بند معيّن.

تمثيل JSON
{
  "id": string,
  "fulfillmentType": enum (Type),
  "expectedFulfillmentTime": {
    object (Time)
  },
  "expectedPreparationTime": {
    object (Time)
  },
  "location": {
    object (Location)
  },
  "expireTime": string,
  "price": {
    object (PriceAttribute)
  },
  "fulfillmentContact": {
    object (UserInfo)
  },
  "shippingMethodName": string,
  "storeCode": string,
  "pickupInfo": {
    object (PickupInfo)
  }
}
الحقول
id

string

المعرّف الفريد لخيار الخدمة هذا.

fulfillmentType

enum (Type)

مطلوب: نوع توصيل الطلب

expectedFulfillmentTime

object (Time)

نافذة في حال تحديد نطاق زمني أو ETA في حال تحديد نطاق زمني واحد. الوقت المتوقّع للتسليم أو الاستلام

expectedPreparationTime

object (Time)

نافذة في حال تحديد نطاق زمني أو ETA في حال تحديد نطاق زمني واحد. الوقت المتوقع لإعداد الطعام. يُفضَّل استخدامه لمرة واحدة.

location

object (Location)

موقع الاستلام أو التوصيل:

expireTime

string (Timestamp format)

الوقت الذي تنتهي فيه صلاحية خيار توصيل الطلب هذا.

طابع زمني بتنسيق RFC3339 UTC "Zulu" ، بدقة نانو ثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "2014-10-02T15:01:23Z" و"2014-10-02T15:01:23.045123456Z"

price

object (PriceAttribute)

تكلفة هذا الخيار.

fulfillmentContact

object (UserInfo)

جهة اتصال المستخدم المسؤولة عن عملية التنفيذ هذه

shippingMethodName

string

اسم طريقة الشحن التي اختارها المستخدم.

storeCode

string

رمز المتجر للموقع الجغرافي. مثال: Walmart هو التاجر ورمز المتجر هو متجر Walmart الذي تم توصيل الطلب إليه. https://support.google.com/business/answer/3370250?ref_topic=4596653.

pickupInfo

object (PickupInfo)

معلومات إضافية حول كيفية اختيار الطلب لن ينطبق هذا الحقل إلا عندما يكون نوع التنفيذ هو PICKUP.

Type

نوع توصيل الطلب

عمليات التعداد
TYPE_UNSPECIFIED لم يتم تحديد النوع.
DELIVERY سيتم تسليم هذا الطلب.
PICKUP يجب استلام هذا الطلب.

الوقت

بنية زمنية لتمثيل وقت حدث يمكن استخدامه عند عرض طلب للمستخدم.

تمثيل JSON
{
  "timeIso8601": string
}
الحقول
timeIso8601

string

تمثّل هذه السمة وقت حدث الطلب، مثل وقت الحجز ووقت التسليم وغير ذلك. ويمكن أن تكون المدة (وقت البدء ووقت الانتهاء)، والتاريخ والوقت فقط وما إلى ذلك. ويمكنك الرجوع إلى https://en.wikipedia.org/wiki/ISO_8601 للاطّلاع على جميع التنسيقات المتوافقة.

PickupInfo

تفاصيل حول كيفية استلام الطلب وهي تتضمّن تفاصيل مثل نوع الاستلام والبيانات الوصفية الإضافية المرفقة مع كل نوع، إن توفّرت.

تمثيل JSON
{
  "pickupType": enum (PickupType),
  "curbsideInfo": {
    object (CurbsideInfo)
  },
  "checkInInfo": [
    {
      object (CheckInInfo)
    }
  ]
}
الحقول
pickupType

enum (PickupType)

طريقة الاستلام، مثل INSTORE وCURBSIDE وغير ذلك

curbsideInfo

object (CurbsideInfo)

تمثّل هذه السمة تفاصيل خاصة بالمعلومات عن السيارة. إذا لم تكن قيمة pickupType (نوع الاستلام) هي CURBSIDE، سيتم تجاهل هذا الحقل.

checkInInfo[]

object (CheckInInfo)

قائمة بالطرق المختلفة التي يوفّرها الشريك لدعم تسجيل الوصول

PickupType

قائمة بأنواع استلام الطلب المتاحة

عمليات التعداد
UNSPECIFIED نوع الاستلام غير محدّد.
INSTORE يمكنك استلام الطعام من داخل المطعم.
CURBSIDE ركن السيارة في مكان مخصص خارج المطعم ويقوم شخص ما بتوصيل الطعام هناك.

CurbsideInfo

تفاصيل حول كيفية تسهيل الطلب من السيارة

تمثيل JSON
{
  "curbsideFulfillmentType": enum (CurbsideFulfillmentType),
  "userVehicle": {
    object (Vehicle)
  }
}
الحقول
curbsideFulfillmentType

enum (CurbsideFulfillmentType)

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

userVehicle

object (Vehicle)

تفاصيل المركبة الخاصة بالمستخدم الذي يقدّم الطلب

CurbsideFulfillmentType

القيم المحتملة لأنواع توصيل الطلبات إلى السيارة

عمليات التعداد
UNSPECIFIED لم يتم تحديد نوع توصيل الطلب إلى السيارة.
VEHICLE_DETAIL يجب توفير تفاصيل المركبة لتسهيل الاستلام من السيارة.

مركبة

تفاصيل حول مركبة

تمثيل JSON
{
  "make": string,
  "model": string,
  "licensePlate": string,
  "colorName": string,
  "image": {
    object (Image)
  }
}
الحقول
make

string

نوع المركبة (على سبيل المثال "Honda"). يتم عرض هذا الاسم للمستخدم ويجب ترجمته. مطلوبة.

model

string

طراز المركبة (على سبيل المثال "Grom"). يتم عرض هذا الاسم للمستخدم ويجب ترجمته. مطلوبة.

licensePlate

string

رقم لوحة ترخيص المركبة (مثلاً "1ABC234"). مطلوبة.

colorName

string

اسم لون المركبة، على سبيل المثال الأسود (اختياري)

image

object (Image)

عنوان URL يؤدي إلى صورة للمركبة سيتم عرض الصورة بحجم 256x256 بكسل تقريبًا. يجب أن يكون بتنسيق jpg أو png. اختياريّ.

CheckInInfo

البيانات الوصفية التي يطلبها الشريك لإتاحة وسيلة تسجيل الوصول

تمثيل JSON
{
  "checkInType": enum (CheckInType)
}
الحقول
checkInType

enum (CheckInType)

هي الطريقة المستخدَمة لإرسال تعليمات تسجيل الوصول.

CheckInType

تم استخدام طرق مختلفة لإرسال تعليمات تسجيل الوصول.

عمليات التعداد
CHECK_IN_TYPE_UNSPECIFIED قيمة غير معروفة.
EMAIL سيتم إرسال معلومات تسجيل الوصول عبر البريد الإلكتروني.
SMS سيتم إرسال معلومات تسجيل الوصول عبر الرسائل القصيرة SMS.

ItemOption

يمثل الإضافات أو العناصر الفرعية.

تمثيل JSON
{
  "id": string,
  "name": string,
  "prices": [
    {
      object (PriceAttribute)
    }
  ],
  "note": string,
  "quantity": integer,
  "productId": string,
  "subOptions": [
    {
      object (ItemOption)
    }
  ]
}
الحقول
id

string

بالنسبة إلى خيارات العناصر، معرّف السلعة الفريد.

name

string

اسم الخيار.

prices[]

object (PriceAttribute)

السعر الإجمالي للخيار.

note

string

ملاحظة ذات صلة بالخيار

quantity

integer

بالنسبة إلى الخيارات التي تتمثل في العناصر والكمية.

productId

string

معرّف المنتج أو العرض المرتبط بهذا الخيار.

subOptions[]

object (ItemOption)

لتحديد خيارات فرعية متداخلة أخرى.

ProductDetails

تفاصيل عن المنتج.

تمثيل JSON
{
  "productId": string,
  "gtin": string,
  "plu": string,
  "productType": string,
  "productAttributes": {
    string: string,
    ...
  }
}
الحقول
productId

string

معرّف المنتج أو العرض المرتبط بهذا العنصر.

gtin

string

تمثّل هذه السمة الرقم التجاري العالمي للسلعة. يكون هذا الإجراء مفيدًا إذا لم يتوفّر معرّف العرض في Merchant Center. اختياريّ.

plu

string

رموز البحث عن الأسعار، والمعروفة عادةً برموز PLU، أو أرقام PLU، أو PLU، أو رموز المنتجات، أو ملصقات المنتجات، هي نظام من الأرقام التي تحدّد بشكل فريد المنتجات المجمّعة التي يتم بيعها في متاجر البقالة ومحلات السوبرماركت.

productType

string

فئة المنتج التي حدّدها التاجر. على سبيل المثال: "الصفحة الرئيسية > البقالة > منتجات الألبان والبيض > الحليب > الحليب الكامل"

productAttributes

map (key: string, value: string)

التفاصيل التي يقدّمها التاجر حول المنتج، مثل { "allergen": "peanut" }. تكون هذه المعلومات مفيدة إذا لم يكن OfferId متوفّرًا في Merchant Center. اختياريّ.

عنصر يحتوي على قائمة من أزواج "key": value. مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" }

ReservationItemExtension

محتوى تفاصيل الإعلانات للطلبات المحجوزة، مثل المطعم وقص الشعر

تمثيل JSON
{
  "status": enum (ReservationStatus),
  "userVisibleStatusLabel": string,
  "type": enum (ReservationType),
  "reservationTime": {
    object (Time)
  },
  "userAcceptableTimeRange": {
    object (Time)
  },
  "confirmationCode": string,
  "partySize": integer,
  "staffFacilitators": [
    {
      object (StaffFacilitator)
    }
  ],
  "location": {
    object (Location)
  }
}
الحقول
status

enum (ReservationStatus)

مطلوب: حالة الحجز.

userVisibleStatusLabel

string

مطلوب: تصنيف/سلسلة مرئية للمستخدم للحالة. الحد الأقصى المسموح به للطول هو 50 حرفًا.

type

enum (ReservationType)

نوع الحجز يمكن إلغاء ضبط هذا الإعداد في حال عدم انطباق أي من خيارات النوع.

reservationTime

object (Time)

الوقت الذي تمت جدولة الخدمة/الحدث فيه. يمكن أن يتمثل في نطاق زمني أو تاريخ أو وقت محدّد.

userAcceptableTimeRange

object (Time)

النطاق الزمني المقبول للمستخدم.

confirmationCode

string

رمز تأكيد هذا الحجز

partySize

integer

عدد الأشخاص.

staffFacilitators[]

object (StaffFacilitator)

الموظفون المسؤولون عن الحجز. مثال مصفف الشعر.

location

object (Location)

الموقع الجغرافي للخدمة/الحدث

ReservationStatus

حالة الحجز

عمليات التعداد
RESERVATION_STATUS_UNSPECIFIED حالة غير محدّدة
PENDING الحجز في انتظار المراجعة.
CONFIRMED تم تأكيد الحجز.
CANCELLED إلغاء الحجز من قِبل المستخدم
FULFILLED تم الحجز.
CHANGE_REQUESTED مطلوب تغيير الحجز
REJECTED انتهت صلاحية الحجز أو تمّ رفضه من قِبل شركة الدمج.

ReservationType

نوع الحجز

عمليات التعداد
RESERVATION_TYPE_UNSPECIFIED نوع غير محدَّد.
RESTAURANT حجز في مطعم
HAIRDRESSER حجز لمصفف شعر.

StaffFacilitator

معلومات حول مقدِّم الخدمة.

تمثيل JSON
{
  "name": string,
  "image": {
    object (Image)
  }
}
الحقول
name

string

تمثّل هذه السمة اسم مُنسّق الموظفين. مثال "سَمِيرْ عَادِلْ"

image

object (Image)

صور المؤدي

PaymentData

بيانات الدفع المرتبطة بطلب معيّن

تمثيل JSON
{
  "paymentResult": {
    object (PaymentResult)
  },
  "paymentInfo": {
    object (PaymentInfo)
  }
}
الحقول
paymentResult

object (PaymentResult)

نتيجة الدفع التي تستخدمها شركة الدمج لإكمال معاملة. ستتم تعبئة هذا الحقل بواسطة "المهام مع مساعد Google" إذا كانت تجربة الدفع مُدارة من قِبل "المهام مع مساعد Google".

paymentInfo

object (PaymentInfo)

معلومات الدفع المتعلقة بالطلب والتي تكون مفيدة للتفاعل المباشر مع المستخدم.

PaymentResult

نتيجة الدفع المستخدَمة من قِبل الشركة المسؤولة عن عملية الدمج لإكمال معاملة

تمثيل JSON
{

  // Union field result can be only one of the following:
  "googlePaymentData": string,
  "merchantPaymentMethodId": string
  // End of list of possible types for union field result.
}
الحقول
حقل الاتحاد result يتم توفير بيانات الدفع على Google أو طريقة الدفع الخاصة بالتاجر. يمكن أن تكون السمة "result" واحدة فقط مما يلي:
googlePaymentData

string

بيانات طريقة الدفع التي قدّمتها Google. إذا كان معالج الدفع الذي تتعامل معه مُدرجًا كجهة لمعالجة الدفع المتوافقة مع Google هنا: https://developers.google.com/pay/api/ انتقِل إلى الجهة المسؤولة عن معالجة المعاملات من خلال الرابط للاطّلاع على المزيد من التفاصيل. ويمكنك أيضًا الاطّلاع على المستندات التالية للحصول على تفاصيل عن حمولة البيانات. https://developers.google.com/pay/api/payment-data-cryptography

merchantPaymentMethodId

string

طريقة الدفع التي اختارها المستخدم من قِبل التاجر/الإجراء

PaymentInfo

معلومات الدفع المتعلقة بالطلب الذي يتم تقديمه. يلتقط هذا النموذج الأوّلي معلومات مفيدة للتفاعل الموجه للمستخدم.

تمثيل JSON
{
  "paymentMethodDisplayInfo": {
    object (PaymentMethodDisplayInfo)
  },
  "paymentMethodProvenance": enum (PaymentMethodProvenance)
}
الحقول
paymentMethodDisplayInfo

object (PaymentMethodDisplayInfo)

المعلومات المعروضة لطريقة الدفع المُستخدَمة في المعاملة

paymentMethodProvenance

enum (PaymentMethodProvenance)

إثبات ملكية طريقة الدفع المُستخدَمة في المعاملة من المحتمل أن يكون المستخدم قد سجّل طريقة الدفع نفسها لدى كل من Google والتاجر.

PaymentMethodDisplayInfo

نتيجة الدفع المستخدَمة من قِبل الشركة المسؤولة عن عملية الدمج لإكمال معاملة

تمثيل JSON
{
  "paymentType": enum (PaymentType),
  "paymentMethodDisplayName": string,
  "paymentMethodVoiceName": string
}
الحقول
paymentType

enum (PaymentType)

نوع الدفعة.

paymentMethodDisplayName

string

اسم طريقة الدفع المعروض للمستخدم على سبيل المثال، VISA **** 1234 الحساب الجاري **** 5678

paymentMethodVoiceName

string

اسم طريقة الدفع التي سيتم نطقها للمستخدم في الأجهزة المزوّدة بخدمة "مساعد Google" الصوتية فقط. على سبيل المثال، "تأشيرة تنتهي بواحد وثلاثة أربعة" أو "الحساب الجاري المنتهي بخمسة ستة وسبعة وتسعين". ملاحظة: هذه هي السلسلة المحسَّنة بالصوت والتي سيتم استخدامها بدلاً من paymentMethodDisplayName للأجهزة المزوّدة بخدمة "الصوت فقط". وفي حال عدم ضبط هذه السلسلة، سيتم قول طريقة الدفع paymentMethodDisplayName للمستخدم بدلاً من ذلك.

PaymentType

يشير 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

string

مطلوب: رمز القسيمة الذي تم تطبيقه على هذا العرض.

PurchaseOrderExtension

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

تمثيل JSON
{
  "status": enum (PurchaseStatus),
  "userVisibleStatusLabel": string,
  "type": enum (PurchaseType),
  "returnsInfo": {
    object (PurchaseReturnsInfo)
  },
  "fulfillmentInfo": {
    object (PurchaseFulfillmentInfo)
  },
  "purchaseLocationType": enum (PurchaseLocationType),
  "errors": [
    {
      object (PurchaseError)
    }
  ],
  "extension": {
    "@type": string,
    field1: ...,
    ...
  }
}
الحقول
status

enum (PurchaseStatus)

الحالة المطلوبة: الحالة العامة للطلب

userVisibleStatusLabel

string

تصنيف/سلسلة مرئية للمستخدم للحالة الحد الأقصى المسموح به للطول هو 50 حرفًا.

type

enum (PurchaseType)

مطلوب: نوع الشراء

returnsInfo

object (PurchaseReturnsInfo)

معلومات الإرجاع الخاصة بالطلب

fulfillmentInfo

object (PurchaseFulfillmentInfo)

معلومات توصيل الطلب

purchaseLocationType

enum (PurchaseLocationType)

الموقع الجغرافي الذي تم فيه إجراء عملية الشراء (في المتجر / على الإنترنت)

errors[]

object (PurchaseError)

اختياري: أخطاء تم بسبب رفض هذا الطلب بسببها

extension
(deprecated)

object

أي حقول إضافية يتم تبادلها بين التاجر وGoogle. ملاحظة: لا يُنصح بشدة باستخدام هذه الإضافة. يُرجى مراعاة أي ممّا يلي، وذلك حسب حالة أو ظروف الاستخدام: 1- حدِّد الحقول في PurchaseOrderExtension إذا كان من الممكن استخدامها لحالات استخدام أخرى (مثل القدرة أو الوظائف العامة). 2. يجب استخدام العمود_extension إذا كان محددًا لحالة/استخدام مخصّصة غير عامة.

كائن يحتوي على حقول من نوع عشوائي. يحتوي الحقل الإضافي "@type" على معرّف موارد منتظم (URI) يحدّد النوع. مثال: { "id": 1234, "@type": "types.example.com/standard/id" }

PurchaseLocationType

نوع الموقع الجغرافي الذي تم فيه الشراء

عمليات التعداد
UNSPECIFIED_LOCATION قيمة غير معروفة.
ONLINE_PURCHASE جميع عمليات الشراء التي تم شراؤها على الإنترنت.
INSTORE_PURCHASE جميع عمليات الشراء في المتجر

PurchaseError

الأخطاء التي يمكن رفض طلب الشراء بسببها.

تمثيل JSON
{
  "type": enum (ErrorType),
  "description": string,
  "entityId": string,
  "updatedPrice": {
    object (PriceAttribute)
  },
  "availableQuantity": integer
}
الحقول
type

enum (ErrorType)

مطلوب: يشير ذلك إلى السبب الدقيق لرفض التاجر الطلب.

description

string

وصف إضافي للخطأ.

entityId

string

معرّف الكيان الذي يتوافق مع الخطأ. على سبيل المثال، يمكن أن يتوافق ذلك مع LineItemId / ItemOptionId.

updatedPrice

object (PriceAttribute)

تكون هذه السمة مناسبة في حالة حدوث نوع خطأ PRICE_CHANGED / INCORRECT_PRICE.

availableQuantity

integer

الكمية المتاحة الآن سارٍ في حالة AVAILABILITY_CHANGED.

ErrorType

أنواع الأخطاء المحتملة:

عمليات التعداد
ERROR_TYPE_UNSPECIFIED خطأ غير معروف
NOT_FOUND لم يتم العثور على الكيان، ويمكن أن يكون العنصر أو خيار توصيل الطلب أو العرض الترويجي. رقم تعريف الكيان مطلوب.
INVALID بيانات الكيان غير صالحة. يمكن أن تشمل السلعة أو 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

object (TicketEvent)

تم تطبيق الحدث على جميع تذاكر العناصر.

TicketEvent

يمثل حدثًا واحدًا.

تمثيل JSON
{
  "type": enum (Type),
  "name": string,
  "description": string,
  "url": string,
  "location": {
    object (Location)
  },
  "eventCharacters": [
    {
      object (EventCharacter)
    }
  ],
  "startDate": {
    object (Time)
  },
  "endDate": {
    object (Time)
  },
  "doorTime": {
    object (Time)
  }
}
الحقول
type

enum (Type)

مطلوب: نوع حدث التذكرة، مثل فيلم أو حفلة موسيقية

name

string

مطلوب: اسم الحدث على سبيل المثال، إذا كان الحدث عبارة عن فيلم، يجب أن يكون هذا هو اسم الفيلم.

description

string

تمثّل هذه السمة وصف الفعالية.

url

string

عنوان URL لمعلومات الحدث.

location

object (Location)

الموقع الذي يُقام فيه الحدث، أو الموقع الذي تقع فيه المؤسسة.

eventCharacters[]

object (EventCharacter)

الأحرف المرتبطة بهذا الحدث يمكن أن يكونوا مخرجين أو ممثلين في حدث سينمائي أو مؤدّي حفلة موسيقية، وما إلى ذلك.

startDate

object (Time)

وقت البدء

endDate

object (Time)

وقت الانتهاء

doorTime

object (Time)

وقت الدخول الذي قد يختلف عن وقت بدء الحدث، مثلاً يبدأ الحدث في الساعة 9 صباحًا، في حين أنّ وقت المشاركة هو 8:30 صباحًا

Type

نوع الحدث.

عمليات التعداد
EVENT_TYPE_UNKNOWN نوع الحدث غير معروف.
MOVIE فيلم.
CONCERT حفلة موسيقية
SPORTS الرياضة

EventCharacter

هناك حرف حدث واحد، مثل المنظِّم والمنفِّذ وما إلى ذلك.

تمثيل JSON
{
  "type": enum (Type),
  "name": string,
  "image": {
    object (Image)
  }
}
الحقول
type

enum (Type)

نوع الشخصية في الحدث، مثل ممثل أو مخرج

name

string

اسم الشخصية

image

object (Image)

صور الشخصيات.

Type

نوع الحرف

عمليات التعداد
TYPE_UNKNOWN نوع غير معروف.
ACTOR الممثل
PERFORMER المؤدي.
DIRECTOR المخرِج
ORGANIZER المنظم.

UserNotification

إشعار اختياري للمستخدم لعرضه كجزء من تعديل الطلب

تمثيل JSON
{
  "title": string,
  "text": string
}
الحقول
title

string

عنوان إشعار المستخدِم. الحد الأقصى المسموح به للطول هو 30 حرفًا.

text

string

محتويات الإشعار. الحد الأقصى المسموح به للطول هو 100 حرف.

NextScene

يمثل المشهد الذي سيتم تنفيذه بعد ذلك.

تمثيل JSON
{
  "name": string
}
الحقول
name

string

اسم المشهد الذي سيتم تنفيذه بعد ذلك.

الجلسة

يحتوي على معلومات حول جلسة المحادثة الحالية

تمثيل JSON
{
  "id": string,
  "params": {
    string: value,
    ...
  },
  "typeOverrides": [
    {
      object (TypeOverride)
    }
  ],
  "languageCode": string
}
الحقول
id

string

مطلوبة. معرّف فريد عالميًا لجلسة المحادثة الحالية. هذا الحقل للقراءة فقط.

params

map (key: string, value: value (Value format))

مطلوبة. قائمة بجميع المَعلمات التي تم جمعها من النماذج والأهداف أثناء الجلسة. المفتاح هو اسم المعلمة. سيتم دمج المعلّمات المحدّدة هنا مع المعلّمات المحدّدة مسبقًا في الجلسة. ستتم إزالة المعلمات ذات القيمة الفارغة من الجلسة. اطّلِع على مستندات تخزين الجلسات: https://developers.google.com/assistant/conversational/storage-session.

عنصر يحتوي على قائمة من أزواج "key": value. مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" }

typeOverrides[]

object (TypeOverride)

اختياريّ. الأنواع المحدّدة للجلسة يمكن أن تُكمِّل تحديدات نوع الجلسة الأنواع الحالية أو تستبدلها. يجب أن تكون أسماء الأنواع فريدة.

languageCode

string

لغة جلسة المحادثة الحالية يتّبع رمز اللغة الذي يتبعه فريق عمل مهندسي شبكة الإنترنت (IETF BCP-47) http://www.rfc-editor.org/rfc/bcp/bcp47.txt. ويمكن أن يختلف ذلك عن لغة المستخدم إذا كان الإجراء يستخدم ميزات متعددة اللغات. على سبيل المثال، عند ضبط handler_response.expected.language_code، يتمّ تغيير لغة المحادثة في جميع المنعطفات التالية، وهو ما سيظهر في هذا الحقل.

TypeOverride

يمثّل عملية إلغاء لنوع معيّن.

تمثيل JSON
{
  "name": string,
  "mode": enum (TypeOverrideMode),
  "synonym": {
    object (SynonymType)
  }
}
الحقول
name

string

مطلوبة. اسم النوع المطلوب تكميله أو إلغاؤه.

mode

enum (TypeOverrideMode)

مطلوبة. كيفية دمج هذا النوع مع قيم الأنواع الأخرى

synonym

object (SynonymType)

TypeOverrideMode

أنواع التعديلات لنوع كيان الجلسة.

عمليات التعداد
TYPE_UNSPECIFIED غير محدَّد. يجب عدم استخدام هذه القيمة أبدًا.
TYPE_REPLACE ستحل تعريفات الأنواع في هذه الاستجابة محل تعريفات الأنواع التي تم تحديدها مسبقًا.
TYPE_MERGE سيتم دمج تعريفات الأنواع في هذا الرد مع تعريفات الأنواع التي تم تحديدها مسبقًا. ستحل تعريفات الأنواع الجديدة محلّ تعريفات الأنواع الحالية.

SynonymType

تشير إلى نوع مع مرادفات.

تمثيل JSON
{
  "entries": [
    {
      object (Entry)
    }
  ]
}
الحقول
entries[]

object (Entry)

مطلوبة. قائمة الإدخالات لنوع المرادفات

تذكرة الدخول

تمثّل مدخلاً لنوع مرادف.

تمثيل JSON
{
  "name": string,
  "synonyms": [
    string
  ],
  "display": {
    object (EntryDisplay)
  }
}
الحقول
name

string

مطلوبة. اسم المدخل (على سبيل المثال "دراجة"). ويجب تضمين الإدخال في هذا الحقل في حقل المرادفات المتكررة للتعرف عليه باعتباره قيمة نوع صالح.

synonyms[]

string

مطلوبة. قائمة مرادفات الإدخال (على سبيل المثال، "دراجة" أو "دراجة").

display

object (EntryDisplay)

اختياريّ. معلومات عن عرض العنصر

EntryDisplay

تمثيل JSON
{
  "title": string,
  "description": string,
  "image": {
    object (Image)
  },
  "footer": string,
  "openUrl": {
    object (OpenUrl)
  }
}
الحقول
title

string

مطلوبة. عنوان السلعة. عند النقر على هذا النص، سيتم مشاركته مرة أخرى في المحادثة كما لو كان المستخدم قد كتبه. يجب أن يكون كل عنوان فريدًا بين مجموعة عناصر المجموعة.

description

string

اختياريّ. النص الأساسي للبطاقة.

image

object (Image)

اختياريّ. الصورة المطلوب عرضها

footer

string

اختياريّ. نص تذييل عنصر مجموعة التصفّح، المعروض أسفل الوصف. سطر واحد من النص، تم اقتطاعه بعلامة حذف.

openUrl

object (OpenUrl)

عنوان URL للمستند المرتبط بعنصر لوحة العرض الدوّارة للتصفّح هذا الخيار مطلوب لتصفّح لوحة العرض الدوّارة.

المستخدِم

تمثل هذه السمة المستخدم الذي يقدّم طلبًا إلى الإجراء.

تمثيل JSON
{
  "locale": string,
  "params": {
    string: value,
    ...
  },
  "accountLinkingStatus": enum (AccountLinkingStatus),
  "verificationStatus": enum (UserVerificationStatus),
  "lastSeenTime": string,
  "engagement": {
    object (Engagement)
  },
  "packageEntitlements": [
    {
      object (PackageEntitlements)
    }
  ],
  "permissions": [
    enum (Permission)
  ]
}
الحقول
locale

string

إعداد اللغة الأساسية للمستخدم الذي يرسل الطلب. يتّبع رمز اللغة الذي يتبعه فريق عمل مهندسي شبكة الإنترنت (IETF BCP-47) http://www.rfc-editor.org/rfc/bcp/bcp47.txt. ومع ذلك، لا يتم تضمين العلامة الفرعية للنص البرمجي.

params

map (key: string, value: value (Value format))

اختياريّ. قائمة بجميع المَعلمات المرتبطة بالمستخدم الحالي. اطّلِع على مستندات مساحة التخزين للمستخدم: https://developers.google.com/assistant/conversational/storage-user.

عنصر يحتوي على قائمة من أزواج "key": value. مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" }

accountLinkingStatus

enum (AccountLinkingStatus)

ما إذا كان حساب المستخدم مرتبطًا بالتطبيق أم لا.

verificationStatus

enum (UserVerificationStatus)

تشير إلى حالة التحقق للمستخدم.

lastSeenTime

string (Timestamp format)

الطابع الزمني للتفاعل الأخير مع هذا المستخدم. سيتم حذف هذا الحقل إذا لم يسبق للمستخدم التفاعل مع الوكيل.

طابع زمني بتنسيق RFC3339 UTC "Zulu" ، بدقة نانو ثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "2014-10-02T15:01:23Z" و"2014-10-02T15:01:23.045123456Z"

engagement

object (Engagement)

تفاعل المستخدم الحالي، بما في ذلك أي اشتراكات في الأغراض.

packageEntitlements[]

object (PackageEntitlements)

استحقاقات المستخدم ذات الصلة بحزمة Android المرتبطة بالإجراء الحالي.

permissions[]

enum (Permission)

يحتوي على الأذونات التي منحها المستخدم لهذا الإجراء.

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 (IntentSubscription)
    }
  ],
  "dailyUpdateIntents": [
    {
      object (IntentSubscription)
    }
  ]
}
الحقول
pushNotificationIntents[]

object (IntentSubscription)

يحتوي على قائمة بالأغراض التي فعّل المستخدم الإشعارات الفورية لها.

dailyUpdateIntents[]

object (IntentSubscription)

يحتوي على قائمة بالأغراض التي فعّل المستخدم التحديث اليومي لها.

IntentSubscription

يصف اشتراك IntentSUBSCRIPTION حالي.

تمثيل JSON
{
  "intent": string,
  "contentTitle": string
}
الحقول
intent

string

اسم الغرض الذي تم الاشتراك فيه.

contentTitle

string

اكتب وصفًا موجزًا للاشتراك. وتُستخدَم هذه المعلومات كتصنيف للإشعار وعندما يطلب "مساعد Google" إذنًا من المستخدم.

PackageEntitlements

قائمة واستحقاقات المستخدم المرتبطة باسم حزمة. يمكنك الاطّلاع على مستندات المعاملات الرقمية الجيدة: https://developers.google.com/assistant/transactions/digital/dev-guide-digital-non-consumables.

تمثيل JSON
{
  "packageName": string,
  "entitlements": [
    {
      object (Entitlement)
    }
  ]
}
الحقول
packageName

string

اسم حزمة Android المحدّد في حزمة الإجراءات.

entitlements[]

object (Entitlement)

استحقاقات المستخدم للحزمة المحدّدة.

الاستحقاق

تحدِّد هذه السمة الاستحقاق الرقمي للمستخدم.

تمثيل JSON
{
  "sku": string,
  "skuType": enum (SkuType),
  "inAppDetails": {
    object (SignedData)
  }
}
الحقول
sku

string

رمز التخزين التعريفي للمنتج اسم الحزمة للتطبيق المدفوع، ولاحقة Finsky docid للشراء داخل التطبيق والاشتراك داخل التطبيق. يجب مطابقة getSku() في Play InApp Billing API. راجع مستندات الفوترة داخل التطبيق على Play: https://developer.android.com/google/play/billing.

skuType

enum (SkuType)

تمثّل هذه السمة نوع رمز التخزين التعريفي.

inAppDetails

object (SignedData)

لا تتوفّر هذه الميزة إلا للشراء داخل التطبيق والاشتراكات داخل التطبيق.

SkuType

عمليات التعداد
SKU_TYPE_UNSPECIFIED
IN_APP الشراء داخل التطبيق
SUBSCRIPTION الاشتراكات
APP التطبيقات المدفوعة

SignedData

تمثيل JSON
{
  "inAppPurchaseData": {
    object
  },
  "inAppDataSignature": string
}
الحقول
inAppPurchaseData

object (Struct format)

تحتوي على جميع بيانات الشراء داخل التطبيق بتنسيق JSON. اطّلع على التفاصيل في الجدول 6 من https://developer.android.com/google/play/billing/billing_reference.html.

inAppDataSignature

string

يطابق IN_APP_DATA_SIGNATURE من طريقة getPurchase() في واجهة برمجة تطبيقات فوترة 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

map (key: string, value: value (Value format))

اختياريّ. قائمة بالمَعلمات المرتبطة ببنية HomeGraph التي ينتمي إليها الجهاز المستهدَف. يمكنك الاطّلاع على مستندات مساحة التخزين المنزلية: https://developers.google.com/assistant/conversational/storage-home.

عنصر يحتوي على قائمة من أزواج "key": value. مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" }

الجهاز

يمثل الجهاز الجهاز الذي يستخدمه المستخدم لتقديم طلب إلى الإجراء.

تمثيل JSON
{
  "capabilities": [
    enum (Capability)
  ],
  "currentLocation": {
    object (Location)
  },
  "timeZone": {
    object (TimeZone)
  }
}
الحقول
capabilities[]

enum (Capability)

مطلوب. إمكانات الجهاز الذي يقدّم طلبًا إلى الإجراء.

currentLocation

object (Location)

اختياريّ. الموقع الجغرافي لجهاز المستخدم يُرجى العلم أنّه لا تتم تعبئة هذه المعلومات إلا بعد أن يمنح المستخدم النهائي أذونات تحديد الموقع الجغرافي. راجع رسالة الموقع للحصول على مزيد من التفاصيل حول الحقول التي يتم تعيينها استنادًا إلى الإذن التقريبي مقابل الإذن الدقيق. اطّلِع على مستندات الأذونات: https://developers.google.com/assistant/conversational/permissions.

timeZone

object (TimeZone)

اختياريّ. المنطقة الزمنية المرتبطة بجهاز العميل. ويمكن استخدامها لحل قيم التاريخ والوقت.

الإمكانية

الإمكانات التي يتيحها سطح الجهاز في وقت الطلب.

عمليات التعداد
UNSPECIFIED إمكانيات الجهاز غير محدّدة.
SPEECH يمكن للجهاز التحدث إلى المستخدم عن طريق تحويل النص إلى كلام أو SSML.
RICH_RESPONSE يمكن للجهاز عرض ردود منسّقة، مثل البطاقات والقوائم والجداول.
LONG_FORM_AUDIO يمكن للجهاز تشغيل الوسائط الصوتية الطويلة، مثل الموسيقى وملفات البودكاست.
INTERACTIVE_CANVAS يمكن أن يعرض الجهاز استجابة تفاعلية من لوحة الرسم.
HOME_STORAGE يمكن للجهاز أن يتيح حفظ مساحة التخزين المنزلية وجلبها.

الموقع الجغرافي

حاوية تمثّل موقعًا جغرافيًا.

تمثيل JSON
{
  "coordinates": {
    object (LatLng)
  },
  "postalAddress": {
    object (PostalAddress)
  }
}
الحقول
coordinates

object (LatLng)

الإحداثيات الجغرافية. يتطلب ذلك الإذن [DEVICE_PRECISE_LOCATION].

postalAddress

object (PostalAddress)

العنوان البريدي. يتطلب ذلك إذن [DEVICE_PRECISE_LOCATION] أو [DEVICE_COARSE_LOCATION]. عند منح إذن تحديد الموقع الجغرافي التقريبي، من المتوقع أن تتم تعبئة حقلَي "الرمز البريدي" و"المنطقة المحلية" فقط. سيؤدي إذن تحديد الموقع الجغرافي الدقيق إلى تعبئة حقول إضافية مثل "administrativeArea" و"addressLines".

TimeZone

تمثّل هذه السمة منطقة زمنية من قاعدة بيانات المناطق الزمنية الصادرة عن هيئة أرقام الإنترنت المخصصة (IANA).

تمثيل JSON
{
  "id": string,
  "version": string
}
الحقول
id

string

المنطقة الزمنية لقاعدة بيانات المناطق الزمنية الصادرة عن منظمة IANA (المنظمة المعنية بأرقام الإنترنت المخصصة)، على سبيل المثال "أمريكا/القاهرة".

version

string

اختياريّ. رقم إصدار قاعدة بيانات المناطق الزمنية الصادرة عن منظمة IANA (المنظمة المعنية بأرقام الإنترنت المخصصة)، مثل "2019a".

السياق

يحتوي على معلومات حول السياق عندما يُجري المستخدم طلب بحث. ويشمل هذا السياق، على سبيل المثال لا الحصر، المعلومات المتعلقة بجلسة الوسائط النشطة وحالة تطبيق الويب للوحة الرسم وما إلى ذلك.

تمثيل JSON
{
  "media": {
    object (MediaContext)
  },
  "canvas": {
    object (CanvasContext)
  }
}
الحقول
media

object (MediaContext)

يحتوي على معلومات السياق حول جلسة تشغيل الوسائط النشطة الحالية.

canvas

object (CanvasContext)

يحتوي على معلومات السياق حول اللوحة الحالية.

MediaContext

يحتوي على معلومات السياق حول جلسة تشغيل الوسائط النشطة الحالية.

تمثيل JSON
{
  "progress": string,
  "index": integer
}
الحقول
progress

string (Duration format)

تقدم الوسائط لملف الوسائط النشط الحالي.

مدة بالثواني مؤلفة من تسعة أرقام كسور كحد أقصى، وتم إنهاؤها بـ "s". مثال: "3.5s".

index

integer

فهرس مستند إلى 0 لملف الوسائط النشط الحالي في قائمة ملفات الوسائط في استجابة الوسائط.

CanvasContext

يحتوي على معلومات السياق حول اللوحة الحالية.

تمثيل JSON
{
  "state": value
}
الحقول
state

value (Value format)

اختياريّ. يتم ضبط هذه الحالة من قِبل تطبيق "لوحة الرسم التفاعلية التابع لجهة خارجية". ويتم ضبط هذه الحالة فقط للطلب وليس للردّ. على سبيل المثال، إذا كان هذا تطبيقًا لوصفات الطعام، يمكن أن تكون الحالة قيمة struct : { "current_page" : 5, "last_page" : 3, } الحد الأقصى للحجم هو 50 كيلوبايت.

القيمة المتوقعة

يصف التوقعات المتعلقة بالمنعطف التالي في الحوار.

تمثيل JSON
{
  "speech": [
    string
  ]
}
الحقول
speech[]

string

قائمة العبارات التي يتوقعها الإجراء من كلام المستخدم لانحياز الكلام. الحد الأقصى المسموح به لعدد العبارات هو 1,000 عبارة. ملاحظة: يحمل هذا الحقل نفس المعنى كما في واجهة برمجة التطبيقات الإصدار 2 من واجهة برمجة التطبيقات.