REST Resource: photo

משאב: תמונה

התמונה משמשת לאחסון תמונות 360 יחד עם המטא-נתונים של התמונה.

ייצוג ב-JSON 
{
  "photoId": {
    object (PhotoId)
  },
  "uploadReference": {
    object (UploadRef)
  },
  "downloadUrl": string,
  "thumbnailUrl": string,
  "shareLink": string,
  "pose": {
    object (Pose)
  },
  "connections": [
    {
      object (Connection)
    }
  ],
  "captureTime": string,
  "uploadTime": string,
  "places": [
    {
      object (Place)
    }
  ],
  "viewCount": string,
  "transferStatus": enum (TransferStatus),
  "mapsPublishStatus": enum (MapsPublishStatus)
}
שדות
photoId

object (PhotoId)

חובה. פלט בלבד. נדרש כשמעדכנים תמונה. פלט רק כשיוצרים תמונה. מזהה התמונה, שהוא ייחודי בין כל התמונות ב-Google.
uploadReference

object (UploadRef)

קלט בלבד. חובה כשיוצרים תמונה. קלט בלבד. כתובת ה-URL של המשאב שאליו מועלים הבייטים של התמונה.
downloadUrl

string

פלט בלבד. כתובת ה-URL להורדה של בייטים של התמונה. השדה הזה מוגדר רק אם בשדה GetPhotoRequest.view מגדירים את הערך PhotoView.INCLUDE_DOWNLOAD_URL.
thumbnailUrl

string

פלט בלבד. כתובת ה-URL של התמונה הממוזערת שמשמשת לתצוגה מקדימה של התמונה שצוינה.
pose

object (Pose)

אופציונלי. הפוזה בתמונה.
connections[]

object (Connection)

אופציונלי. חיבורים לתמונות אחרות. הקשר מייצג את הקישור בין התמונה הזו לתמונה אחרת.
captureTime

string (Timestamp format)

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

הפלט שנוצר תמיד יהיה בפורמט RFC 3339, עם נורמליזציה של Z ושימוש ב-0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים חוץ מ-Z. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
uploadTime

string (Timestamp format)

פלט בלבד. השעה שבה התמונה הועלתה.

הפלט שנוצר תמיד יהיה בפורמט RFC 3339, עם נורמליזציה של Z ושימוש ב-0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים חוץ מ-Z. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
places[]

object (Place)

אופציונלי. המקומות שאליהם התמונה הזו משויכת.
viewCount

string (int64 format)

פלט בלבד. מספר הצפיות בתמונה.
transferStatus

enum (TransferStatus)

פלט בלבד. הסטטוס של העברת הזכויות על התמונה הזו.
mapsPublishStatus

enum (MapsPublishStatus)

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

PhotoId

מזהה של Photo.

ייצוג ב-JSON 
{
  "id": string
}
שדות
id

string

מזהה ייחודי של תמונה.

UploadRef

העלאת הפניה לקובצי מדיה.

ייצוג ב-JSON 
{

  // Union field file_source can be only one of the following:
  "uploadUrl": string
  // End of list of possible types for union field file_source.
}
שדות
שדה איחוד file_source. חובה. הערך file_source יכול להיות רק אחד מהבאים:
uploadUrl

string

כל הפניה להעלאה צריכה להיות ייחודית לכל משתמש. הפורמט הוא: https://streetviewpublish.googleapis.com/media/user/{account_id}/photo/{uploadReference}

תנוחה

מדידה גולמית של תנוחת ישות.

ייצוג ב-JSON 
{
  "latLngPair": {
    object (LatLng)
  },
  "altitude": number,
  "heading": number,
  "pitch": number,
  "roll": number,
  "gpsRecordTimestampUnixEpoch": string,
  "level": {
    object (Level)
  },
  "accuracyMeters": number
}
שדות
latLngPair

object (LatLng)

זוג של קו רוחב וקו אורך של התנוחה, כפי שמוסבר כאן: https://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng כשיוצרים Photo, אם לא מספקים את הזוג של קו הרוחב וקו האורך, נעשה שימוש במיקום הגיאוגרפי מכותרת ה-EXIF. אם לא מצוין זוג של קווי רוחב ואורך בתמונה או בכותרת ה-EXIF, תהליך התמונה ייכשל.
altitude

number

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

number

פרמטרים התנוחה הבאים מתייחסים למרכז התמונה. הם תואמים לכתובת https://developers.google.com/streetview/spherical-metadata. כיוון המצפן, שנמדד במרכז התמונה במעלות בכיוון השעון מצפון. הערך צריך להיות גדול או שווה ל-0 וקטן מ-360. הערך NaN מציין כמות שלא נמדדה.
pitch

number

זווית ההטיה, נמדדת במרכז התמונה במעלות. הערך צריך להיות גדול או שווה ל-90- וקטן או שווה ל-90. הערך ‎-90 מציין מבט ישירות למטה, והערך 90 מציין מבט ישירות למעלה. הערך NaN מציין כמות שלא נמדדה.
roll

number

גלגול, נמדד במעלות. הערך צריך להיות גדול או שווה ל-0 וקטן מ-360. הערך 0 מציין שהמצלמה נמצאת בגובה האופק. הערך NaN מציין כמות שלא נמדדה.
gpsRecordTimestampUnixEpoch

string (Timestamp format)

הזמן של רשומת ה-GPS מאז ראשית זמן UTC.

הפלט שנוצר תמיד יהיה בפורמט RFC 3339, עם נורמליזציה של Z ושימוש ב-0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים חוץ מ-Z. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
level

object (Level)

רמה (הקומה בבניין) שמשמשת להגדרת ניווט אנכי.
accuracyMeters

number

הדיוק האופקי המשוער של התנוחה הזו במטרים, עם רמת סמך של 68% (סטיית תקן אחת). לדוגמה, ב-Android, הערך הזה זמין מהשיטה הזו: https://developer.android.com/reference/android/location/Location#getAccuracy(). בפלטפורמות אחרות יש שיטות שונות להשגת הערכות דומות של רמת הדיוק.

LatLng

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

ייצוג ב-JSON 
{
  "latitude": number,
  "longitude": number
}
שדות
latitude

number

קו הרוחב במעלות. הערך צריך להיות בטווח [‎-90.0, ‎+90.0].
longitude

number

קו האורך במעלות. הערך חייב להיות בטווח [‎-180.0, ‎+180.0].

רמה

פרטי הרמה, כולל מספר הרמה והשם שלה.

ייצוג ב-JSON 
{
  "number": number,
  "name": string
}
שדות
number

number

אופציונלי. מספר הקומה, שמשמש למיון. ‫0 מציין את רמת הקרקע, 1 מציין את הרמה הראשונה מעל רמת הקרקע, ו-1- מציין את הרמה הראשונה מתחת לרמת הקרקע. מותר להשתמש בערכים לא שלמים.
name

string

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

חיבור

חיבור הוא הקישור מתמונת המקור לתמונת היעד.

ייצוג ב-JSON 
{
  "target": {
    object (PhotoId)
  }
}
שדות
target

object (PhotoId)

חובה. היעד של החיבור מהתמונה המכילה לתמונה אחרת.

מקום

מטא-נתונים של מקום לישות.

ייצוג ב-JSON 
{
  "placeId": string,
  "name": string,
  "languageCode": string
}
שדות
placeId

string

מזהה מקום, כפי שמתואר בכתובת https://developers.google.com/places/place-id.
name

string

פלט בלבד. שם המקום, מתורגם לשפה שצוינה ב-languageCode.
languageCode

string

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

TransferStatus

הסטטוס של העברת הזכויות.

טיפוסים בני מנייה (enum)
TRANSFER_STATUS_UNKNOWN לא צוין סטטוס ההעברה.
NEVER_TRANSFERRED התמונה הזו אף פעם לא נכללה בהעברה.
PENDING התחלתם להעביר את התמונות, אבל הנמען עדיין לא הגיב.
COMPLETED העברת התמונות הושלמה, והתמונה הזו הועברה לנמען.
REJECTED הנמען דחה את העברת התמונה הזו.
EXPIRED תוקף ההעברה של התמונות פג לפני שהנמען ביצע פעולה כלשהי.
CANCELLED השולח ביטל את העברת התמונות.
RECEIVED_VIA_TRANSFER הנמען הוא הבעלים של התמונה הזו בעקבות העברת זכויות.

MapsPublishStatus

סטטוס הפרסום של התמונה במפות Google.

טיפוסים בני מנייה (enum)
UNSPECIFIED_MAPS_PUBLISH_STATUS הסטטוס של התמונה לא ידוע.
PUBLISHED התמונה מתפרסמת לציבור דרך מפות Google.
REJECTED_UNKNOWN התמונה נדחתה מסיבה לא ידועה.

Methods

create

 אחרי שהלקוח מסיים להעלות את התמונה עם הערך UploadRef שמוחזר, CreatePhoto מפרסם את Photo שהועלה ב-Street View במפות Google.

delete

 מוחק את Photo ואת המטא-נתונים שלו.

get

 הפונקציה מקבלת את המטא-נתונים של Photo שצוין.

startUpload

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

update

 עדכון המטא-נתונים של Photo, כמו תנוחה, שיוך למקום, חיבורים וכו'.