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」格式的時間戳記，採用奈秒解析度，且最多 9 個小數位數。範例："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。媒體項目的資料來源。建立新的媒體項目時，必須提供網址或資料參照。

除了 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 團隊媒體。
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 用於上傳媒體項目。