Method: accounts.invitations.list

تعرض هذه الطريقة الدعوات في انتظار المراجعة للحساب المحدّد.

طلب HTTP

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

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

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

المعلمات
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 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)

الموقع الجغرافي الذي تم إرسال هذه الدعوة إليه

TargetLocation

يمثّل موقعًا جغرافيًا مستهدَفًا لدعوة في انتظار المراجعة.

تمثيل JSON 
{
  "locationName": string,
  "address": string,
  "placeId": string
}
الحقول
locationName

string

اسم الموقع الجغرافي الذي تمّت دعوة المستخدم إليه
address

string

عنوان الموقع الجغرافي الذي تمّت دعوة المستخدم إليه لا يتم ملء هذا الحقل دائمًا.
placeId

string

هذه القيمة للقراءة فقط. رقم تعريف المكان للموقع الجغرافي الذي تمّت دعوة المستخدم إليه لا يتم ملء هذا الحقل دائمًا.

TargetType

نوع الهدف الذي تم إرسال الدعوة إليه

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