Method: accounts.invitations.list

Belirtilen hesap için bekleyen davetiyeleri listeler.

HTTP isteği

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

URL, gRPC Kod Dönüştürme söz dizimini kullanır.

Yol parametreleri

Parametreler
parent

string

Zorunlu. Davetiye listesinin alındığı hesabın adı. accounts/{account_id}/invitations.

Sorgu parametreleri

Parametreler
filter

string

İsteğe bağlı. Yanıtın filtrelenmesi Davetiye.target_type alanı aracılığıyla desteklenir.

İstek içeriği

İstek metni boş olmalıdır.

Yanıt gövdesi

AccessControl.ListInvites için yanıt mesajı.

Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:

JSON gösterimi 
{
  "invitations": [
    {
      object (Invitation)
    }
  ]
}
Alanlar
invitations[]

object (Invitation)

Hesap için beklemede olan bir davetiye koleksiyonu. Burada listelenen davetiye sayısı 1000'den fazla olamaz.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

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

Daha fazla bilgi için OAuth 2.0 Overview (OAuth 2.0'a Genel Bakış) sayfasına göz atın.

Davetiye

Beklemedeki bir davetiyeyi temsil eder.

JSON gösterimi 
{
  "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.
}
Alanlar
name

string

Zorunlu. Davetiyenin kaynak adı. accounts/{account_id}/invitations/{invitation_id}.
role

enum (AdminRole)

Yalnızca çıkış. Hesaptaki davet edilen rol.
targetType

enum (TargetType)

Yalnızca çıkış. Yanıtta hangi hedef türlerinin görünmesi gerektiğini belirtir.
Birleştirme alanı target. Bu davetiyenin hedefini belirtir. target şunlardan yalnızca biri olabilir:
targetAccount

object (Account)

Bu davetiyenin kullanım alanı çok az olan hesap.
targetLocation

object (TargetLocation)

Bu davetiyenin bulunduğu hedef konum.

TargetLocation

Beklemedeki bir davetiye için hedef konumu temsil eder.

JSON gösterimi 
{
  "locationName": string,
  "address": string
}
Alanlar
locationName

string

Kullanıcının davet edildiği konumun adı.
address

string

Kullanıcının davet edildiği konumun adresi.

TargetType

Bir davetiyenin ait olduğu hedefin türü.

Sıralamalar
TARGET_TYPE_UNSPECIFIED Hedef türü belirtilmediyse ayarlayın.
ACCOUNTS_ONLY Yalnızca hesap türündeki hedefler için davetiyeleri listeleyin.
LOCATIONS_ONLY Yalnızca Konum türündeki hedefler için davetiyeleri listeleyin.