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) 或價目表項目的 ID。

如要將新媒體新增至有 media.create 的地點，就必須提供這項資訊。如果是其他類型的媒體 (例如在地貼文中的相片)，則不會顯示這類資訊。
googleUrl

string

僅供輸出。這項媒體項目的 Google 代管網址。這個網址並非固定不變，可能會隨時間變更。如果是影片，則會是預覽圖片，並疊加播放圖示。
thumbnailUrl

string

僅供輸出。如果提供，這個媒體項目的縮圖網址。
createTime

string (Timestamp format)

僅供輸出。這個媒體項目的建立時間。

RFC3339 世界標準時間「Zulu」格式的時間戳記，解析度達奈秒單位，最多九個小數位數。例如："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
dimensions

object (Dimensions)

僅供輸出。尺寸 (寬度和高度)，單位為像素。
insights

object (MediaInsights)

僅供輸出。這個媒體項目的統計資料。
attribution

object (Attribution)

僅供輸出。客戶媒體項目的作者資訊。您必須向使用者顯示這項出處資訊，且不得刪除或修改。
description

string

這個媒體項目的說明。說明無法透過 Google 我的商家 API 修改，但可以在建立非封面相片的新媒體項目時設定。

聯集欄位 data。媒體項目的資料來源。建立新的媒體項目時，必須提供網址或資料參照。

除了 PROFILE 和 COVER 類別，所有相片的短邊必須至少為 250 像素，檔案大小至少為 10240 個位元組。

所有上傳的相片都應遵循商家檔案相片規範。data 只能是下列其中一項：
sourceUrl

string

可公開存取的網址，用於擷取媒體項目。

建立其中一個時，必須設定 dataRef 來指定媒體項目的來源。

如果在建立媒體項目時使用 sourceUrl，系統會在擷取媒體項目時填入該來源網址。

這個欄位無法更新。
dataRef

object (MediaItemDataRef)

僅供輸入。透過 media.startUpload 方法取得的媒體項目二進位資料參照。

建立媒體項目時，請

sourceUrl

或

dataRef

必須設定。

MediaItemDataRef

透過 Google My Business API 上傳的MediaItem相片二進位資料參照。

使用 media.startUpload 建立資料參照，並在將位元組上傳至 [media.upload] 時使用這個參照，然後呼叫 media.create。

JSON 表示法 
{
  "resourceName": string
}
欄位
resourceName

string

這個媒體項目二進位資料的專屬 ID。用於透過 [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

媒體格式的列舉。

列舉
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。地點媒體必須有類別，或與其相關聯的價目表項目 ID。非商家地點媒體 (例如當地商家資訊貼文相片) 則不得有這兩者。location_attachment_type 只能是下列其中一項：
category

enum (Category)

這張地點相片所屬的類別。
priceListItemId

string

與這張地點相片相關聯的價目表項目 ID。

類別

媒體項目類別的列舉。

列舉
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)

僅供輸出。媒體項目的瀏覽次數。

歸因

顧客媒體項目的出處資訊，例如投稿者姓名和個人資料相片。

JSON 表示法 
{
  "profileName": string,
  "profilePhotoUrl": string,
  "takedownUrl": string,
  "profileUrl": string
}
欄位
profileName

string

要將媒體項目歸給的使用者名稱。
profilePhotoUrl

string

獲取著作權使用者個人資料相片縮圖的網址。
takedownUrl

string

下架頁面的網址，使用者可以在該頁面檢舉不當的媒體項目。
profileUrl

string

歸因使用者的 Google 地圖個人資料頁面網址。

方法

create

 為地點建立新的媒體項目。

delete

 刪除指定媒體項目。

get

 傳回所要求媒體項目的中繼資料。

list

 傳回與地點相關聯的媒體項目清單。

patch

 更新指定媒體項目的中繼資料。

startUpload

 生成媒體項目上傳的 MediaItemDataRef。