Method: accounts.invitations.list

Mencantumkan undangan yang menunggu keputusan untuk akun tertentu.

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
parent

string

Wajib. Nama akun tempat daftar undangan diambil. accounts/{account_id}/invitations

Parameter kueri

Parameter
filter

string

Opsional. Memfilter respons didukung melalui kolom Undangan.target_type.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Pesan respons untuk AccessControl.ListInvitations.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "invitations": [
    {
      object (Invitation)
    }
  ]
}
Kolom
invitations[]

object (Invitation)

Kumpulan undangan yang tertunda untuk akun. Jumlah undangan yang tercantum di sini tidak boleh lebih dari 1.000.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut ini:

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

Untuk informasi selengkapnya, lihat Ringkasan OAuth 2.0.

Undangan

Merepresentasikan undangan yang menunggu keputusan.

Representasi 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.
}
Kolom
name

string

Wajib. Nama resource untuk undangan. accounts/{account_id}/invitations/{invitation_id}.
role

enum (AdminRole)

Hanya output. Peran yang diundang di akun.
targetType

enum (TargetType)

Hanya output. Menentukan jenis target yang akan muncul dalam respons.
Kolom union target. Menunjukkan target yang akan menerima undangan ini. target hanya ada berupa salah satu diantara berikut:
targetAccount

object (Account)

Akun yang jarang diisi yang akan menerima undangan ini.
targetLocation

object (TargetLocation)

Target lokasi yang akan menerima undangan ini.

TargetLocation

Merepresentasikan lokasi target untuk undangan yang menunggu keputusan.

Representasi JSON 
{
  "locationName": string,
  "address": string
}
Kolom
locationName

string

Nama lokasi tempat pengguna diundang.
address

string

Alamat lokasi tempat pengguna diundang.

TargetType

Untuk jenis target undangan.

Enum
TARGET_TYPE_UNSPECIFIED Tetapkan saat jenis target tidak ditentukan.
ACCOUNTS_ONLY Daftar undangan hanya untuk target jenis Akun.
LOCATIONS_ONLY Daftar undangan hanya untuk target jenis Lokasi.