REST Resource: accounts.locations.media

משאב: MediaItem

פריט מדיה אחד.

ייצוג JSON
{
  "name": string,
  "mediaFormat": enum (MediaFormat),
  "locationAssociation": {
    object (LocationAssociation)
  },
  "googleUrl": string,
  "thumbnailUrl": string,
  "createTime": string,
  "dimensions": {
    object (Dimensions)
  },
  "insights": {
    object (MediaInsights)
  },
  "attribution": {
    object (Attribution)
  },
  "description": string,

  // Union field data can be only one of the following:
  "sourceUrl": string,
  "dataRef": {
    object (MediaItemDataRef)
  }
  // End of list of possible types for union field data.
}
שדות
name

string

שם המשאב של פריט המדיה הזה. accounts/{accountId}/locations/{locationId}/media/{mediaKey}

mediaFormat

enum (MediaFormat)

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

locationAssociation

object (LocationAssociation)

חובה כשמתקשרים אל CreatePhoto. תיאור האופן שבו פריט המדיה הזה מחובר למיקום שלו. חייב להיות קטגוריה (לדוגמה, EXTERIOR) או מזהה של פריט מחירון.

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

googleUrl

string

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

thumbnailUrl

string

פלט בלבד. אם סופקה, כתובת ה-URL של תמונה ממוזערת של פריט המדיה הזה.

createTime

string (Timestamp format)

פלט בלבד. שעת היצירה של פריט המדיה הזה.

חותמת זמן בפורמט "זולו" RFC3339 UTC, ברזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".

dimensions

object (Dimensions)

פלט בלבד. המידות (רוחב וגובה) בפיקסלים.

insights

object (MediaInsights)

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

attribution

object (Attribution)

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

description

string

התיאור של פריט המדיה הזה. אי אפשר לשנות תיאורים דרך Google My Business API, אבל אפשר להגדיר אותם כשיוצרים פריט מדיה חדש שאינו תמונת שער.

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

למעט קטגוריות PROFILE ו-COVER, כל התמונות צריכות למדוד לפחות 250 פיקסלים בקצה הקצר, וגודל קובץ של 1,0240 בייטים לפחות.

כל התמונות שמעלים צריכות לעמוד בהנחיות להעלאת תמונות של 'פרופיל העסק ב-Google'. הערך של data יכול להיות רק אחת מהאפשרויות הבאות:

sourceUrl

string

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

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

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

אי אפשר לעדכן את השדה הזה.

dataRef

object (MediaItemDataRef)

קלט בלבד. הפניה לנתונים בינאריים של פריט מדיה כפי שהתקבלו באמצעות השיטה media.startUpload.

בעת יצירת פריט מדיה,

sourceUrl

או

dataRef

חייב להיות מוגדר.

MediaItemDataRef

הפניה לנתונים הבינאריים של התמונות של MediaItem שהועלו באמצעות Google My Business API.

צריך ליצור מאגר נתונים באמצעות media.startUpload ולהשתמש בהפניה הזו כשמעלים בייטים ל-[media.upload] ואז קריאה ל-media.create.

ייצוג JSON
{
  "resourceName": string
}
שדות
resourceName

string

המזהה הייחודי של הנתונים הבינאריים של פריט המדיה הזה. הנתונים משמשים להעלאת נתוני התמונות באמצעות [media.upload] ובעת יצירת פריט מדיה חדש מהבייטים האלה באמצעות media.create.

דוגמה להעלאת בייטים: curl -X POST -T{path_to_file} "http://mybusiness.googleapis.com/upload/v1/media/{resourceName}?uploadType=media"

לשיחות media.create, יש להגדיר זאת בתור MediaItem dataRef.

MediaFormat

Enum לפורמט מדיה.

טיפוסים בני מנייה (enums)
MEDIA_FORMAT_UNSPECIFIED הפורמט לא צוין.
PHOTO פריט המדיה הוא תמונה. בגרסה הזו יש תמיכה רק בתמונות.
VIDEO פריט המדיה הוא סרטון.

LocationAssociation

האופן שבו פריט המדיה משויך למיקום שלו.

ייצוג JSON
{

  // Union field location_attachment_type can be only one of the following:
  "category": enum (Category),
  "priceListItemId": string
  // End of list of possible types for union field location_attachment_type.
}
שדות
שדה איחוד location_attachment_type. המדיה של המיקום צריכה לכלול קטגוריה או מזהה של פריט מחירון שאליו היא משויכת. מדיה שלא מבוססת על מיקום (לדוגמה, תמונות של פוסטים מקומיים) לא יכולה לכלול אף אחת מהן. הערך של location_attachment_type יכול להיות רק אחת מהאפשרויות הבאות:
category

enum (Category)

הקטגוריה שאליה שייכת תמונת המיקום הזו.

priceListItemId

string

המזהה של פריט מחירון שאליו משויכת תמונת המיקום הזו.

קטגוריה

טיפוסים בני מנייה (enum) לקטגוריית פריט מדיה.

טיפוסים בני מנייה (enums)
CATEGORY_UNSPECIFIED הקטגוריה לא צוינה.
COVER תמונת השער. למיקום יש רק תמונת שער אחת.
PROFILE תמונת פרופיל. למיקום יש תמונת פרופיל אחת בלבד.
EXTERIOR מדיה חיצונית.
INTERIOR מדיה פנימית.
PRODUCT מדיה של המוצר.
AT_WORK מדיה בעבודה.
FOOD_AND_DRINK מדיה של מזון ומשקאות.
MENU מדיה בתפריט.
COMMON_AREA מדיה ציבורית.
ROOMS מדיה של חדרים.
TEAMS מדיה של Teams.
ADDITIONAL מדיה נוספת, ללא שיוך לקטגוריה.

מאפיינים

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

ייצוג JSON
{
  "widthPixels": integer,
  "heightPixels": integer
}
שדות
widthPixels

integer

הרוחב של פריט המדיה, בפיקסלים.

heightPixels

integer

הגובה של פריט המדיה, בפיקסלים.

MediaInsights

תובנות ונתונים סטטיסטיים לגבי פריט המדיה.

ייצוג JSON
{
  "viewCount": string
}
שדות
viewCount

string (int64 format)

פלט בלבד. מספר הפעמים שבהן פריט המדיה נצפה.

שיוך (Attribution)

פרטי שיוך של פריטי מדיה של לקוחות, כמו שם השותף ותמונת הפרופיל.

ייצוג JSON
{
  "profileName": string,
  "profilePhotoUrl": string,
  "takedownUrl": string,
  "profileUrl": string
}
שדות
profileName

string

שם המשתמש שאליו יש לשייך את פריט המדיה.

profilePhotoUrl

string

כתובת ה-URL של תמונת הפרופיל של המשתמש המשויך.

takedownUrl

string

כתובת ה-URL של דף ההסרה, שבו ניתן לדווח על פריט המדיה אם הוא בלתי הולם.

profileUrl

string

כתובת ה-URL של דף הפרופיל של המשתמש המשויך במפות Google.

שיטות

create

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

delete

מחיקת פריט המדיה שצוין.

get

מחזירה מטא-נתונים של פריט המדיה המבוקש.

list

מחזירה רשימה של פריטי מדיה שמשויכים למיקום מסוים.

patch

עדכון המטא-נתונים של פריט המדיה שצוין.

startUpload

יוצר MediaItemDataRef להעלאת פריט מדיה.