REST Resource: sessions

المرجع: PickingSession

تمثيل لجلسة مستخدم يمكنه خلالها اختيار الصور والفيديوهات باستخدام "صور Google"

تمثيل JSON
{
  "id": string,
  "pickerUri": string,
  "pollingConfig": {
    object (PollingConfig)
  },
  "expireTime": string,
  "pickingConfig": {
    object (PickingConfig)
  },
  "mediaItemsSet": boolean
}
الحقول
id

string

النتائج فقط. المعرّف الذي أنشأته Google لهذه الجلسة.

pickerUri

string

النتائج فقط. عنوان URL المستخدَم لإعادة توجيه المستخدم إلى "صور Google" (على الويب) كي يتمكّن من اختيار الصور والفيديوهات للجلسة الحالية.

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

لا يمكن فتح pickerUri في إطار iframe لأسباب تتعلق بالأمان.

pollingConfig

object (PollingConfig)

النتائج فقط. الإعدادات المقترَحة التي يجب أن تستخدمها التطبيقات أثناء الاستعلام عن sessions.get

لا تتم تعبئة هذا الحقل إلا إذا لم يتم اختيار عناصر وسائط لهذه الجلسة بعد (أي mediaItemsSet غير صحيح).

expireTime

string (Timestamp format)

النتائج فقط. الوقت الذي ستنتهي فيه صلاحية الوصول إلى هذه الجلسة (وعناصر الوسائط التي تم اختيارها)

يستخدم معيار RFC 3339، حيث يكون الناتج الذي يتم إنشاؤه دائمًا مُعدَّلاً وفقًا لقاعدة Z ويستخدم 0 أو 3 أو 6 أو 9 أرقام عشرية. يتم أيضًا قبول العناصر غير "Z". أمثلة: "2014-10-02T15:01:23Z" أو "2014-10-02T15:01:23.045123456Z" أو "2014-10-02T15:01:23+05:30"

pickingConfig

object (PickingConfig)

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

يحدّد تطبيق العميل هذا عند استدعاء sessions.create، ولا يمكن تعديله بعد ذلك (بدون إنشاء جلسة جديدة).

mediaItemsSet

boolean

النتائج فقط. في حال ضبط القيمة على true، يعني ذلك أنّه تم اختيار عناصر وسائط لهذه الجلسة ويمكن لتطبيقك طلب قائمة عناصر الوسائط التي تم اختيارها من خلال mediaItems.list.

PollingConfig

إعدادات طلب البيانات من واجهة برمجة التطبيقات

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

string (Duration format)

النتائج فقط. الوقت المُقترَح بين طلبات الاستطلاع

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

timeoutIn

string (Duration format)

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

تشير القيمة 0 إلى أنّه يجب على العميل إيقاف الاستطلاع إذا لم يسبق له ذلك.

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

PickingConfig

الإعدادات التي يحدّدها العميل لتجربة اختيار المستخدم خلال هذه الجلسة

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

string (int64 format)

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

في حال عدم تحديد قيمة أو ضبطها على 0، يمكن اختيار 2000 عنصر كحد أقصى. سيتم فرض القيم التي تزيد عن 2000 لتكون 2000. ستؤدي القيم السلبية إلى ظهور خطأ INVALID_ARGUMENT.

الطُرق

create

إنشاء جلسة جديدة يمكن للمستخدم خلالها اختيار الصور والفيديوهات للوصول إليها من خلال جهة خارجية

delete

لحذف الجلسة المحدّدة.

get

تستردّ هذه الدالة معلومات عن الجلسة المحدّدة.