Method: mediaItems.list

فهرستی از موارد رسانه محیطی را از منابع رسانه پیکربندی شده توسط کاربر برای دستگاه مشخص شده برمی گرداند.

به طور پیش‌فرض، listMediaItems تجربه Ambient را فراهم می‌کند و مجموعه‌ای از آیتم‌های رسانه را از همه منابع پیکربندی شده توسط کاربر بازمی‌گرداند.

به صورت اختیاری، می‌توانید mediaSourceId در درخواست برای بازیابی فهرست صفحه‌بندی‌شده‌ای از موارد از یک منبع رسانه‌ای خاص قرار دهید، که امکان فیلترهای سنتی‌تر را فراهم می‌کند.

برنامه های مشتری به 240 درخواست در هر دستگاه در روز محدود می شود.

اگر کاربر هیچ منبع رسانه ای را پیکربندی نکرده باشد، خطای FAILED_PRECONDITION رخ می دهد.

درخواست HTTP

GET https://photosambient.googleapis.com/v1/mediaItems

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای پرس و جو

پارامترها
deviceId

string

مورد نیاز. شناسه منحصر به فرد این دستگاه.

mediaSourceId

string

اختیاری. برای تجربه محیط ، این زمینه را حذف کنید. با این کار مجموعه‌ای از آیتم‌های رسانه از همه منابع پیکربندی شده بازگردانده می‌شود. تعداد موارد بازگردانده شده به درخواست pageSize شما، حداکثر تا 100 مورد پاسخ می دهد. در صورت مشخص شدن، فقط موارد از منبع رسانه مشخص شده بازگردانده می شود.

id باید منبعی باشد که کاربر برای دستگاه مشخص شده انتخاب کرده است (یعنی یکی از AmbientDevice.media_sources.id ).

توجه داشته باشید، highlights حتی اگر منبع انتخابی کاربر برای این دستگاه باشد، پشتیبانی نمی شود. با تنظیم این فیلد روی highlights ، خطای INVALID_ARGUMENT برمی گردد.

pageSize

integer

اختیاری. حداکثر تعداد آیتم های رسانه ای برای بازگشت.

این سرویس به درخواست pageSize شما احترام می‌گذارد، اگرچه ممکن است موارد کمتری از مقدار مشخص شده (از جمله نتایج صفر) را برگرداند.

اگر pageSize مشخص نشده باشد یا روی 0 تنظیم شود، حداکثر 50 مورد رسانه برگردانده می شود. مقادیر بیشتر از 100 به حداکثر مقدار مجاز 100 کاهش می یابد. ارائه یک مقدار منفی منجر به خطای INVALID_ARGUMENT می شود.

pageToken

string

اختیاری. یک نشانه صفحه، دریافت شده از تماس قبلی mediaItems.list . این را برای بازیابی صفحه بعدی ارائه دهید.

درخواست بدن

بدنه درخواست باید خالی باشد.

بدن پاسخگو

پاسخ به روش mediaItems.list .

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

نمایندگی JSON 
{
  "mediaItems": [
    {
      object (AmbientMediaItem)
    }
  ],
  "nextPageToken": string
}
فیلدها
mediaItems[]

object ( AmbientMediaItem )

صفحه ای از موارد رسانه محیطی برای نمایش دستگاه.

nextPageToken

string

در صورت تنظیم، این فیلد می تواند به عنوان pageToken در یک فراخوان بعدی mediaItems.list برای بازیابی صفحه بعدی موارد استفاده شود.

اگر این قسمت حذف شود، لزوماً نشان‌دهنده این نیست که محتوای دیگری برای واکشی در دسترس نیست، بلکه ممکن است صفحه بعدی محتوا حاوی موارد رسانه‌ای باشد که قبلاً در صفحات قبلی بازگردانده شده‌اند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/photosambient.mediaitems