Method: mediaItems.list

הפונקציה מחזירה רשימה של פריטים של מדיה בסביבה ממקורות מדיה שהמשתמש הגדיר למכשיר שצוין.

כברירת מחדל, listMediaItems מספק את חוויית Ambient, ומציג קבוצה של פריטים מתוכננים מכל המקורות שהמשתמשים הגדירו.

אפשר גם לכלול את הערך mediaSourceId בבקשה כדי לאחזר רשימה מחולקת לדפים של פריטים ממקור מדיה ספציפי, וכך לאפשר סינון מסורתי יותר.

אפליקציות לקוח מוגבלות ל-240 בקשות לכל מכשיר ביום.

שגיאת FAILED_PRECONDITION מתרחשת אם המשתמש לא הגדיר מקורות מדיה.

בקשת HTTP

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

כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.

פרמטרים של שאילתה

פרמטרים
deviceId

string

חובה. המזהה הייחודי של המכשיר הזה.
mediaSourceId

string

אופציונלי. בחוויית Ambient, משמיטים את השדה הזה. הפקודה הזו תחזיר קבוצה של פריטים מתוכננים של מדיה מכל המקורות שהוגדרו. מספר הפריטים שיוחזרו יהיה בהתאם לבקשה שלך ב-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