Business Profile Performance API 现已发布!必须执行迁移工作。
查看弃用时间表以及相关说明,了解如何从旧版 v4 API 迁移到新的 v1 API。
请填写此调查问卷,帮助我们更好地了解您支持哪些商家的地点、菜单和菜品属性,从而帮助我们改善食品菜单体验

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。媒体项的数据源。创建新的媒体项时,必须提供网址或数据引用。

PROFILECOVER 类别之外,所有照片的短边尺寸必须至少为 250 像素,文件大小至少为 10240 字节。

上传的所有照片均应符合商家资料中的商家资料准则data 只能是下列其中一项:

sourceUrl

string

可从中检索媒体项的可公开访问网址。

创建其中一项时,必须设置 dataRef 以指定媒体项的来源。

如果在创建媒体项时使用 sourceUrl,则系统会在检索媒体项时用该来源网址进行填充。

此字段无法更新。

dataRef

object (MediaItemDataRef)

仅限输入。对通过 media.startUpload 方法获取的媒体项二进制数据的引用。

创建媒体项时,

sourceUrl

dataRef

媒体项数据引用

引用通过 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

媒体格式

媒体格式的枚举。

枚举
MEDIA_FORMAT_UNSPECIFIED 未指定格式。
PHOTO 媒体项是照片。此版本仅支持照片。
VIDEO 媒体项是一个视频。

位置关联

媒体项与其位置之间的关联方式。

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