Method: mediaItems.list

تعرِض هذه السمة قائمة بعناصر الوسائط المعروضة في الخلفية من مصادر الوسائط التي ضبطها المستخدم للجهاز المحدّد.

يقدّم listMediaItems تلقائيًا تجربة "الإضاءة السينمائية"، ما يؤدي إلى عرض مجموعة من عناصر الوسائط المنظَّمة من جميع المصادر التي ضبطها المستخدم.

يمكنك اختياريًا تضمين mediaSourceId في الطلب لاسترداد قائمة مفصّلة بالعناصر من مصدر وسائط معيّن، ما يتيح إجراء فلترة أكثر تقليدية.

تقتصر تطبيقات العميل على 240 طلبًا لكل جهاز في اليوم.

يحدث خطأ FAILED_PRECONDITION إذا لم يضبط المستخدم أي مصادر وسائط.

طلب HTTP

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

يستخدِم عنوان URL بنية تحويل ترميز gRPC.

مَعلمات طلب البحث

المعلمات
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