Method: accounts.locations.list

指定したアカウントのビジネス情報を一覧表示します。

HTTP リクエスト

GET https://mybusinessbusinessinformation.googleapis.com/v1/{parent=accounts/*}/locations

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

パスパラメータ

パラメータ
parent

string

必須。ビジネスを取得するアカウントの名前です。

  • 特定のアカウント ID: アカウントのタイプが AccountType.PERSONAL の場合、レスポンスでは、そのアカウントが直接所有するビジネス情報のみが返されます。他のすべてのタイプ（AccountType.LOCATION_GROUP など）の場合、アクセス可能なすべてのロケーションが返されます。

  • ワイルドカード（-）: accounts/- を使用すると、認証済みユーザーが識別されます。このスコープのデフォルトは AccountType.PERSONAL ですが、直接所有しているロケーションと間接的に所有しているロケーション（メンバー グループ経由でアクセス可能なロケーションなど）の両方が含まれます。

クエリ パラメータ

パラメータ
pageSize

integer

省略可。1 ページあたりで取得するビジネス情報数です。設定しない場合、デフォルト値の 10 になります。最小値は 1、最大ページサイズは 100 です。
pageToken

string

省略可。指定すると、ビジネスの次の page が取得されます。ページトークンは、リクエストされたページサイズを上回る数のビジネスがある場合に、前回の locations.list の呼び出しによって返されます。
filter

string

省略可。返されるロケーションを制限するフィルタ。レスポンスには、フィルタに一致するエントリのみが含まれます。filter が空の場合、制約が適用され、リクエストされたアカウントのすべてのビジネス情報（ページ分割）が取得されます。

有効なフィールドと使用例については、位置情報の操作ガイドをご覧ください。
orderBy

string

省略可。リクエストの並べ替え順。複数のフィールドは、SQL 構文に従ってカンマ区切りにする必要があります。デフォルトの並べ替え順序は昇順です。降順を指定するには、接尾辞「desc」を追加する必要があります。orderBy で有効なフィールドは title と storeCode です。（例: 「title, storeCode desc」、「title」、「storeCode desc」）。
readMask

string (FieldMask format)

必須。レスポンスで返されるフィールドを指定する読み取りマスク。

完全修飾フィールド名のカンマ区切りリスト。例: "user.displayName,photo"。

リクエストの本文

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

レスポンスの本文

Locations.ListLocations のレスポンス メッセージ。

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

JSON 表現 
{
  "locations": [
    {
      object (Location)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
フィールド
locations[]

object (Location)

ロケーション。
nextPageToken

string

ビジネスの数がリクエストしたページサイズを超えた場合、このフィールドには、後続の locations.list の呼び出しでビジネスの次のページを取得するためのトークンが入力されます。取得するビジネス情報がそれ以上ない場合、このフィールドはレスポンスに含められません。
totalSize

integer

リスト内のビジネス情報の数（近似値）。ページ分けとは無関係です。このフィールドは、filter がクエリ パラメータとして使用されている場合にのみ返されます。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、OAuth 2.0 Overview をご覧ください。