Method: accounts.invitations.list

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

HTTP リクエスト

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

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

パスパラメータ

パラメータ
parent

string

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

クエリ パラメータ

パラメータ
targetType

enum (TargetType)

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

リクエスト本文

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

レスポンスの本文

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

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

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 Location タイプの招待のみを一覧表示します。