Method: accounts.locations.media.list

ビジネスに関連付けられたメディア アイテムのリストを返します。

HTTP リクエスト

GET https://mybusiness.googleapis.com/v4/{parent=accounts/*/locations/*}/media

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
parent

string

メディア アイテムを一覧表示するビジネスの名前です。

クエリ パラメータ

パラメータ
pageSize

integer

1 ページあたりで返すメディア アイテム数です。デフォルト値は 100 です。この値は、Google My Business API でビジネス情報に追加できるメディア アイテムの最大数でもあります。ページの最大サイズは 2,500 です。

pageToken

string

指定すると、メディア アイテムの次のページを返します。

リクエスト本文

リクエストの本文は空にする必要があります。

レスポンスの本文

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

Media.ListMediaItems に対するレスポンス メッセージです。

JSON 表現
{
  "mediaItems": [
    {
      object (MediaItem)
    }
  ],
  "totalMediaItemCount": integer,
  "nextPageToken": string
}
フィールド
mediaItems[]

object (MediaItem)

返されるメディア アイテムのリストです。

totalMediaItemCount

integer

このビジネスのメディア アイテムの合計数です。ページ分けとは無関係です。

nextPageToken

string

リクエストしたページサイズを上回る数のメディア アイテムがある場合、このフィールドには、後続の media.list の呼び出しでメディア アイテムの次のページを取得するためのトークンが入力されます。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

詳しくは、OAuth 2.0 の概要をご覧ください。