指定したアカウントのビジネスを一覧表示します。
HTTP リクエスト
GET https://mybusiness.googleapis.com/v4/{parent=accounts/*}/locations
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ | |
---|---|
parent |
ビジネスを取得するアカウントの名前です。 |
クエリ パラメータ
パラメータ | |
---|---|
pageSize |
1 ページあたりで取得するビジネス情報の数。デフォルトは 100 で、最小値は 1、最大ページサイズは 100 です。 |
pageToken |
指定すると、ビジネスの次の |
filter |
返されるビジネス情報を限定するフィルタ。レスポンスには、フィルタに一致するエントリのみが含まれます。 有効なフィールドと使用例について詳しくは、位置情報の使用に関するガイドをご覧ください。 |
languageCode |
位置情報のプロパティを表示する言語の BCP 47 コードです。この言語を利用できない場合は、地域の言語で提供されます。どちらも利用できない場合は、英語で提供されます。 非推奨です。2020 年 8 月 15 日を過ぎると、このフィールドは適用されません。代わりに、常に地域の言語が使用されます。 |
orderBy |
リクエストの並べ替え順。複数のフィールドは、SQL 構文に従ってカンマで区切ってください。デフォルトの並べ替え順は昇順です。降順を指定するには、接尾辞「desc」を追加する必要があります。orderBy の有効なフィールドは locationName と storeCode です。例: 「locationName, storeCode desc」、「locationName」、「storeCode desc」 |
リクエスト本文
リクエストの本文は空にする必要があります。
レスポンスの本文
成功すると、レスポンスの本文に次の構造のデータが含まれます。
Locations.ListLocations に対するレスポンス メッセージです。
JSON 表現 | |
---|---|
{
"locations": [
{
object ( |
フィールド | |
---|---|
locations[] |
ビジネス情報。 |
nextPageToken |
ビジネスの数がリクエストしたページサイズを超えた場合、このフィールドには、後続の |
totalSize |
ページ分けに関係なく、リスト内のビジネスのおおよその数です。 |
認可スコープ
次の OAuth スコープのいずれかが必要です。
https://www.googleapis.com/auth/plus.business.manage
https://www.googleapis.com/auth/business.manage
詳細については、OAuth 2.0 の概要をご覧ください。