Method: accounts.invitations.list

يسرد الدعوات في انتظار المراجعة للحساب المحدّد.

طلب HTTP

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

يستخدِم عنوان URL بنية تحويل ترميز gRPC.

مَعلمات المسار

المَعلمات
parent

string

مطلوبة. اسم الحساب الذي يتم استرداد قائمة الدعوات منه. accounts/{account_id}/invitations

معلمات طلب البحث

المَعلمات
filter

string

اختياريّ. ويمكن تصفية الرد من خلال الحقل Invite.target_type.

نص الطلب

يجب أن يكون نص الطلب فارغًا.

نص الاستجابة

رسالة رد لـ AccessControl.ListInvites.

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

تمثيل 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

نوع الهدف المُخصّص للدعوة.

عمليات التعداد
TARGET_TYPE_UNSPECIFIED يتم ضبطه عندما يكون نوع الاستهداف غير محدّد.
ACCOUNTS_ONLY يمكنك سرد الدعوات فقط للأهداف من نوع الحساب.
LOCATIONS_ONLY يمكنك سرد الدعوات فقط لاستهدافات من النوع "الموقع الجغرافي".