REST Resource: sessions

منبع: PickingSession

نمایش یک جلسه کاربر که در طی آن کاربر می تواند عکس ها و ویدیوها را با استفاده از Google Photos انتخاب کند.

نمایندگی JSON 
{
  "id": string,
  "pickerUri": string,
  "pollingConfig": {
    object (PollingConfig)
  },
  "expireTime": string,
  "pickingConfig": {
    object (PickingConfig)
  },
  "mediaItemsSet": boolean
}
فیلدها
id

string

فقط خروجی شناسه ایجاد شده توسط Google برای این جلسه.

pickerUri

string

فقط خروجی URI برای هدایت کاربر به Google Photos (در وب) استفاده می‌شود تا بتواند عکس‌ها و ویدیوها را برای جلسه فعلی انتخاب کند.

برای مشاهده موفقیت آمیز این صفحه، کاربر باید به حساب 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

پیکربندی برای نظرسنجی API.

نمایندگی 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

 اطلاعات مربوط به جلسه مشخص شده را بازیابی می کند.