- בקשת HTTP
- גוף הבקשה
- גוף התגובה
- היקפי הרשאה
- NewMediaItem
- SimpleMediaItem
- NewMediaItemResult
- רוצים לנסות?
יצירת פריט מדיה אחד או יותר בספריית 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 ( |
שדות | |
---|---|
albumId |
המזהה של האלבום שאליו מוסיפים את פריטי המדיה. פריטי המדיה מתווספים גם לספרייה של המשתמש. השדה הזה אופציונלי. |
newMediaItems[] |
חובה. רשימת פריטי המדיה שיצרתם. אפשר להוסיף עד 50 פריטים של מדיה לכל שיחה. |
albumPosition |
המיקום באלבום שבו יתווספו פריטי המדיה. אם לא מציינים ערך, פריטי המדיה מתווספים לסוף האלבום (לפי ערך ברירת המחדל, כלומר |
גוף התשובה
רשימת פריטי המדיה שנוצרו.
אם הפעולה מצליחה, גוף התגובה מכיל נתונים במבנה הבא:
ייצוג ב-JSON |
---|
{
"newMediaItemResults": [
{
object ( |
שדות | |
---|---|
newMediaItemResults[] |
פלט בלבד. רשימת פריטי המדיה שנוצרו. |
היקפי הרשאה
נדרש אחד מהיקפי ההרשאות הבאים של 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 |
שדות | |
---|---|
description |
תיאור של פריט המדיה. השם הזה מוצג למשתמש בקטע המידע של הפריט באפליקציית Google Photos. אורכו צריך להיות פחות מ-1,000 תווים. מומלץ לכלול רק טקסט שנכתב על ידי משתמשים. התיאורים צריכים להוסיף הקשר ולעזור למשתמשים להבין את המדיה. אין לכלול מחרוזות שנוצרו באופן אוטומטי, כמו שמות של קובצי, תגים ומטא-נתונים אחרים. |
שדה האיחוד new_media_item_type . פריט המדיה החדש יכול להיות מסוגים שונים, בהתאם לנתיב ההעלאה. ההעלאות הנתמכות כרגע מתבצעות רק באמצעות הנתיב הפשוט של פריט המדיה. הערך של new_media_item_type יכול להיות רק אחת מהאפשרויות הבאות: |
|
simpleMediaItem |
פריט מדיה חדש שהועלה דרך |
SimpleMediaItem
פריט מדיה פשוט שייווצר ב-Google Photos באמצעות אסימון העלאה.
ייצוג ב-JSON |
---|
{ "uploadToken": string, "fileName": string } |
שדות | |
---|---|
uploadToken |
אסימון שמזהה את הבייטים של המדיה שהועלו ל-Google. |
fileName |
שם הקובץ עם הסיומת של פריט המדיה. השם הזה מוצג למשתמש ב-Google Photos. אם השדה הזה מוגדר, המערכת תתעלם משם הקובץ שצוין במהלך תהליך העלאת הבייטים. שם הקובץ, כולל סיומת הקובץ, לא יכול להכיל יותר מ-255 תווים. השדה הזה אופציונלי. |
NewMediaItemResult
התוצאה של יצירת פריט מדיה חדש.
ייצוג ב-JSON |
---|
{ "uploadToken": string, "status": { object ( |
שדות | |
---|---|
uploadToken |
אסימון ההעלאה ששימש ליצירת פריט המדיה החדש (הפשוט) הזה. השדה מאוכלס רק אם פריט המדיה פשוט ונדרש לו אסימון העלאה יחיד. |
status |
אם אירעה שגיאה במהלך יצירת פריט המדיה הזה, השדה הזה מאוכלס במידע שקשור לשגיאה. פרטים נוספים על השדה הזה זמינים בקטע סטטוס. |
mediaItem |
פריט מדיה שנוצר באמצעות אסימון ההעלאה. הוא מאוכלס אם לא אירעו שגיאות ופריט המדיה נוצר בהצלחה. |