Method: mediaItems.batchCreate

יצירת פריט מדיה אחד או יותר בספריית Google Photos של המשתמש.

זהו השלב השני ביצירת פריט מדיה. לפרטים לגבי שלב 1, העלאת הבייטים הגולמיים לשרת Google, אפשר לעיין במאמר העלאת מדיה.

השיחה הזו גורמת להוספה של קובץ המדיה לספרייה. אם מציינים אלבום id, השיחה מוסיפה גם את פריט המדיה לאלבום. כל אלבום יכול להכיל עד 20,000 פריטי מדיה. כברירת מחדל, פריט המדיה יתווסף לסוף הספרייה או האלבום.

אם מוגדרים גם id וגם מיקום, פריט המדיה יתווסף לאלבום במיקום שצוין.

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

בקשת HTTP

POST https://photoslibrary.googleapis.com/v1/mediaItems:batchCreate

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

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג JSON 
{
  "albumId": string,
  "newMediaItems": [
    {
      object (NewMediaItem)
    }
  ],
  "albumPosition": {
    object (AlbumPosition)
  }
}
שדות
albumId

string

המזהה של האלבום שאליו נוספו פריטי המדיה. פריטי המדיה מתווספים גם לספרייה של המשתמש. השדה הזה אופציונלי.
newMediaItems[]

object (NewMediaItem)

חובה. רשימת פריטי מדיה ליצירה. עד 50 פריטי מדיה לשיחה.
albumPosition

object (AlbumPosition)

המיקום באלבום שבו נוספו פריטי המדיה. אם לא מציינים ערך, פריטי המדיה מתווספים לסוף האלבום (לפי ערך ברירת המחדל, כלומר LAST_IN_ALBUM). הבקשה נכשלת אם השדה הזה מוגדר ולא מציינים את albumId. הבקשה תיכשל גם אם תגדירו את השדה ואתם לא הבעלים של האלבום המשותף.

גוף התשובה

רשימת קובצי המדיה נוצרה.

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:

ייצוג JSON 
{
  "newMediaItemResults": [
    {
      object (NewMediaItemResult)
    }
  ]
}
שדות
newMediaItemResults[]

object (NewMediaItemResult)

פלט בלבד. רשימת קובצי המדיה נוצרה.

היקפי ההרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/photoslibrary
  • https://www.googleapis.com/auth/photoslibrary.appendonly
  • https://www.googleapis.com/auth/photoslibrary.sharing

NewMediaItem

פריט מדיה חדש שנוצר בחשבון Google Photos של המשתמש.

ייצוג JSON 
{
  "description": string,

  // Union field new_media_item_type can be only one of the following:
  "simpleMediaItem": {
    object (SimpleMediaItem)
  }
  // End of list of possible types for union field new_media_item_type.
}
שדות
description

string

תיאור של פריט המדיה. התמונה הזו מוצגת למשתמש בקטע הפרטים של הפריט באפליקציית Google Photos. האורך המותר הוא 1,000 תווים לכל היותר. יש לכלול רק טקסט שנכתב על ידי משתמשים. התיאורים צריכים להוסיף הקשר ולעזור למשתמשים להבין את התוכן. אין לכלול מחרוזות שנוצרו באופן אוטומטי, כמו שמות של קובצי, תגים ומטא-נתונים אחרים.
שדה איחוד new_media_item_type. פריט המדיה החדש יכול להיות מסוגים שונים – הדבר תלוי בנתיב ההעלאה. בהעלאות שנתמכות כרגע נעשה שימוש רק בנתיב פריט המדיה הפשוט. new_media_item_type יכול להיות רק אחת מהאפשרויות הבאות:
simpleMediaItem

object (SimpleMediaItem)

פריט מדיה חדש שהועלה באמצעות uploadToken הכלול.

SimpleMediaItem

פריט מדיה פשוט שייווצר ב-Google Photos באמצעות אסימון העלאה.

ייצוג JSON 
{
  "uploadToken": string,
  "fileName": string
}
שדות
uploadToken

string

אסימון שמזהה את הבייטים של המדיה שהועלו ל-Google.
fileName

string

שם הקובץ עם הסיומת של פריט המדיה. השם הזה יוצג למשתמש ב-Google Photos. אם השדה הזה מוגדר, המערכת מתעלמת משם הקובץ שצוין במהלך תהליך ההעלאה של בייטים. שם הקובץ, כולל סיומת הקובץ, צריך להיות באורך של עד 255 תווים. השדה הזה אופציונלי.

NewMediaItemResult

התוצאה של יצירת פריט מדיה חדש.

ייצוג JSON 
{
  "uploadToken": string,
  "status": {
    object (Status)
  },
  "mediaItem": {
    object (MediaItem)
  }
}
שדות
uploadToken

string

אסימון ההעלאה ששימש ליצירת פריט המדיה החדש (הפשוט). השדה הזה מאוכלס רק אם פריט המדיה פשוט ונדרש אסימון העלאה יחיד.
status

object (Status)

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

object (MediaItem)

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