Method: accounts.invitations.list

指定したアカウントについて、承認待ちとなっている招待の一覧を取得します。

HTTP リクエスト

GET https://mybusinessaccountmanagement.googleapis.com/v1/{parent=accounts/*}/invitations

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

パスパラメータ

パラメータ
parent

string

必須。招待状の一覧を取得するアカウントの名前。accounts/{account_id}/invitations

クエリ パラメータ

パラメータ
filter

string

省略可。レスポンスのフィルタリングは、Invitation.target_type フィールドでサポートされています。

リクエストの本文

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

レスポンスの本文

AccessControl.ListInvitations に対するレスポンス メッセージ。

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

JSON 表現 
{
  "invitations": [
    {
      object (Invitation)
    }
  ]
}
フィールド
invitations[]

object (Invitation)

アカウントで承認待ちとなっている招待状のコレクション。ここに一覧表示できる招待数は最大 1,000 件です。

認可スコープ

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

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

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

調査依頼メール

保留中の招待状を表します。

JSON 表現 
{
  "name": string,
  "role": enum (AdminRole),
  "targetType": enum (TargetType),

  // Union field target can be only one of the following:
  "targetAccount": {
    object (Account)
  },
  "targetLocation": {
    object (TargetLocation)
  }
  // End of list of possible types for union field target.
}
フィールド
name

string

必須。招待状のリソース名。accounts/{account_id}/invitations/{invitation_id}。
role

enum (AdminRole)

出力専用。招待されるアカウントの役割です。
targetType

enum (TargetType)

出力専用。レスポンスにどの送り先タイプを表示するかを指定します。
共用体フィールド target。この招待の対象となるターゲットを表します。target は次のいずれかになります。
targetAccount

object (Account)

この招待状の対象となるアカウントです。ところどころ情報が入力されています。
targetLocation

object (TargetLocation)

この招待状の対象となるビジネスです。

TargetLocation

保留中の招待状の対象ビジネスを表します。

JSON 表現 
{
  "locationName": string,
  "address": string,
  "placeId": string
}
フィールド
locationName

string

ユーザーが招待されているビジネスの名前。
address

string

ユーザーが招待されている場所の住所。必ずしも入力されるとは限りません。
placeId

string

出力専用。ユーザーが招待されているビジネスのプレイス ID。必ずしも入力されるとは限りません。

TargetType

招待状の送り先のタイプです。

列挙型
TARGET_TYPE_UNSPECIFIED ターゲット タイプが指定されていない場合に設定します。
ACCOUNTS_ONLY タイプ「Account」を送り先とする招待状のみを一覧表示します。
LOCATIONS_ONLY タイプ「Location」を送り先とする招待状のみを一覧表示します。