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. Davet listesinin alındığı hesabın adı. accounts/{account_id}/invitations

Sorgu parametreleri

Parametreler
filter

string

İsteğe bağlı. Yanıtın filtrelenmesi, Invitation.target_type alanı üzerinden desteklenir.

İstek metni

İstek metni boş olmalıdır.

Yanıt metni

AccessControl.ListInvitations 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 bekleyen davetiyelerin koleksiyonu. Burada listelenen davetiye sayısı 1.000'i aşamaz.

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 sayfasına bakın.

Davetiye

Bekleyen bir davetiye olduğunu gösterir.

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üneceğini belirtir.

target birleşik alanı. Bu davetiyenin hedefi gösterilir. target aşağıdakilerden yalnızca biri olabilir:
targetAccount

object (Account)

Bu davetin gönderildiği, seyrek doldurulmuş hesap.

targetLocation

object (TargetLocation)

Bu davetiyenin hedef konumu.

TargetLocation

Bekleyen bir davetiye için hedef konumu temsil eder.

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

string

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

address

string

Kullanıcının davet edildiği konumun adresi. Her zaman doldurulmaz.

placeId

string

Yalnızca çıkış. Kullanıcının davet edildiği konumun yer kimliği. Her zaman doldurulmaz.

TargetType

Davetiyenin hedef türü.

Sıralamalar
TARGET_TYPE_UNSPECIFIED Hedef türü belirtilmediğinde ayarlanır.
ACCOUNTS_ONLY Yalnızca Hesap türündeki hedefler için davetleri listeleyin.
LOCATIONS_ONLY Yalnızca Konum türündeki hedefler için davetiyeleri listeler.