ربط الحساب باستخدام بروتوكول OAuth (Dialogflow)

يدعم نوع ربط OAuth مسارين لتدفق OAuth 2.0 وفقًا للمعيار المتّبع في المجال، وهما تدفقات الرمز الضمني والتفويض.

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

في مسار رمز التفويض، ستحتاج إلى نقطتَي نهاية:

• نقطة نهاية التفويض المسؤولة عن تقديم واجهة مستخدم تسجيل الدخول للمستخدمين الذين لم يسجّلوا الدخول وتسجيل الموافقة على الوصول المطلوب في شكل رمز تفويض قصير الأجل.
• نقطة نهاية تبادل الرموز المسؤولة عن نوعَين من عمليات التبادل:
  1. تبادل رمز التفويض لرمز مميز لإعادة التحميل طويل الأجل ورمز دخول قصير الأجل وتتم عملية التبادل هذه عندما يجري المستخدم عملية ربط الحساب.
  2. لتبادل رمز مميز لإعادة التحميل طويل الأمد لرمز دخول قصير الأجل وتتم عملية التبادل هذه عندما تحتاج Google إلى رمز دخول جديد لأنّ الرمز الذي انتهت صلاحيته.

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

ملاحظة: يُرجى اختيار مسار OAuth2 الذي تريد تنفيذه. إذا لزم الأمر، تتم إعادة تحميل محتوى هذا الدليل لتتلاءم مع الخيار الذي تريده.

رمز المصادقة تدفق ضمني

تنفيذ عملية ربط حساب OAuth

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

ضبط المشروع

لإعداد مشروعك لاستخدام ربط حساب OAuth، اتّبِع الخطوات التالية:

1. افتح وحدة تحكّم المهام واختَر المشروع الذي تريد استخدامه.
2. انقر على علامة التبويب التطوير واختَر ربط الحساب.
3. فعِّل مفتاح التبديل بجانب ربط الحساب.
4. في القسم إنشاء الحساب، اختَر لا، أريد فقط السماح بإنشاء الحساب على موقعي الإلكتروني.

5. في نوع الربط، اختَر OAuth ومحتوى ضمني.

   

6. في معلومات العميل:

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

ملاحظة: إذا كنت تريد إرسال معرِّف العميل الخاص بك كسلسلة Base64 مرمّزة، انقر على سهم القائمة المنسدلة بجانب Configure your client (اختياري) وضَع علامة في المربّع Google لنقل clientID والرمز السري عبر عنوان مصادقة HTTP الأساسي.

6. انقر على حفظ.

تنفيذ خادم OAuth

لدعم تدفق OAuth 2.0 الضمني، توفِّر الخدمة نقطة نهاية للتفويض من خلال HTTPS. نقطة النهاية هذه مسؤولة عن مصادقة والحصول على موافقة المستخدمين للوصول إلى البيانات. تعرض نقطة نهاية التفويض واجهة مستخدم لتسجيل الدخول للمستخدمين الذين لم يسبق لهم تسجيل الدخول، كما تسجِّل الموافقة على الوصول المطلوب.

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

في ما يلي الخطوات التي يجب اتّباعها في جلسة التدفق الضمني لبروتوكول OAuth 2.0 التي تبدأها Google:

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

معالجة طلبات التفويض

عندما يحتاج الإجراء الخاص بك إلى ربط الحساب من خلال مسار ضمني لبروتوكول OAuth2، ترسل Google المستخدم إلى نقطة نهاية التفويض مع طلب يتضمّن المَعلمات التالية:

مَعلمات نقطة نهاية التفويض
client_id	معرِّف العميل الذي حدّدته إلى Google.
redirect_uri	عنوان URL الذي ترسل إليه الرد على هذا الطلب.
state	يشير ذلك المصطلح إلى قيمة مسك الدفاتر التي يتم إرجاعها إلى Google بدون تغيير في معرّف الموارد المنتظم (URI) لإعادة التوجيه.
response_type	تمثّل هذه السمة نوع القيمة المطلوب عرضها في الرد. بالنسبة إلى التدفق الضمني في OAuth 2.0، يكون نوع الاستجابة دائمًا token.

على سبيل المثال، إذا كانت نقطة نهاية التفويض متاحة على https://myservice.example.com/auth، قد يظهر الطلب على النحو التالي:

GET https://myservice.example.com/auth?client_id=GOOGLE_CLIENT_ID&redirect_uri=REDIRECT_URI&state=STATE_STRING&response_type=token

لكي تتمكّن نقطة نهاية التفويض من معالجة طلبات تسجيل الدخول، عليك اتّباع الخطوات التالية:

1. تحقَّق من قيمتَي client_id وredirect_uri لمنع منح إمكانية الوصول إلى تطبيقات العميل غير المقصودة أو التي تم ضبطها بشكلٍ غير سليم:

   • تأكَّد من أنّ client_id يطابق معرِّف العميل الذي خصّصته لشركة Google.
   • تأكَّد من أنّ عنوان URL المحدَّد من خلال المَعلمة redirect_uri يحتوي على النموذج التالي:

     https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID

     YOUR_PROJECT_ID هو رقم التعريف المتوفّر في صفحة إعدادات المشروع من "وحدة تحكّم المهام".

2. تحقَّق مما إذا كان المستخدم قد سجّل الدخول إلى خدمتك. إذا لم يسجّل المستخدم الدخول، أكمِل عملية تسجيل الدخول أو الاشتراك في الخدمة.

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

4. أرسِل استجابة HTTP تعيد توجيه متصفّح المستخدم إلى عنوان URL الذي حددته المعلَمة redirect_uri. أدرِج جميع المَعلمات التالية في جزء عنوان URL:

   • access_token: رمز الدخول الذي أنشأته للتو
   • token_type: السلسلة bearer
   • state: قيمة الحالة غير المُعدَّلة من الطلب الأصلي في ما يلي مثال على عنوان URL الناتج:

     https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID#access_token=ACCESS_TOKEN&token_type=bearer&state=STATE_STRING

سيتلقّى معالِج إعادة التوجيه OAuth 2.0 من Google رمز الدخول ويتأكّد من عدم تغيير قيمة state. بعد أن تحصل Google على رمز دخول إلى خدمتك، سترفق Google الرمز المميّز في الطلبات اللاحقة إلى الإجراء الخاص بك كجزء من AppRequest.

بدء مسار المصادقة

تحذير: لا تقدِّم للمستخدمين رسالة مطالبة مطلوبة لربط الحساب في بداية المحادثة مع الإجراء الخاص بك. بدلاً من ذلك، يمكنك السماح للمستخدمين الذين لم تتم مصادقتهم باستخدام الإجراء الخاص بك لعرض آلية عمل الإجراء الخاص بك، وبعد ذلك لا تطلب منهم ربط الحساب إلا إذا كان ذلك ضروريًا. إذا كان المستخدمون يغادرون "الإجراء" باستمرار بسبب مشاكل في ربط الحسابات، لن تروّج Google للإجراء بشكل نشط، ما قد يتسبّب في انخفاض عدد زيارات مستخدمي الإجراء.

استخدم هدف مساعد تسجيل الدخول إلى الحساب لبدء مسار المصادقة. توضّح مقتطفات الرمز التالية كيفية إرسال ردّ في Dialogflow وحزمة تطوير برامج "المهام" لاستخدام هذا المساعد.

Dialogflow:

Node.js

const {dialogflow, SignIn} = require('actions-on-google');
const app = dialogflow({
  // REPLACE THE PLACEHOLDER WITH THE CLIENT_ID OF YOUR ACTIONS PROJECT
  clientId: CLIENT_ID,
});
// Intent that starts the account linking flow.
app.intent('Start Signin', (conv) => {
  conv.ask(new SignIn('To get your account details'));
});

Java

@ForIntent("Start Signin")
public ActionResponse text(ActionRequest request) {
  ResponseBuilder rb = getResponseBuilder(request);
  return rb.add(new SignIn().setContext("To get your account details")).build();
}

JSON

{
  "payload": {
    "google": {
      "expectUserResponse": true,
      "richResponse": {
        "items": [
          {
            "simpleResponse": {
              "textToSpeech": "PLACEHOLDER"
            }
          }
        ]
      },
      "userStorage": "{\"data\":{}}",
      "systemIntent": {
        "intent": "actions.intent.SIGN_IN",
        "data": {
          "@type": "type.googleapis.com/google.actions.v2.SignInValueSpec",
          "optContext": "To get your account details"
        }
      }
    }
  },
  "outputContexts": [
    {
      "name": "/contexts/_actions_on_google",
      "lifespanCount": 99,
      "parameters": {
        "data": "{}"
      }
    }
  ]
}

حزمة تطوير البرامج (SDK) للإجراءات:

Node.js

const {actionssdk, SignIn} = require('actions-on-google');
const app = actionssdk({
  // REPLACE THE PLACEHOLDER WITH THE CLIENT_ID OF YOUR ACTIONS PROJECT
  clientId: CLIENT_ID,
});
// Intent that starts the account linking flow.
app.intent('actions.intent.TEXT', (conv) => {
  conv.ask(new SignIn('To get your account details'));
});

Java

@ForIntent("actions.intent.TEXT")
public ActionResponse text(ActionRequest request) {
  ResponseBuilder rb = getResponseBuilder(request);
  return rb.add(new SignIn().setContext("To get your account details")).build();
}

JSON

{
  "expectUserResponse": true,
  "expectedInputs": [
    {
      "inputPrompt": {
        "richInitialPrompt": {
          "items": [
            {
              "simpleResponse": {
                "textToSpeech": "PLACEHOLDER"
              }
            }
          ]
        }
      },
      "possibleIntents": [
        {
          "intent": "actions.intent.SIGN_IN",
          "inputValueData": {
            "@type": "type.googleapis.com/google.actions.v2.SignInValueSpec",
            "optContext": "To get your account details"
          }
        }
      ]
    }
  ],
  "conversationToken": "{\"data\":{}}",
  "userStorage": "{\"data\":{}}"
}

معالجة طلبات الوصول إلى البيانات

إذا كان طلب "مساعد Google" يتضمّن رمز دخول، تحقَّق أولاً من أنّ رمز الدخول صالح (وليس منتهي الصلاحية)، ثم استرِد حساب المستخدم المرتبط من قاعدة البيانات.