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 の概要をご覧ください。

招待

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

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
}
フィールド
locationName

string

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

string

ユーザーが招待されているビジネスの住所。

TargetType

招待の対象となるターゲットのタイプ。

列挙型
TARGET_TYPE_UNSPECIFIED ターゲット タイプが指定されていない場合に設定されます。
ACCOUNTS_ONLY タイプが「アカウント」のターゲットに対してのみ、招待状をリストします。
LOCATIONS_ONLY タイプが「地域」のターゲットの招待のみをリストに表示します。