Method: accounts.invitations.list

指定したアカウントで保留中の招待を一覧表示します。

HTTP リクエスト

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

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

パスパラメータ

パラメータ
parent

string

招待のリストを取得するアカウントの名前。

クエリ パラメータ

パラメータ
targetType

enum (TargetType)

レスポンスに含めるターゲット タイプを指定します。

リクエスト本文

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

レスポンスの本文

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

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

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

object (Invitation)

アカウントで保留になっているビジネスへの招待のコレクションです。ここにリストされる招待の数は 1,000 を超えることはできません。

認可スコープ

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

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

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

TargetType

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

列挙型
ALL すべてのターゲット タイプの招待をリストします。これがデフォルトです。
ACCOUNTS_ONLY タイプが「アカウント」のターゲットに対してのみ、招待状をリストします。
LOCATIONS_ONLY タイプが「地域」のターゲットの招待のみをリストに表示します。