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

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

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

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

بالنسبة إلى التطبيقات المستندة إلى الويب، يمكنك إضافة /autoclose إلى معرّف الموارد المنتظم (URI) هذا. سيتم بعد ذلك إغلاق نافذة "صور Google" أو علامتها تلقائيًا بعد أن ينتهي المستخدم من اختيار الصور، بدلاً من عرض شاشة "تم".

pollingConfig

object (PollingConfig)

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

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

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، يمكن اختيار 2, 000 عنصر كحد أقصى. سيتم فرض القيم التي تزيد عن 2000 لتصبح 2000. ستؤدي القيم السلبية إلى حدوث خطأ INVALID_ARGUMENT.

الطُرق

create

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

delete

يحذف هذا الإجراء الجلسة المحدّدة.

get

تُستخدَم لاسترداد معلومات عن الجلسة المحدّدة.