- طلب HTTP
- مَعلمات المسار
- معامِلات طلب البحث
- نص الطلب
- نص الاستجابة
- نطاقات التفويض
- الدعوة
- TargetLocation:
- TargetType
يسرد الدعوات في انتظار المراجعة للحساب المحدّد.
طلب HTTP
GET https://mybusinessaccountmanagement.googleapis.com/v1/{parent=accounts/*}/invitations
يستخدِم عنوان URL بنية تحويل ترميز gRPC.
مَعلمات المسار
المَعلمات | |
---|---|
parent |
مطلوبة. اسم الحساب الذي يتم استرداد قائمة الدعوات منه. |
معلمات طلب البحث
المَعلمات | |
---|---|
filter |
اختياريّ. ويمكن تصفية الرد من خلال الحقل Invite.target_type. |
نص الطلب
يجب أن يكون نص الطلب فارغًا.
نص الاستجابة
رسالة رد لـ AccessControl.ListInvites.
إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:
تمثيل JSON |
---|
{
"invitations": [
{
object ( |
الحقول | |
---|---|
invitations[] |
مجموعة من الدعوات في انتظار المراجعة للحساب. لا يمكن أن يتجاوز عدد الدعوات هنا 1000 دعوة. |
نطاقات التفويض
يجب توفير نطاق OAuth التالي:
https://www.googleapis.com/auth/business.manage
لمزيد من المعلومات، راجِع نظرة عامة على بروتوكول OAuth 2.0.
دعوة
يمثل دعوة في انتظار المراجعة.
تمثيل JSON |
---|
{ "name": string, "role": enum ( |
الحقول | |
---|---|
name |
مطلوبة. اسم المورد للدعوة. |
role |
النتائج فقط. الدور المدعو في الحساب. |
targetType |
النتائج فقط. يحدّد أنواع الاستهداف التي يجب أن تظهر في الاستجابة. |
حقل الاتحاد target تشير إلى الهدف الموجّه لهذه الدعوة. يمكن أن تكون السمة "target " واحدة فقط مما يلي: |
|
targetAccount |
الحساب الذي تمت تعبئته بهذه الدعوة. |
targetLocation |
الموقع الجغرافي المستهدف الذي تم تخصيص هذه الدعوة له. |
TargetLocation
يمثل موقعًا مستهدفًا لدعوة في انتظار المراجعة.
تمثيل JSON |
---|
{ "locationName": string, "address": string } |
الحقول | |
---|---|
locationName |
اسم الموقع الجغرافي الذي تمت دعوة المستخدم إليه. |
address |
عنوان الموقع الجغرافي الذي تمت دعوة المستخدم إليه. |
TargetType
نوع الهدف المُخصّص للدعوة.
عمليات التعداد | |
---|---|
TARGET_TYPE_UNSPECIFIED |
يتم ضبطه عندما يكون نوع الاستهداف غير محدّد. |
ACCOUNTS_ONLY |
يمكنك سرد الدعوات فقط للأهداف من نوع الحساب. |
LOCATIONS_ONLY |
يمكنك سرد الدعوات فقط لاستهدافات من النوع "الموقع الجغرافي". |