- طلب HTTP
- مَعلمات المسار
- معامِلات طلب البحث
- نص الطلب
- نص الاستجابة
- نطاقات التفويض
- دعوة
- TargetLocation
- TargetType
يسرد الدعوات في انتظار المراجعة للحساب المحدّد.
طلب HTTP
GET https://mybusinessaccountmanagement.googleapis.com/v1/{parent=accounts/*}/invitations
يستخدِم عنوان URL بنية تحويل ترميز gRPC.
مَعلمات المسار
المعلمات | |
---|---|
parent |
مطلوب. اسم الحساب الذي يتم استرداد قائمة الدعوات منه. |
معامِلات طلب البحث
المعلمات | |
---|---|
filter |
اختياريّ. تتوفّر فلترة الردّ من خلال الحقل Invite.target_type. |
نص الطلب
يجب أن يكون نص الطلب فارغًا.
نص الاستجابة
رسالة استجابة لـ AccessControl.List Invites.
إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:
تمثيل 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 |
أدرِج الدعوات للأهداف من نوع الموقع الجغرافي فقط. |