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 世界协调时间（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。媒体项的数据源。创建新的媒体项时，必须提供网址或数据引用。

除 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。