- בקשת HTTP
- גוף הבקשה
- גוף התגובה
- היקפי הרשאה
- NewMediaItem
- SimpleMediaItem
- NewMediaItemResult
- רוצים לנסות?
יוצר פריט מדיה אחד או יותר בספריית Google Photos של משתמש.
זהו השלב השני ביצירת פריט מדיה. פרטים לגבי שלב 1, העלאת הבייטים הגולמיים לשרת של Google, זמינים במאמר העלאת מדיה.
הקריאה הזו מוסיפה את פריט המדיה לספרייה. אם מציינים אלבום id
, הקריאה מוסיפה את פריט המדיה גם לאלבום. כל אלבום יכול להכיל עד 20,000 פריטי מדיה. כברירת מחדל, פריט המדיה יתווסף לסוף הספרייה או האלבום.
אם מוגדרים גם id
וגם מיקום, פריט המדיה יתווסף לאלבום במיקום שצוין.
אם הקריאה מכילה כמה פריטים של מדיה, הם מתווספים למיקום שצוין. אם אתם יוצרים פריט מדיה באלבום משותף שאתם לא הבעלים שלו, אין לכם אפשרות למקם את פריט המדיה. הפעולה הזו תגרום לשגיאה BAD REQUEST
.
בקשת HTTP
POST https://photoslibrary.googleapis.com/v1/mediaItems:batchCreate
בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של 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 |
פריט מדיה שנוצר באמצעות אסימון ההעלאה. הוא מאוכלס אם לא אירעו שגיאות ופריט המדיה נוצר בהצלחה. |