Method: accounts.locations.list

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

HTTP リクエスト

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

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

パスパラメータ

パラメータ
parent

string

必須。ビジネスを取得するアカウントの名前です。親の [Account] [Account] [google.mybusiness.accountmanagement.v1.Account] が [AccountType] [google.mybusiness.accountmanagement.v1.Account.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 の概要をご覧ください。