Method: accounts.invitations.list

دعوت‌نامه‌های در انتظار برای حساب مشخص‌شده را فهرست می‌کند.

درخواست HTTP

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

این URL از سینتکس Transcoding در gRPC استفاده می‌کند.

پارامترهای مسیر

پارامترها
parent

string

الزامی. نام حسابی که لیست دعوت‌نامه‌ها از آن بازیابی می‌شود. accounts/{account_id}/invitations

پارامترهای پرس و جو

پارامترها
filter

string

اختیاری. فیلتر کردن پاسخ از طریق فیلد Invitation.target_type پشتیبانی می‌شود.

درخواست بدنه

بدنه درخواست باید خالی باشد.

بدنه پاسخ

پیام پاسخ برای AccessControl.ListInvitations.

در صورت موفقیت، بدنه پاسخ شامل داده‌هایی با ساختار زیر است:

نمایش JSON 
{
  "invitations": [
    {
      object (Invitation)
    }
  ]
}
فیلدها
invitations[]

object ( Invitation )

مجموعه‌ای از دعوت‌نامه‌هایی که برای حساب کاربری در انتظار دریافت هستند. تعداد دعوت‌نامه‌های ذکر شده در اینجا نمی‌تواند از ۱۰۰۰ تجاوز کند.

دامنه‌های مجوز

به محدوده OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، بهOAuth 2.0 Overview .

دعوتنامه

نشان دهنده یک دعوتنامه در انتظار است.

نمایش 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.
}
فیلدها
name

string

الزامی. نام منبع برای دعوتنامه. accounts/{account_id}/invitations/{invitation_id} .

role

enum ( AdminRole )

فقط خروجی. نقش دعوت‌شده در حساب.

targetType

enum ( TargetType )

فقط خروجی. مشخص می‌کند که کدام نوع‌های هدف باید در پاسخ ظاهر شوند.

target اتحادیه. نشان می‌دهد که این دعوتنامه برای چه کسی است. target می‌تواند فقط یکی از موارد زیر باشد:
targetAccount

object ( Account )

این دعوتنامه برای حساب کاربری کم‌جمعیتی است.

targetLocation

object ( TargetLocation )

مکان مورد نظر برای این دعوتنامه.

مکان هدف

نشان دهنده یک مکان هدف برای یک دعوتنامه در انتظار است.

نمایش JSON 
{
  "locationName": string,
  "address": string,
  "placeId": string
}
فیلدها
locationName

string

نام مکانی که کاربر به آن دعوت شده است.

address

string

آدرس مکانی که کاربر به آن دعوت شده است. همیشه پر نیست.

placeId

string

فقط خروجی. شناسه مکان مکانی که کاربر به آن دعوت شده است. همیشه پر نیست.

نوع هدف

نوع مخاطبی که دعوتنامه برای او ارسال شده است.

انوم‌ها
TARGET_TYPE_UNSPECIFIED زمانی تنظیم می‌شود که نوع هدف مشخص نشده باشد.
ACCOUNTS_ONLY دعوت‌نامه‌ها را فقط برای اهداف از نوع حساب کاربری فهرست کنید.
LOCATIONS_ONLY دعوت‌نامه‌ها را فقط برای اهداف از نوع مکان فهرست کنید.