Method: accounts.locations.list

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

HTTP リクエスト

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

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

パスパラメータ

パラメータ
parent

string

ビジネスを取得するアカウントの名前です。AccountAccountType PERSONAL である場合は、アカウントが直接所有しているビジネスのみが返されます。それ以外の場合は、アカウントから直接、または間接的に、アクセス可能なすべてのビジネスが返されます。

クエリ パラメータ

パラメータ
pageSize

integer

1 ページあたりで取得するビジネス情報の数。デフォルトは 100 で、最小値は 1、最大ページサイズは 100 です。

pageToken

string

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

filter

string

返されるビジネス情報を限定するフィルタ。レスポンスには、フィルタに一致するエントリのみが含まれます。filter が空の場合、リクエストされたアカウントについて制約が適用され、すべてのビジネス(ページ分けされたもの)が取得されます。

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

languageCode
(deprecated)

string

位置情報のプロパティを表示する言語の BCP 47 コードです。この言語を利用できない場合は、地域の言語で提供されます。どちらも利用できない場合は、英語で提供されます。

非推奨です。2020 年 8 月 15 日を過ぎると、このフィールドは適用されません。代わりに、常に地域の言語が使用されます。

orderBy

string

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

リクエスト本文

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

レスポンスの本文

成功すると、レスポンスの本文に次の構造のデータが含まれます。

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

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

object (Location)

ビジネス情報。

nextPageToken

string

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

totalSize

integer

ページ分けに関係なく、リスト内のビジネスのおおよその数です。

認可スコープ

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

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

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