مرجع Sign in with Google JavaScript API

تصف صفحة المرجع هذه واجهة برمجة التطبيقات JavaScript الخاصة بخدمة "تسجيل الدخول باستخدام حساب Google"، والتي تُستخدَم لعرض الزر "تسجيل الدخول باستخدام حساب Google" أو طلب نقرة واحدة على صفحات الويب.

الطريقة: google.accounts.id.initialize

يُهيئ الإجراء google.accounts.id.initialize برنامج "تسجيل الدخول باستخدام حساب Google" استنادًا إلى عنصر الإعدادات. اطّلِع على مثال الرمز التالي الخاص بالطريقة:

google.accounts.id.initialize(IdConfiguration)

ينفّذ مثال الرمز البرمجي التالي طريقة google.accounts.id.initialize باستخدام دالة onload:

<script>
  window.onload = function () {
    google.accounts.id.initialize({
      client_id: 'YOUR_GOOGLE_CLIENT_ID',
      callback: handleCredentialResponse
    });
    google.accounts.id.prompt();
  };
</script>

تنشئ الطريقة google.accounts.id.initialize مثيلاً لبرنامج تسجيل الدخول باستخدام حساب Google يمكن استخدامه ضمنيًا من خلال جميع الوحدات في صفحة الويب نفسها.

• ما عليك سوى استدعاء الطريقة google.accounts.id.initialize مرة واحدة حتى إذا كنت تستخدم وحدات متعددة (مثل One Tap والزر المخصّص والإبطال وما إلى ذلك) في صفحة الويب نفسها.
• في حال استدعاء طريقة google.accounts.id.initialize عدة مرات، سيتم تذكُّر الإعدادات في آخر عملية استدعاء واستخدامها فقط.

في الواقع، تتم إعادة ضبط الإعدادات كلما استدعيت الطريقة google.accounts.id.initialize، وتستخدم جميع الطرق اللاحقة في صفحة الويب نفسها الإعدادات الجديدة على الفور.

نوع البيانات: IdConfiguration

يسرد الجدول التالي الحقول والأوصاف الخاصة بنوع البيانات IdConfiguration:

client_id

هذا الحقل هو معرّف عميل تطبيقك، ويمكن العثور عليه وإنشاؤه في وحدة تحكّم Google Cloud. اطّلِع على الجدول التالي لمزيد من المعلومات:

color_scheme

هذا الحقل هو نظام الألوان الذي يتم تطبيقه على طلب نقرة واحدة. اطّلِع على الجدول التالي لمزيد من المعلومات:

يسرد الجدول التالي أنظمة الألوان المتاحة وأوصافها.

auto_select

يحدّد هذا الحقل ما إذا كان سيتم عرض رمز مميّز للمعرّف تلقائيًا بدون أي تفاعل من المستخدم عندما تكون هناك جلسة واحدة فقط على Google وافقت على تطبيقك من قبل. تكون القيمة التلقائية false. اطّلِع على الجدول التالي لمزيد من المعلومات:

callback

هذا الحقل هو دالة JavaScript التي تعالج رمز التعريف المميز الذي يتم عرضه من خلال نافذة الطلب المنبثقة أو النافذة المنبثقة الخاصة بميزة "نقرة واحدة". هذه السمة مطلوبة في حال استخدام وضع تجربة المستخدم popup لخدمة "نقرة واحدة من Google" أو زر "تسجيل الدخول باستخدام حساب Google". اطّلِع على الجدول التالي لمزيد من المعلومات:

login_uri

هذه السمة هي معرّف الموارد المنتظم (URI) لنقطة نهاية تسجيل الدخول.

يجب أن تتطابق القيمة تمامًا مع أحد معرّفات الموارد المنتظمة (URI) المصرّح بها لإعادة التوجيه لعميل OAuth 2.0 الذي ضبطته في Google Cloud Console، ويجب أن تتوافق مع قواعد التحقّق من صحة معرّف الموارد المنتظم (URI) لإعادة التوجيه.

يمكن حذف هذه السمة إذا كانت الصفحة الحالية هي صفحة تسجيل الدخول، وفي هذه الحالة، يتم نشر بيانات الاعتماد إلى هذه الصفحة تلقائيًا.

يتم نشر ردّ بيانات اعتماد الرمز المميز لمعرّف المستخدم إلى نقطة نهاية تسجيل الدخول عندما ينقر المستخدم على الزر "تسجيل الدخول باستخدام حساب Google" ويتم استخدام وضع تجربة المستخدم لإعادة التوجيه.

اطّلِع على الجدول التالي لمزيد من المعلومات:

يجب أن يتعامل نقطة نهاية تسجيل الدخول مع طلبات POST التي تحتوي على المَعلمة credential مع قيمة رمز مميّز للمعرّف في نص الطلب.

native_callback

هذا الحقل هو اسم دالة JavaScript التي تعالج بيانات اعتماد كلمة المرور التي يعرضها مدير بيانات الاعتماد المضمّن في المتصفّح. راجِع الجدول التالي لمزيد من المعلومات:

cancel_on_tap_outside

يحدّد هذا الحقل ما إذا كان سيتم إلغاء طلب One Tap إذا نقر المستخدم خارج النافذة المنبثقة. تكون القيمة التلقائية true. يمكنك إيقافها إذا ضبطت القيمة على false. اطّلِع على الجدول التالي لمزيد من المعلومات:

prompt_parent_id

تضبط هذه السمة رقم تعريف DOM لعنصر الحاوية. إذا لم يتم ضبطه، سيظهر طلب نقرة واحدة في أعلى يسار النافذة. اطّلِع على الجدول التالي لمزيد من المعلومات:

رقم خاص

هذا الحقل عبارة عن سلسلة عشوائية يستخدمها رمز التعريف لمنع هجمات إعادة الإرسال. اطّلِع على الجدول التالي لمزيد من المعلومات:

يقتصر طول الرقم العشوائي المستخدَم مرة واحدة على الحد الأقصى لحجم JWT الذي تتيحه بيئتك، بالإضافة إلى قيود حجم HTTP الفردية في المتصفح والخادم.

essential_claims

هذا الحقل هو سلسلة تُستخدَم لطلب تضمين مطالبات إضافية في الرمز المميّز لتعريف الهوية الذي تعرضه Google. للاطّلاع على قائمة كاملة بالمطالبات التي تقبلها Google، راجِع المطالبات المتوافقة.

اطّلِع على الجدول التالي لمزيد من المعلومات:

context

يغيّر هذا الحقل نص العنوان والرسائل المعروضة في طلب نقرة واحدة، ولا يؤثّر في متصفّحات ITP. القيمة التلقائية هي signin.

اطّلِع على الجدول التالي لمزيد من المعلومات:

يسرد الجدول التالي جميع السياقات المتاحة وأوصافها:

state_cookie_domain

إذا كنت بحاجة إلى عرض One Tap في النطاق الرئيسي ونطاقاته الفرعية، مرِّر النطاق الرئيسي إلى هذا الحقل ليتم استخدام ملف تعريف ارتباط واحد للحالة المشترَكة. راجِع الجدول التالي للحصول على مزيد من المعلومات:

ux_mode

استخدِم هذا الحقل لضبط مسار تجربة المستخدم الذي يستخدمه زر "تسجيل الدخول باستخدام حساب Google". القيمة التلقائية هي popup. ليس لهذه السمة أي تأثير في تجربة المستخدم في One Tap. اطّلِع على الجدول التالي لمزيد من المعلومات:

يسرد الجدول التالي أوضاع تجربة المستخدم المتاحة وأوصافها.

allowed_parent_origin

المصادر المسموح لها بتضمين إطار iframe الوسيط يعمل خيار نقرة واحدة في وضع الإطار الوسيط iframe إذا كان هذا الحقل متوفّرًا. اطّلِع على الجدول التالي لمزيد من المعلومات:

يسرد الجدول التالي أنواع القيم المسموح بها وأوصافها.

يمكن أيضًا استخدام بادئات أحرف البدل. على سبيل المثال، "https://*.example.com" يطابق example.com ونطاقاته الفرعية على جميع المستويات (مثل news.example.com وlogin.news.example.com). في ما يلي بعض النقاط التي يجب وضعها في الاعتبار عند استخدام أحرف البدل:

• لا يمكن أن تتكوّن سلاسل الأنماط من حرف بدل ونطاق مستوى أعلى فقط. على سبيل المثال، https://.com وhttps://.co.uk غير صالحَين لأنّ "https://.example.com" يطابق example.com وجميع نطاقاته الفرعية. استخدِم قائمة مفصولة بفواصل لتمثيل نطاقَين مختلفَين. على سبيل المثال، يتطابق النمط "https://example1.com,https://.example2.com" مع النطاقات example1.com وexample2.com والنطاقات الفرعية الخاصة بـ example2.com.
• يجب أن تبدأ نطاقات أحرف البدل بنظام https:// آمن، لذا يُعدّ "*.example.com" غير صالح.

إذا كانت قيمة الحقل allowed_parent_origin غير صالحة، سيتعذّر بدء وضع iframe الوسيط في One Tap وسيتوقف.

intermediate_iframe_close_callback

تتجاوز هذه السمة السلوك التلقائي لإطار iframe الوسيط عندما يغلق المستخدمون ميزة نقرة واحدة يدويًا من خلال النقر على الزر "X" في واجهة مستخدم نقرة واحدة. السلوك التلقائي هو إزالة إطار iframe الوسيط من نموذج DOM على الفور.

لا يسري حقل intermediate_iframe_close_callback إلا في وضع iframe المتوسط. ويؤثر ذلك فقط في إطار iframe الوسيط، وليس في إطار نقرة واحدة. تتم إزالة واجهة مستخدم "نقرة واحدة" قبل استدعاء دالة الرجوع.

itp_support

يحدّد هذا الحقل ما إذا كان يجب تفعيل تجربة المستخدم المحسّنة في One Tap على المتصفّحات التي تتوافق مع ميزة "منع التتبّع الذكي" (ITP). القيمة التلقائية هي false. اطّلِع على الجدول التالي للحصول على مزيد من المعلومات:

login_hint

إذا كان تطبيقك يعرف مسبقًا المستخدم الذي يجب تسجيل دخوله، يمكنه تقديم تلميح تسجيل دخول إلى Google. وعند نجاح ذلك، يتم تخطّي خطوة اختيار الحساب. القيم المقبولة هي: عنوان بريد إلكتروني أو قيمة حقل sub لرمز تعريف.

لمزيد من المعلومات، يُرجى الاطّلاع على الحقل login_hint في مستندات OpenID Connect.

فائقة الدقة

عندما يكون لدى المستخدم حسابات متعددة ويجب تسجيل الدخول باستخدام حساب Workspace فقط، استخدِم هذا الخيار لتقديم تلميح باسم النطاق إلى Google. في حال نجاح هذا الإجراء، سيتم حصر حسابات المستخدمين المعروضة أثناء اختيار الحساب بالنطاق المقدَّم. قيمة حرف البدل: * لا توفّر للمستخدم سوى حسابات Workspace وتستبعد حسابات المستهلكين (user@gmail.com) أثناء اختيار الحساب.

لمزيد من المعلومات، يُرجى الاطّلاع على الحقل hd في مستندات OpenID Connect.

use_fedcm_for_prompt

يسمح للمتصفّح بالتحكّم في طلبات تسجيل الدخول للمستخدمين والتوسّط في عملية تسجيل الدخول بين موقعك الإلكتروني وGoogle. القيمة التلقائية هي false. لمزيد من المعلومات، يُرجى الاطّلاع على صفحة نقل البيانات إلى FedCM.

use_fedcm_for_button

يحدّد هذا الحقل ما إذا كان يجب استخدام تجربة المستخدم لزر FedCM على Chrome (الإصدار 125 والإصدارات الأحدث على أجهزة الكمبيوتر والإصدار 128 والإصدارات الأحدث على Android). القيمة التلقائية هي false. راجِع الجدول التالي للحصول على مزيد من المعلومات:

button_auto_select

يحدّد هذا الحقل ما إذا كان سيتم تفعيل خيار الاختيار التلقائي لتدفّق زر FedCM. وفي حال تفعيله، سيتم تلقائيًا تسجيل دخول المستخدمين المكررين الزيارة الذين لديهم جلسة نشطة على Google، ما يؤدي إلى تجاوز طلب "محدد الحساب". القيمة التلقائية هي false. عليك تفعيل ميزة تسجيل الدخول التلقائي باستخدام الزر بشكلٍ صريح أثناء إطلاق عملية الموافقة. راجِع الجدول التالي للحصول على مزيد من المعلومات:

الطريقة: google.accounts.id.prompt

تعرض الطريقة google.accounts.id.prompt طلب نقرة واحدة أو مدير بيانات الاعتماد المضمّن في المتصفّح بعد استدعاء الطريقة initialize(). اطّلِع على مثال الرمز التالي للطريقة:

 google.accounts.id.prompt(/**
 @type{(function(!PromptMomentNotification):void)=} */ momentListener)

عادةً، يتم استدعاء الطريقة prompt() عند تحميل الصفحة. بسبب حالة الجلسة وإعدادات المستخدم على جهة Google، قد لا تظهر واجهة مستخدم طلب نقرة واحدة. لتلقّي إشعارات بشأن حالة واجهة المستخدم في لحظات مختلفة، عليك تمرير دالة لتلقّي إشعارات حالة واجهة المستخدم.

يتم إرسال الإشعارات في اللحظات التالية:

• وقت العرض: يحدث ذلك بعد استدعاء الطريقة prompt(). يحتوي الإشعار على قيمة منطقية لتحديد ما إذا كان سيتم عرض واجهة المستخدم أم لا.

• لحظة تم تخطّيها: يحدث ذلك عند إغلاق طلب نقرة واحدة بسبب إلغاء تلقائي أو إلغاء يدوي أو عندما يتعذّر على Google إصدار بيانات اعتماد، مثلاً عندما يتم تسجيل الخروج من Google في الجلسة المحدّدة.

  في هذه الحالات، ننصحك بمواصلة البحث في مزوّدي خدمات تحديد الهوية التاليين، إذا توفّروا.

• لحظة الرفض: تحدث هذه اللحظة عندما تستردّ Google بيانات الاعتماد بنجاح أو عندما يريد المستخدم إيقاف عملية استرداد بيانات الاعتماد. على سبيل المثال، عندما يبدأ المستخدم في إدخال اسم المستخدم وكلمة المرور في مربّع حوار تسجيل الدخول، يمكنك استدعاء الطريقة google.accounts.id.cancel() لإغلاق طلب One Tap وعرض لحظة الرفض.

يوضّح مثال الرمز البرمجي التالي كيفية تنفيذ اللحظة التي تم تخطّيها:

<script>
  window.onload = function () {
    google.accounts.id.initialize(...);
    google.accounts.id.prompt((notification) => {
      if (notification.isNotDisplayed() || notification.isSkippedMoment()) {
        // continue with another identity provider.
      }
    });
  };
</script>

نوع البيانات: PromptMomentNotification

يسرد الجدول التالي طرقًا وأوصافًا لنوع البيانات PromptMomentNotification:

نوع البيانات: CredentialResponse

عند استدعاء الدالة callback، يتم تمرير العنصر CredentialResponse كمَعلمة. يدرج الجدول التالي الحقول التي يتضمّنها عنصر استجابة بيانات الاعتماد:

شهادة

هذا الحقل هو رمز التعريف كسلسلة رمز JSON المميّز للويب (JWT) بترميز base64.

عند فك ترميز JWT، يظهر على النحو التالي:

header
{
  "alg": "RS256",
  "kid": "f05415b13acb9590f70df862765c655f5a7a019e", // JWT signature
  "typ": "JWT"
}
payload
{
  "iss": "https://accounts.google.com", // The JWT's issuer
  "nbf":  161803398874,
  "aud": "314159265-pi.apps.googleusercontent.com", // Your server's client ID
  "sub": "3141592653589793238", // The unique ID of the user's Google Account
  "hd": "gmail.com", // If present, the host domain of the user's Google Workspace email address
  "auth_time": 1748875426,
  "amr": ["mfa", "pwd", "tel"],
  "email": "elisa.g.beckett@gmail.com", // The user's email address
  "email_verified": true, // true, if Google has verified the email address
  "azp": "314159265-pi.apps.googleusercontent.com",
  "name": "Elisa Beckett",
                            // If present, a URL to user's profile picture
  "picture": "https://lh3.googleusercontent.com/a-/e2718281828459045235360uler",
  "given_name": "Elisa",
  "family_name": "Beckett",
  "iat": 1596474000, // Unix timestamp of the assertion creation time
  "exp": 1596477600, // Unix timestamp of the assertion expiration time
  "jti": "abc161803398874def"
}

الحقل sub هو معرّف فريد عالميًا لحساب Google. استخدِم الحقل sub فقط كمعرّف للمستخدم لأنّه فريد بين جميع حسابات Google ولا تتم إعادة استخدامه أبدًا.

باستخدام الحقول email وemail_verified وhd، يمكنك تحديد ما إذا كانت Google تستضيف عنوان بريد إلكتروني وتملك سلطة التحكم فيه. في الحالات التي تكون فيها Google هي الجهة الموثوقة، يتم التأكّد من أنّ المستخدم هو صاحب الحساب الشرعي.

الحالات التي تكون فيها Google هي الجهة الموثوقة:

• إذا كان عنوان البريد الإلكتروني ينتهي باللاحقة @gmail.com، هذا يعني أنّه حساب Gmail.email
• إذا كانت قيمة email_verified صحيحة وتم ضبط hd، يكون هذا حساب Google Workspace.

يمكن للمستخدمين التسجيل للحصول على حسابات Google بدون استخدام Gmail أو Google Workspace. عندما لا يحتوي email على لاحقة @gmail.com ولا يتوفّر hd، لا تكون Google هي الجهة الموثوقة، ويُنصح باستخدام كلمة المرور أو طرق أخرى للتحقّق من هوية المستخدم. يمكن أن تكون القيمة email_verfied صحيحة أيضًا لأنّ Google أثبتت في البداية ملكية المستخدم عند إنشاء حساب Google، ولكن قد تكون ملكية حساب البريد الإلكتروني التابع لجهة خارجية قد تغيّرت منذ ذلك الحين.

يعرض الحقل exp وقت انتهاء صلاحية رمز التحقّق على جهة الخادم. تبلغ مدة صلاحية رمز التعريف المميز الذي يتم الحصول عليه من خدمة "تسجيل الدخول باستخدام حساب Google" ساعة واحدة. يجب تأكيد الرمز المميّز قبل انتهاء صلاحيته. لا تستخدِم exp لإدارة الجلسات. لا يعني انتهاء صلاحية رمز تعريف أن المستخدم قد سجّل الخروج. يتحمّل تطبيقك مسؤولية إدارة جلسات المستخدمين.

select_by

يسرد الجدول التالي القيم المحتملة للحقل select_by. يتم استخدام نوع الزر مع حالة الجلسة وحالة الموافقة لضبط القيمة.

• ضغط المستخدم على الزر "نقرة واحدة" أو "تسجيل الدخول باستخدام حساب Google" أو استخدم عملية "تسجيل الدخول تلقائيًا" بدون لمس.

• تم العثور على جلسة حالية، أو اختار المستخدم حساب Google وسجّل الدخول إليه لإنشاء جلسة جديدة.

• قبل مشاركة بيانات اعتماد رمز التعريف مع تطبيقك، يجب أن يكون المستخدم قد

  • النقر على زر "تأكيد" للموافقة على مشاركة بيانات الاعتماد، أو
  • سبق له منح الموافقة واستخدام ميزة "اختيار حساب" لاختيار حساب Google.

يتم ضبط قيمة هذا الحقل على أحد الأنواع التالية:

الولاية

يتم تحديد هذا الحقل فقط عندما ينقر المستخدم على زر "تسجيل الدخول باستخدام حساب Google" لتسجيل الدخول، ويتم تحديد السمة state للزر الذي تم النقر عليه. وتكون قيمة هذا الحقل هي القيمة نفسها التي حدّدتها في السمة state للزر.

بما أنّه يمكن عرض أزرار متعدّدة لميزة "تسجيل الدخول باستخدام حساب Google" على الصفحة نفسها، يمكنك تعيين سلسلة فريدة لكل زر. وبالتالي، يمكنك استخدام الحقل state لتحديد الزر الذي نقر عليه المستخدم لتسجيل الدخول.

الطريقة: google.accounts.id.renderButton

تعرض طريقة google.accounts.id.renderButton زر "تسجيل الدخول باستخدام حساب Google" في صفحات الويب.

اطّلِع على مثال الرمز التالي للطريقة:

google.accounts.id.renderButton(
      /** @type{!HTMLElement} */ parent,
      /** @type{!GsiButtonConfiguration} */ options
    )

نوع البيانات: GsiButtonConfiguration

يسرد الجدول التالي الحقول والأوصاف الخاصة بنوع البيانات GsiButtonConfiguration:

أنواع السمات

تحتوي الأقسام التالية على تفاصيل حول كل نوع من أنواع السمات، بالإضافة إلى مثال.

النوع

نوع الزر تكون القيمة التلقائية standard.

اطّلِع على الجدول التالي لمزيد من المعلومات:

يسرد الجدول التالي أنواع الأزرار المتاحة وأوصافها:

النوع
standard
icon

مظهر

مظهر الزر تكون القيمة التلقائية outline. اطّلِع على الجدول التالي لمزيد من المعلومات:

يسرد الجدول التالي النُسق المتاحة وأوصافها:

المظهر
outline
filled_blue
filled_black

الحجم

حجم الزر تكون القيمة التلقائية large. اطّلِع على الجدول التالي لمزيد من المعلومات:

يسرد الجدول التالي أحجام الأزرار المتاحة وأوصافها:

الحجم
large
medium
small

نص

نص الزر تكون القيمة التلقائية signin_with. لا توجد اختلافات مرئية في نص أزرار الرموز التي تتضمّن سمات text مختلفة. الاستثناء الوحيد هو عندما تتم قراءة النص لأغراض تسهيل الاستخدام.

اطّلِع على الجدول التالي لمزيد من المعلومات:

يسرد الجدول التالي جميع نصوص الأزرار المتاحة وأوصافها:

نص
signin_with
signup_with
continue_with
signin

الشكل

شكل الزر تكون القيمة التلقائية rectangular. اطّلِع على الجدول التالي لمزيد من المعلومات:

يسرد الجدول التالي أشكال الأزرار المتاحة وأوصافها:

الشكل
rectangular
pill
circle
square

logo_alignment

محاذاة شعار Google تكون القيمة التلقائية left. تنطبق هذه السمة على نوع الزر standard فقط. اطّلِع على الجدول التالي لمزيد من المعلومات:

يسرد الجدول التالي عمليات المحاذاة المتاحة وأوصافها:

logo_alignment
left
center

العرض

الحدّ الأدنى لعرض الزرّ، بالبكسل. الحدّ الأقصى للعرض هو 400 بكسل.

اطّلِع على الجدول التالي لمزيد من المعلومات:

locale

اختياريّ. عرض نص الزر باستخدام اللغة المحدّدة، وإلا سيتم استخدام اللغة التلقائية لحساب Google أو إعدادات المتصفّح. أضِف المَعلمة hl ورمز اللغة إلى توجيه src عند تحميل المكتبة، على سبيل المثال: gsi/client?hl=<iso-639-code>.

في حال عدم ضبطها، يتم استخدام اللغة التلقائية للمتصفّح أو الإعدادات المفضّلة لمستخدم جلسة Google. لذلك، قد يرى المستخدمون المختلفون نُسخًا مختلفة من الأزرار المترجمة، وربما بأحجام مختلفة.

اطّلِع على الجدول التالي لمزيد من المعلومات:

click_listener

يمكنك تحديد دالة JavaScript يتم استدعاؤها عند النقر على زر click_listener باستخدام السمة click_listener.

  google.accounts.id.renderButton(document.getElementById("signinDiv"), {
      theme: 'outline',
      size: 'large',
      click_listener: onClickHandler
    });

  
  function onClickHandler(){
    console.log("Sign in with Google button clicked...")
  }
  

في هذا المثال، يتم تسجيل الرسالة تم النقر على زر "تسجيل الدخول باستخدام حساب Google"... في وحدة التحكّم عند النقر على زر "تسجيل الدخول باستخدام حساب Google".

الولاية

هذه السمة اختيارية، لأنّه يمكن عرض أزرار متعدّدة من "تسجيل الدخول باستخدام حساب Google" على الصفحة نفسها، ويمكنك تخصيص سلسلة فريدة لكل زر، وستعرض السلسلة نفسها مع رمز التعريف، ما يتيح لك تحديد الزر الذي نقر عليه المستخدم لتسجيل الدخول.

اطّلِع على الجدول التالي لمزيد من المعلومات:

نوع البيانات: بيانات اعتماد

عند استدعاء الدالة native_callback، يتم تمرير عنصر Credential كالمَعلمة. يسرد الجدول التالي الحقول الواردة في العنصر:

الطريقة: google.accounts.id.disableAutoSelect

عندما يسجّل المستخدم الخروج من موقعك الإلكتروني، عليك طلب تنفيذ الطريقة google.accounts.id.disableAutoSelect لتسجيل الحالة في ملفات تعريف الارتباط، ما يمنع حدوث حلقة مفرغة في تجربة المستخدم. اطّلِع على مقتطف الرمز التالي الخاص بالطريقة:

google.accounts.id.disableAutoSelect()

ينفّذ مثال الرمز البرمجي التالي طريقة google.accounts.id.disableAutoSelect باستخدام الدالة onSignout():

<script>
  function onSignout() {
    google.accounts.id.disableAutoSelect();
  }
</script>

الطريقة: google.accounts.id.storeCredential

هذه الطريقة هي برنامج تضمين للطريقة store() لواجهة برمجة التطبيقات المدمجة في المتصفّح لإدارة بيانات الاعتماد. لذلك، لا يمكن استخدامه إلا لتخزين بيانات اعتماد كلمة المرور. اطّلِع على مثال الرمز التالي للطريقة:

google.accounts.id.storeCredential(Credential, callback)

ينفّذ مثال الرمز البرمجي التالي طريقة google.accounts.id.storeCredential باستخدام الدالة onSignIn():

<script>
  function onSignIn() {
    let cred = {id: '...', password: '...'};
    google.accounts.id.storeCredential(cred);
  }
</script>

الطريقة: google.accounts.id.cancel

يمكنك إلغاء عملية نقرة واحدة إذا أزلت الطلب من DOM الخاص بالجهة المعتمِدة. يتم تجاهل عملية الإلغاء إذا تم اختيار بيانات اعتماد من قبل. اطّلِع على مثال الرمز البرمجي التالي للطريقة:

google.accounts.id.cancel()

ينفّذ مثال الرمز البرمجي التالي طريقة google.accounts.id.cancel() باستخدام دالة onNextButtonClicked():

<script>
  function onNextButtonClicked() {
    google.accounts.id.cancel();
    showPasswordPage();
  }
</script>

دالة ردّ الاتصال عند تحميل المكتبة: onGoogleLibraryLoad

يمكنك تسجيل ردّ الاتصال onGoogleLibraryLoad. يتم إرسال الإشعار بعد تحميل مكتبة JavaScript الخاصة بخدمة "تسجيل الدخول باستخدام Google":

window.onGoogleLibraryLoad = () => {
    ...
};

هذا الإجراء هو مجرد اختصار لإجراء window.onload. ولا تختلف طريقة عملها.

ينفّذ مثال الرمز البرمجي التالي onGoogleLibraryLoad ردّ اتصال:

<script>
  window.onGoogleLibraryLoad = () => {
   google.accounts.id.initialize({
     ...
   });
   google.accounts.id.prompt();
  };
</script>

الطريقة: google.accounts.id.revoke

يبطل الأسلوب google.accounts.id.revoke منح الإذن باستخدام OAuth المستخدَم لمشاركة الرمز المميّز للمعرّف الخاص بالمستخدم المحدّد. راجِع مقتطف الرمز التالي الخاص بالطريقة: javascript google.accounts.id.revoke(login_hint, callback)

يوضّح نموذج الرمز البرمجي التالي كيفية استخدام طريقة revoke مع معرّف.

  google.accounts.id.revoke('1618033988749895', done => {
    console.log(done.error);
  });

نوع البيانات: RevocationResponse

عند استدعاء الدالة callback، يتم تمرير العنصر RevocationResponse كمعلَمة. يسرد الجدول التالي الحقول التي يتضمّنها عنصر رد الإبطال:

ناجحة

هذا الحقل هو قيمة منطقية تم ضبطها على "صحيح" إذا نجح طلب إجراء الإبطال أو "خطأ" في حال حدوث خطأ.

خطأ

هذا الحقل هو قيمة سلسلة ويحتوي على رسالة خطأ مفصّلة في حال تعذّر تنفيذ طلب إلغاء الربط، ويكون غير محدّد في حال نجاح العملية.