Argument

تمثيل JSON
{
  "name": string,
  "rawText": string,
  "textValue": string,
  "status": {
    object (Status)
  },

  // Union field value can be only one of the following:
  "intValue": string,
  "floatValue": number,
  "boolValue": boolean,
  "datetimeValue": {
    object (DateTime)
  },
  "placeValue": {
    object (Location)
  },
  "extension": {
    "@type": string,
    field1: ...,
    ...
  },
  "structuredValue": {
    object
  }
  // End of list of possible types for union field value.
}
الحقول
name

string

اسم الوسيطة التي يتم توفيرها للإدخال.

rawText

string

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

textValue

string

يتم تحديده عندما يتضمّن نمط طلب البحث النوع $org.schema.type.Text أو يحتوي إدخال متوقّع على هدف مضمّن: actions.intent.TEXT أو actions.intent.OPTION. تجدر الإشارة إلى أنّه بالنسبة إلى هدف OPTION، تم ضبط textValue كمفتاح خيار، بينما تشير rawText أعلاه إلى النطاق الأولي في طلب بحث المستخدم.

status

object (Status)

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

حقل الاتحاد value. تم تحديد إحدى القيم التالية. يمكن أن يكون value واحدًا فقط مما يلي:
intValue

string (int64 format)

يتم تحديد هذا الإعداد عندما يشتمل نمط طلب البحث على نوع $org.schema.type.Number أو نوع إدخال متوقّع يحتوي على هدف مدمج: "assistant.intent.action.NUMBER".

floatValue

number

محدد مع هدف مضمَّن: "actions.intent.NUMBER"

boolValue

boolean

يتم تحديده عندما يتضمّن نمط طلب البحث النوع $org.schema.type.YesNo أو يحتوي إدخال متوقّع على هدف مضمّن: actions.intent.CONFIRMATION. ملاحظة: في حال عدم توفُّر القيمة المنطقية، يعني ذلك القيمة false.

datetimeValue

object (DateTime)

محدد للهدف المضمَّن: actions.intent.DATETIME.

placeValue

object (Location)

يتم تحديد ذلك عندما يتضمن نمط طلب البحث $org.schema.type.Location أو يكون الإدخال المتوقع مضمّنًا: "actions.intent.PLACE".

extension

object

هي إضافة يعتمد نوعها على الوسيطة. على سبيل المثال، إذا كان اسم الوسيطة SIGN_IN للغرض actions.intent.SIGN_IN، ستحتوي هذه الإضافة على القيمة SignInValue.

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

structuredValue

object (Struct format)

يتم تحديده عندما يحتاج محرّك بحث Google إلى تمرير قيمة البيانات بتنسيق JSON.

الحالة

يحدّد النوع Status نموذج خطأ منطقي مناسبًا لبيئات البرمجة المختلفة، بما في ذلك واجهات برمجة تطبيقات REST وواجهات برمجة تطبيقات RPC. وتُستخدَم من قِبل gRPC. تحتوي كل رسالة Status على ثلاث بيانات: رمز الخطأ ورسالة الخطأ وتفاصيل الخطأ.

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

تمثيل JSON
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
الحقول
code

integer

رمز الحالة، الذي يجب أن يكون قيمة تعداد بقيمة google.rpc.Code.

message

string

رسالة خطأ مواجهة للمطوِّر، ويجب أن تكون باللغة الإنجليزية يجب ترجمة أي رسالة خطأ تظهر للمستخدم وإرسالها في الحقل google.rpc.Status.details، أو ترجمتها من خلال البرنامج.

details[]

object

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

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

DateTime

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

تمثيل JSON
{
  "date": {
    object (Date)
  },
  "time": {
    object (TimeOfDay)
  }
}
الحقول
date

object (Date)

قيمة التاريخ

time

object (TimeOfDay)

القيمة الزمنية

التاريخ

تاريخ تقويم كامل أو جزئي، مثل عيد ميلاد. تم تحديد الوقت من اليوم والمنطقة الزمنية في مكان آخر أو غير مهمين. يرتبط التاريخ بالتقويم الميلادي الصحيح. وقد يمثل ذلك ما يلي:

  • تاريخ كامل، بقيم غير صفرية للسنة والشهر واليوم
  • قيمة الشهر واليوم، مع سنة صفرية، مثال: ذكرى سنوية
  • عام بمفرده، بدون قيم شهر ويوم
  • قيمة السنة والشهر، مع يوم صفر، على سبيل المثال. تاريخ انتهاء صلاحية بطاقة الائتمان

الأنواع ذات الصلة هي google.type.TimeOfDay وgoogle.protobuf.Timestamp.

تمثيل JSON
{
  "year": integer,
  "month": integer,
  "day": integer
}
الحقول
year

integer

سنة التاريخ. يجب أن تتراوح القيمة من 1 إلى 9999، أو 0 إذا أردت تحديد تاريخ بدون عام.

month

integer

الشهر من السنة. يجب أن تتراوح القيمة من 1 إلى 12، أو 0 إذا أردت تحديد سنة بدون شهر ويوم.

day

integer

يوم من الشهر. يجب أن تتراوح القيمة من 1 إلى 31 وأن تكون صالحة للسنة والشهر، أو 0 إذا حددت عامًا بمفردها أو عامًا وشهرًا لا يكون فيه اليوم مهمًا.

TimeOfDay

يمثل وقتًا من اليوم. إما أن التاريخ والمنطقة الزمنية ليست مهمة أو تم تحديدها في مكان آخر. قد تختار واجهة برمجة التطبيقات السماح بالثواني. الأنواع ذات الصلة هي google.type.Date وgoogle.protobuf.Timestamp.

تمثيل JSON
{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}
الحقول
hours

integer

ساعات اليوم بتنسيق 24 ساعة. يجب أن تتراوح القيمة بين 0 و23. قد تختار واجهة برمجة التطبيقات السماح بالقيمة "24:00:00" لسيناريوهات مثل موعد إغلاق العمل.

minutes

integer

دقائق من ساعات اليوم. يجب أن تتراوح القيمة بين 0 و59.

seconds

integer

ثواني الدقائق من الوقت. يجب أن تتراوح القيمة عادةً بين 0 و59. وقد تسمح واجهة برمجة التطبيقات بالقيمة 60 إذا كانت تسمح بالثواني الكبيسة.

nanos

integer

الكسور من الثواني بالنانو ثانية. يجب أن تتراوح القيمة بين 0 و999,999,999.