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 像素，且檔案大小至少要有 1,0240 個位元組。

所有上傳的相片都必須符合商家檔案規範。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。