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 がホストする URL です。この URL は後で変更される可能性があるため、静的なものではありません。動画の場合は、再生アイコンがオーバーレイされたプレビュー画像になります。
thumbnailUrl

string

出力専用。提供されている場合は、このメディア アイテムのサムネイル画像の URL になります。
createTime

string (Timestamp format)

出力専用。このメディア アイテムの作成時間。

RFC3339 UTC「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。メディア アイテムのデータソース。新しいメディア アイテムの作成時に、URL またはデータ参照を指定する必要があります。

PROFILE および COVER カテゴリを除き、すべての写真は短辺が 250 ピクセル以上で、ファイルサイズが 10,240 バイト以上である必要があります。

アップロードする写真はすべて、ビジネス プロフィールの写真に関するガイドラインに準拠している必要があります。data は次のいずれかになります。
sourceUrl

string

メディア アイテムを取得可能な、一般公開されている URL です。

メディア アイテムの作成時には、この sourceurl か dataRef のいずれかを参照元として指定してください。

メディア アイテムの作成時に sourceUrl を使用した場合は、メディア アイテムが取得されるときにそのソース URL が入力されます。

このフィールドは更新できません。
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 カバー写真。ビジネスに指定できるカバー写真は 1 枚のみです。
PROFILE プロフィール写真。ビジネスに指定できるプロフィール写真は 1 枚のみです。
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

帰属先ユーザーのプロフィール写真のサムネイルの URL。
takedownUrl

string

不適切なメディア アイテムを報告できる削除ページの URL です。
profileUrl

string

帰属先ユーザーの Google マップ プロフィール ページの URL です。

メソッド

create

 ビジネスの新しいメディア アイテムを作成します。

delete

 指定したメディア アイテムを削除します。

get

 リクエストされたメディア アイテムのメタデータを返します。

list

 ビジネスに関連付けられているメディア アイテムの一覧を返します。

patch

 指定したメディア アイテムのメタデータを更新します。

startUpload

 メディア アイテムをアップロードするための MediaItemDataRef を生成します。