Method: accounts.invitations.list

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

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

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

پارامترها
parent

string

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

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

پارامترها
filter

string

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

درخواست بدن

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

بدن پاسخگو

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

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

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

object ( Invitation )

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

محدوده مجوز

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

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

برای اطلاعات بیشتر، به نمای کلی OAuth 2.0 مراجعه کنید.

دعوتنامه

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

نمایندگی 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 )

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

TargetLocation

یک مکان هدف را برای یک دعوت معلق نشان می دهد.

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

string

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

address

string

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

TargetType

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

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