指定したアカウントのビジネスを一覧表示します。
HTTP リクエスト
GET https://mybusinessbusinessinformation.googleapis.com/v1/{parent=accounts/*}/locations
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ | |
---|---|
parent |
必須。ビジネスを取得するアカウントの名前です。親の [Account] [Account] [google.mybusiness.accountmanagement.v1.Account] が [AccountType] [google.mybusiness.accountmanagement.v1.Account.AccountType] PERSONAL の場合は、アカウントで直接所有しているビジネスのみが返されます。それ以外の場合は、アカウントからアクセス可能なすべてのビジネス情報が、直接的または間接的に返されます。 |
クエリ パラメータ
パラメータ | |
---|---|
pageSize |
(省略可)1 ページあたりで取得するビジネス情報の数。設定しない場合、デフォルト値の 10 になります。最小値は 1、最大ページサイズは 100 です。 |
pageToken |
(省略可)指定すると、ビジネスの次の |
filter |
(省略可)返されるビジネス情報を限定するフィルタ。レスポンスには、フィルタに一致するエントリのみが含まれます。 有効なフィールドと使用例について詳しくは、位置情報の使用に関するガイドをご覧ください。 |
orderBy |
(省略可)リクエストの並べ替え順。複数のフィールドは、SQL 構文に従ってカンマで区切ってください。デフォルトの並べ替え順は昇順です。降順を指定するには、接尾辞「desc」を追加する必要があります。orderBy の有効なフィールドは title と storeCode です。例: 「title, storeCode desc」、「title」、「storeCode desc」 |
readMask |
必須。マスクを読み取って、レスポンスで返されるフィールドを指定します。 完全修飾フィールド名のカンマ区切りリストです。(例: |
リクエスト本文
リクエストの本文は空にする必要があります。
レスポンスの本文
Locations.ListLocations に対するレスポンス メッセージです。
成功すると、レスポンスの本文に次の構造のデータが含まれます。
JSON 表現 |
---|
{
"locations": [
{
object ( |
フィールド | |
---|---|
locations[] |
ビジネス情報。 |
nextPageToken |
ビジネスの数がリクエストしたページサイズを超えた場合、このフィールドには、後続の |
totalSize |
ページ分けに関係なく、リスト内のビジネスのおおよその数です。このフィールドは、 |
認可スコープ
次の OAuth スコープが必要です。
https://www.googleapis.com/auth/business.manage
詳細については、OAuth 2.0 の概要をご覧ください。