الفهرس
AccessControl(واجهة)Accounts(واجهة)AcceptInvitationRequest(رسالة)Account(رسالة)Account.AccountRole(تعداد)Account.AccountType(تعداد)Account.OrganizationInfo(رسالة)Account.PermissionLevel(تعداد)Account.VerificationState(تعداد)Account.VettedState(تعداد)Admin(رسالة)Admin.AdminRole(تعداد)CreateAccountAdminRequest(رسالة)CreateAccountRequest(رسالة)CreateLocationAdminRequest(رسالة)DeclineInvitationRequest(رسالة)DeleteAccountAdminRequest(رسالة)DeleteLocationAdminRequest(رسالة)GetAccountRequest(رسالة)Invitation(رسالة)Invitation.TargetLocation(رسالة)Invitation.TargetType(تعداد)ListAccountAdminsRequest(رسالة)ListAccountAdminsResponse(رسالة)ListAccountsRequest(رسالة)ListAccountsResponse(رسالة)ListInvitationsRequest(رسالة)ListInvitationsResponse(رسالة)ListLocationAdminsRequest(رسالة)ListLocationAdminsResponse(رسالة)TransferLocationRequest(رسالة)UpdateAccountAdminRequest(رسالة)UpdateAccountRequest(رسالة)UpdateLocationAdminRequest(رسالة)
AccessControl
تتيح هذه الخدمة إدارة المستخدمين الذين لديهم إذن الوصول إلى الحسابات والمواقع الجغرافية.
| AcceptInvitation |
|---|
|
يتم قبول الدعوة المحددة.
|
| CreateAccountAdmin |
|---|
|
لدعوة المستخدم المحدَّد لكي يصبح مشرفًا للحساب المحدّد يجب أن يقبل المدعو الدعوة لكي يحصل على حق الوصول إلى الحساب. يمكنك الاطّلاع على [AcceptAccept] [google.mybusiness.accountmanagement.v1.AcceptInvite] لقبول الدعوة بشكل آلي.
|
| CreateLocationAdmin |
|---|
|
لدعوة المستخدم المحدَّد لكي يصبح مشرفًا للموقع الجغرافي المحدَّد. يجب أن يقبل المدعو الدعوة لكي يحصل على حق الوصول إلى الموقع الجغرافي. ويمكنك الاطّلاع على [Acceptجدي] [google.mybusiness.accountmangement.v1.Accept المحلية] لقبول الدعوة بطريقة آلية.
|
| DeclineInvitation |
|---|
|
يرفض الدعوة المحددة.
|
| DeleteAccountAdmin |
|---|
|
إزالة المشرف المحدَّد من الحساب المحدَّد.
|
| DeleteLocationAdmin |
|---|
|
إزالة المشرف المحدد كمدير للموقع الجغرافي المحدد.
|
| ListAccountAdmins |
|---|
|
يسرد المشرفين على الحساب المحدّد.
|
| ListInvitations |
|---|
|
يسرد الدعوات في انتظار المراجعة للحساب المحدّد.
|
| ListLocationAdmins |
|---|
|
يسرد جميع المشرفين في الموقع الجغرافي المحدَّد.
|
| TransferLocation |
|---|
|
ينقل موقعًا جغرافيًا من حساب يملكه المستخدم إلى حساب آخر يشرف عليه المستخدم نفسه. يجب أن يكون المستخدم مالكًا للحساب المرتبط به حاليًا ويجب أن يكون أيضًا مديرًا على الأقل لحساب الوجهة.
|
| UpdateAccountAdmin |
|---|
|
تحديث المشرف لمشرف الحساب المحدّد.
|
| UpdateLocationAdmin |
|---|
|
لتحديث المشرف للموقع الجغرافي المحدّد. لا يمكن تعديل سوى دور المشرف.
|
Accounts
تتيح واجهة برمجة التطبيقات هذه إدارة حسابات الأنشطة التجارية على Google. تحدّد هذه الطريقة نموذج الموارد التالي:
تتضمّن واجهة برمجة التطبيقات مجموعة من موارد الحساب باسم
accounts/*.لتسهيل الأمر، يمكنك استخدام مرادف "أنا" بدلاً من رقم تعريف الحساب للحساب الشخصي للمتصل الذي تمت المصادقة عليه. أمثلة: GET /v1/accounts/me GET /v1/accounts/me/locations
| CreateAccount |
|---|
|
ينشئ حسابًا بالاسم والنوع المحدّدين ضمن العنصر الرئيسي المحدّد.
|
| GetAccount |
|---|
|
الحصول على الحساب المحدد عرض
|
| ListAccounts |
|---|
|
يسرد جميع حسابات المستخدم الذي تمت مصادقته. ويشمل ذلك جميع الحسابات التي يملكها المستخدم، بالإضافة إلى أي حسابات يملك المستخدم حقوق إدارتها.
|
| UpdateAccount |
|---|
|
تعديل حساب النشاط التجاري المحدّد لا يمكن تحديث الحسابات الشخصية باستخدام هذه الطريقة.
|
AcceptInvitationRequest
طلب رسالة لـ AccessControl.Acceptجدي
| الحقول | |
|---|---|
name |
مطلوبة. اسم الدعوة التي تم قبولها. |
Account
الحساب هو حاوية لموقعك الجغرافي. إذا كنت المستخدم الوحيد الذي يدير المواقع الجغرافية لنشاطك التجاري، يمكنك استخدام حسابك الشخصي على Google. لمشاركة إدارة المواقع مع عدة مستخدمين، يمكنك إنشاء حساب نشاط تجاري.
| الحقول | |
|---|---|
name |
غير قابل للتغيير. اسم المورد بالتنسيق |
account_name |
مطلوبة. اسم الحساب بالنسبة إلى الحساب من النوع |
primary_owner |
مطلوبة. الإدخال فقط. اسم مورد الحساب الذي سيكون المالك الأساسي للحساب الذي يتم إنشاؤه يجب أن يكون بالشكل |
type |
مطلوبة. تحتوي على نوع الحساب. لا يمكن إنشاء حسابات من النوع PERSONAL وOrganization باستخدام واجهة برمجة التطبيقات هذه. |
role |
النتائج فقط. تُحدِّد "دور الحساب" لهذا الحساب. |
verification_state |
النتائج فقط. في حال إثبات ملكية المواقع الجغرافية التي سيتم إنشاؤها في المستقبل، يتم ربطها تلقائيًا بـ "خرائط Google"، ويتم إنشاء صفحاتها على Google+ ، بدون الحاجة إلى الإشراف. |
vetted_state |
النتائج فقط. يشير إلى ما إذا كانت Google قد تحقّقت من الحساب. يمكن للحساب الذي تم فحصه إثبات ملكية المواقع الجغرافية من خلال طريقة VETTED_PARTNER. |
account_number |
النتائج فقط. الرقم المرجعي للحساب إذا تم توفيره. |
permission_level |
النتائج فقط. يحدد مستوى الإذن الذي يمتلكه المستخدم لهذا الحساب. |
organization_info |
النتائج فقط. يمكنك الاطّلاع على معلومات إضافية لمؤسسة. وتتم تعبئة هذه البيانات لحساب مؤسسة فقط. |
AccountRole
تشير هذه السمة إلى مستوى الوصول الذي يملكه المستخدم الذي تمت مصادقته لهذا الحساب. لمزيد من المعلومات، يُرجى الاطّلاع على مقالة مركز المساعدة.
| عمليات التعداد | |
|---|---|
ACCOUNT_ROLE_UNSPECIFIED |
غير محدَّد. |
PRIMARY_OWNER |
هذا المستخدم هو المالك الأساسي لهذا الحساب. |
OWNER |
مالك الحساب |
MANAGER |
ويمكن للمستخدم إدارة هذا الحساب. |
SITE_MANAGER |
ويمكن للمستخدم إدارة مجموعة محدودة من الميزات للحساب. |
AccountType
يشير إلى نوع الحساب: إما حساب شخصي/حساب مستخدم أو حساب نشاط تجاري.
| عمليات التعداد | |
|---|---|
ACCOUNT_TYPE_UNSPECIFIED |
غير محدَّد. |
PERSONAL |
حساب مستخدم نهائي. |
LOCATION_GROUP |
مجموعة من المواقع الجغرافية. لمزيد من المعلومات، يُرجى الاطّلاع على مقالة مركز المساعدة. |
USER_GROUP |
مجموعة مستخدمين لفصل موظفي المؤسسة في مجموعات. لمزيد من المعلومات، يُرجى الاطّلاع على مقالة مركز المساعدة. |
ORGANIZATION |
مؤسسة تمثل شركة. لمزيد من المعلومات، يُرجى الاطّلاع على مقالة مركز المساعدة. |
OrganizationInfo
المعلومات الإضافية المخزَّنة لمؤسسة.
| الحقول | |
|---|---|
registered_domain |
النتائج فقط. النطاق المسجَّل للحساب. |
address |
النتائج فقط. العنوان البريدي للحساب |
phone_number |
النتائج فقط. رقم الاتصال بالمؤسسة |
PermissionLevel
تشير هذه السمة إلى مستوى الوصول الذي يملكه المستخدم الذي تمت مصادقته لهذا الحساب.
| عمليات التعداد | |
|---|---|
PERMISSION_LEVEL_UNSPECIFIED |
غير محدَّد. |
OWNER_LEVEL |
لدى المستخدم إذن على مستوى المالك. |
MEMBER_LEVEL |
لدى المستخدم إذن على مستوى العضو. |
VerificationState
يشير إلى حالة إثبات ملكية الحساب.
| عمليات التعداد | |
|---|---|
VERIFICATION_STATE_UNSPECIFIED |
غير محدَّد. |
VERIFIED |
تم إثبات ملكية الحساب. |
UNVERIFIED |
لم يتم إثبات ملكية الحساب، ولم يتم طلب إثبات الملكية. |
VERIFICATION_REQUESTED |
لم يتم إثبات ملكية هذا الحساب، ولكن تم طلب إثبات ملكيته. |
VettedState
يشير إلى حالة الحساب التي تم فحصها.
| عمليات التعداد | |
|---|---|
VETTED_STATE_UNSPECIFIED |
غير محدد |
NOT_VETTED |
لا تتحقّق Google من الحساب. |
VETTED |
تحقّقت Google من الحساب وأنّه بحالة صالحة. يتم فحص الحساب تلقائيًا إذا كان لديه إمكانية الوصول المباشر إلى حساب مجموعة تم فحصه. |
INVALID |
تم التحقّق من الحساب ولكنه في حالته غير صالحة. سيعمل هذا الحساب كحساب لم يتم فحصه. |
المشرف
مشرف حساب أو موقع جغرافي.
| الحقول | |
|---|---|
name |
غير قابل للتغيير. اسم المورد. بالنسبة إلى مشرفي الحساب، هذا هو النموذج: بالنسبة لمشرفي المواقع الجغرافية، هذا هو النموذج: وسيتم تجاهل هذا الحقل في حال ضبطه أثناء إنشاء المشرف. |
admin |
اختياريّ. اسم المشرف عند إرسال الدعوة الأولية، يكون هذا هو عنوان البريد الإلكتروني للمدعو. في مكالمات يجب ضبط هذا الحقل أثناء إنشاء المشرف فقط. |
account |
غير قابل للتغيير. اسم مورد الحساب الذي يشير إليه هذا "المشرف" يتم استخدامه عند استدعاء المواقع الجغرافية.admins.create لدعوة مشرف إلى مجموعة مواقع جغرافية. في حال ضبط كل من هذا الحقل واسم تنسيق الملف: |
role |
مطلوبة. يحدِّد الدور الذي يستخدمه هذا المشرف مع الحساب أو الموقع الجغرافي المحدّد. |
pending_invitation |
النتائج فقط. يشير إلى ما إذا كان لدى هذا المشرف دعوة في انتظار المراجعة للمورد المحدَّد. |
AdminRole
يشير إلى مستوى الوصول الذي يملكه المشرف. لمزيد من المعلومات، يُرجى الاطّلاع على مقالة مركز المساعدة.
| عمليات التعداد | |
|---|---|
ADMIN_ROLE_UNSPECIFIED |
غير محدَّد. |
PRIMARY_OWNER |
يمتلك المشرف إذن وصول على مستوى المالك وهو المالك الأساسي. (يتم عرضه كـ "مالك أساسي" في واجهة المستخدم). |
OWNER |
امتلاك المشرف لإذن وصول على مستوى المالك. (يظهر باسم "المالك" في واجهة المستخدم). |
MANAGER |
الحصول على إذن وصول إداري |
SITE_MANAGER |
يمكن للمشرف إدارة صفحات (Google+ ) الاجتماعية. (يتم عرضه كـ "مدير الموقع الجغرافي" في واجهة المستخدم). لا تسمح واجهة برمجة التطبيقات هذه بإنشاء مشرف حساب بدور SITE_Manager. |
CreateAccountAdminRequest
رسالة طلب لـ AccessControl.CreateAccountAdmin
| الحقول | |
|---|---|
parent |
مطلوبة. اسم المورد للحساب الذي تم إنشاء هذا المشرف له. |
admin |
مطلوبة. المشرف المطلوب إنشاؤه. لا يمكن أن يكون الدور SITE_Manager |
CreateAccountRequest
رسالة طلب لـ accounts.CreateAccount.
| الحقول | |
|---|---|
account |
مطلوبة. معلومات الحساب للحساب الذي سيتم إنشاؤه. الحقلان الوحيدان المسموح بهما هما الحساب والنوع. |
CreateLocationAdminRequest
طلب رسالة لـ AccessControl.CreateLocationAdmin
| الحقول | |
|---|---|
parent |
مطلوبة. اسم المورد للموقع الجغرافي الذي تم إنشاء هذا المشرف من أجله. |
admin |
مطلوبة. المشرف المطلوب إنشاؤه. |
DeclineInvitationRequest
طلب رسالة لـ AccessControl.Rejectletter.
| الحقول | |
|---|---|
name |
مطلوبة. اسم دعوة الحساب التي تم رفضها. |
DeleteAccountAdminRequest
طلب رسالة لـ AccessControl.DeleteAccountAdmin
| الحقول | |
|---|---|
name |
مطلوبة. اسم المورد للمشرف المطلوب إزالته من الحساب. |
DeleteLocationAdminRequest
طلب رسالة لـ AccessControl.DeleteLocationAdmin
| الحقول | |
|---|---|
name |
مطلوبة. اسم المورد للمشرف المطلوب إزالته من الموقع |
GetAccountRequest
رسالة طلب لـ accounts.GetAccount
| الحقول | |
|---|---|
name |
مطلوبة. اسم الحساب المطلوب جلبه |
دعوة
يمثل دعوة في انتظار المراجعة.
| الحقول | |
|---|---|
name |
مطلوبة. اسم المورد للدعوة. |
role |
النتائج فقط. الدور المدعو في الحساب. |
target_type |
النتائج فقط. يحدّد أنواع الاستهداف التي يجب أن تظهر في الاستجابة. |
حقل الاتحاد target تشير إلى الهدف الموجّه لهذه الدعوة. يمكن أن تكون السمة "target" واحدة فقط مما يلي: |
|
target_account |
الحساب الذي تمت تعبئته بهذه الدعوة. |
target_location |
الموقع الجغرافي المستهدف الذي تم تخصيص هذه الدعوة له. |
TargetLocation
يمثل موقعًا مستهدفًا لدعوة في انتظار المراجعة.
| الحقول | |
|---|---|
location_name |
اسم الموقع الجغرافي الذي تمت دعوة المستخدم إليه. |
address |
عنوان الموقع الجغرافي الذي تمت دعوة المستخدم إليه. |
TargetType
نوع الهدف المُخصّص للدعوة.
| عمليات التعداد | |
|---|---|
TARGET_TYPE_UNSPECIFIED |
يتم ضبطه عندما يكون نوع الاستهداف غير محدّد. |
ACCOUNTS_ONLY |
يمكنك سرد الدعوات فقط للأهداف من نوع الحساب. |
LOCATIONS_ONLY |
يمكنك سرد الدعوات فقط لاستهدافات من النوع "الموقع الجغرافي". |
ListAccountAdminsRequest
رسالة طلب لـ AccessControl.ListAccountAdmins.
| الحقول | |
|---|---|
parent |
مطلوبة. اسم الحساب الذي يمكن من خلاله استرداد قائمة المشرفين. |
ListAccountAdminsResponse
رسالة رد لـ AccessControl.ListAccountAdmins.
| الحقول | |
|---|---|
account_admins[] |
مجموعة من مثيلات المشرف. |
ListAccountsRequest
رسالة طلب لـ accounts.ListAccounts.
| الحقول | |
|---|---|
parent_account |
اختياريّ. اسم مورد الحساب الذي سيتم استرداد قائمة الحسابات التي يمكن الوصول إليها مباشرةً من خلاله. وهذا مفيد فقط للمؤسسات ومجموعات المستخدمين. في حال ترك هذا الحقل فارغًا، سيتم عرض |
page_size |
اختياريّ. عدد الحسابات المطلوب جلبها لكل صفحة. القيمة التلقائية والحد الأقصى هو 20. |
page_token |
اختياريّ. وفي حال تحديد ذلك، يتم استرداد الصفحة التالية من الحسابات. يتم عرض |
filter |
اختياريّ. فلتر يقيد الحسابات للعودة. لا يتضمن الرد سوى الإدخالات التي تتطابق مع الفلتر. إذا كانت قيمة الحقل " على سبيل المثال، سيؤدي الطلب الذي يتضمّن الفلتر والحقل |
ListAccountsResponse
رسالة الرد لـ accounts.ListAccounts.
| الحقول | |
|---|---|
accounts[] |
مجموعة من الحسابات التي يمكن للمستخدم الوصول إليها. سيكون الحساب الشخصي للمستخدم الذي يجري الاستعلام دائمًا هو العنصر الأول من النتيجة، ما لم تتم تصفيته. |
next_page_token |
إذا تجاوز عدد الحسابات حجم الصفحة المطلوب، ستتم تعبئة هذا الحقل برمز مميّز لجلب الصفحة التالية من الحسابات عند إجراء مكالمة لاحقة إلى |
ListInvitationsRequest
طلب رسالة لـ AccessControl.ListInvites.
| الحقول | |
|---|---|
parent |
مطلوبة. اسم الحساب الذي يتم استرداد قائمة الدعوات منه. |
filter |
اختياريّ. ويمكن تصفية الرد من خلال الحقل Invite.target_type. |
ListInvitationsResponse
رسالة رد لـ AccessControl.ListInvites.
| الحقول | |
|---|---|
invitations[] |
مجموعة من الدعوات في انتظار المراجعة للحساب. لا يمكن أن يتجاوز عدد الدعوات هنا 1000 دعوة. |
ListLocationAdminsRequest
طلب رسالة لـ AccessControl.ListLocationAdmins.
| الحقول | |
|---|---|
parent |
مطلوبة. اسم الموقع الجغرافي المطلوب إدراج المشرفين عليه. |
ListLocationAdminsResponse
رسالة رد لـ AccessControl.ListLocationAdmins.
| الحقول | |
|---|---|
admins[] |
مجموعة من المشرفين. |
TransferLocationRequest
طلب رسالة لـ AccessControl.TransferLocation.
| الحقول | |
|---|---|
name |
مطلوبة. اسم الموقع الجغرافي المطلوب نقله |
destination_account |
مطلوبة. اسم مورد الحساب المطلوب نقل الموقع الجغرافي إليه (على سبيل المثال، "accounts/{account}"). |
UpdateAccountAdminRequest
رسالة طلب لـ AccessControl.UpdateAccountAdmin
| الحقول | |
|---|---|
account_admin |
مطلوبة. الإصدار المُحدَّث من صفحة "المشرف" |
update_mask |
مطلوبة. الحقول المحددة التي يجب تعديلها. الحقل الوحيد القابل للتعديل هو الدور. |
UpdateAccountRequest
رسالة طلب لـ accounts.UpdateAccount.
| الحقول | |
|---|---|
account |
مطلوبة. الحساب المعدّل |
update_mask |
مطلوبة. الحقول المحددة التي يجب تعديلها. الحقل الوحيد القابل للتعديل هو |
validate_only |
اختياريّ. إذا كانت الإجابة "صحيح"، يتم التحقّق من صحة الطلب بدون تعديل الحساب فعليًا. |
UpdateLocationAdminRequest
طلب رسالة لـ AccessControl.UpdateLocationAdmin.
| الحقول | |
|---|---|
location_admin |
مطلوبة. الإصدار المُحدَّث من صفحة "المشرف" |
update_mask |
مطلوبة. الحقول المحددة التي يجب تعديلها. الحقل الوحيد القابل للتعديل هو الدور. |