بدء استخدام Python بسرعة

يمكنك إنشاء تطبيق سطر أوامر بلغة Python يرسل طلبات إلى Google Chat API.

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

يستخدم دليل التشغيل السريع هذا مكتبات برامج Google Workspace API التي ننصح بها للتعامل مع بعض تفاصيل عملية المصادقة والتفويض.

الأهداف

  • إعداد البيئة
  • تثبيت مكتبة البرامج
  • إعداد النموذج
  • تشغيل النموذج

المتطلبات الأساسية

لتشغيل دليل التشغيل السريع هذا، يجب استيفاء المتطلبات الأساسية التالية:

إعداد البيئة

لإكمال دليل التشغيل السريع هذا، عليك إعداد البيئة.

تفعيل واجهة برمجة التطبيقات

قبل استخدام Google APIs، عليك تفعيلها في مشروع على Google Cloud. يمكنك تفعيل واجهة برمجة تطبيقات واحدة أو أكثر في مشروع واحد على Google Cloud.

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

  1. في Google API Console، انتقِل إلى "القائمة" > منصة Google للمصادقة > العلامة التجارية.

    الانتقال إلى صفحة "العلامة التجارية"

  2. إذا سبق لك إعداد منصة Google للمصادقة، يمكنك إعداد إعدادات شاشة موافقة OAuth التالية في العلامة التجارية والجمهور والوصول إلى البيانات. إذا ظهرت لك رسالة لم يتم إعداد منصة Google للمصادقة بعد، انقر على البدء:
    1. ضمن معلومات التطبيق، في اسم التطبيق، أدخِل اسمًا للتطبيق.
    2. في البريد الإلكتروني لدعم المستخدمين، اختَر عنوان بريد إلكتروني للدعم يمكن للمستخدمين التواصل معك من خلاله إذا كانت لديهم أسئلة حول موافقتهم.
    3. انقر على التالي.
    4. ضمن الجمهور، اختَر داخلي.
    5. انقر على التالي.
    6. ضمن معلومات الاتصال، أدخِل عنوان بريد إلكتروني يمكنك تلقّي إشعارات من خلاله بشأن أي تغييرات تطرأ على مشروعك.
    7. انقر على التالي.
    8. ضمن إنهاء، راجِع سياسة بيانات المستخدمين في خدمات Google API، وإذا كنت موافقًا عليها، اختَر أوافق على "سياسة بيانات المستخدمين في خدمات Google API".
    9. انقر على متابعة.
    10. انقر على إنشاء.
  3. يمكنك في الوقت الحالي تخطّي إضافة النطاقات. في المستقبل، عند إنشاء تطبيق لاستخدامه خارج مؤسستك على Google Workspace، عليك تغيير نوع المستخدم إلى خارجي. بعد ذلك، أضِف نطاقات التفويض التي يتطلبها تطبيقك. لمزيد من المعلومات، اطّلِع على دليل إعداد شاشة موافقة OAuth الكامل .

السماح ببيانات اعتماد لتطبيق كمبيوتر

لمصادقة المستخدمين النهائيين والوصول إلى بيانات المستخدمين في تطبيقك، عليك إنشاء معرّف عميل واحد أو أكثر لبروتوكول OAuth 2.0. يُستخدم معرّف العميل لتعريف تطبيق واحد على خوادم OAuth من Google. إذا كان تطبيقك يعمل على منصات متعددة، عليك إنشاء معرّف عميل منفصل لكل منصة.
  1. في Google Cloud Console، انتقِل إلى "القائمة" > منصة Google للمصادقة > العملاء.

    الانتقال إلى صفحة "العملاء"

  2. انقر على إنشاء عميل.
  3. انقر على نوع التطبيق > تطبيق كمبيوتر.
  4. في حقل الاسم ، اكتب اسمًا لبيانات الاعتماد. لا يظهر هذا الاسم إلا في Google Cloud Console.
  5. انقر على إنشاء.

    تظهر بيانات الاعتماد التي تم إنشاؤها حديثًا ضمن "معرّفات عميل OAuth 2.0".

  6. احفظ ملف JSON الذي تم تنزيله باسم credentials.json وانقُل الملف إلى دليل العمل.

إعداد تطبيق Google Chat

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

  1. في Google API Console، انتقِل إلى صفحة الإعدادات في Chat API:

    الانتقال إلى صفحة "إعدادات Chat API"

  2. ضمن معلومات التطبيق، أدخِل المعلومات التالية:

    1. في حقل اسم التطبيق ، أدخِل Chat API quickstart app.
    2. في حقل عنوان URL للصورة الرمزية ، أدخِل https://developers.google.com/chat/images/quickstart-app-avatar.png.
    3. في حقل الوصف ، أدخِل Quickstart for calling the Chat API.

  3. ضمن الميزات التفاعلية ، انقر على زر تفعيل الميزات التفاعلية لضبطه على وضع الإيقاف من أجل إيقاف الميزات التفاعلية لتطبيق Chat.

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

تثبيت مكتبة برامج Google

  • ثبِّت مكتبة برامج Google لـ Python:

    python3 -m pip install --upgrade google-apps-chat google-auth-httplib2 google-auth-oauthlib

إعداد النموذج

  1. في دليل العمل، أنشِئ ملفًا باسم quickstart.py.

  2. أدرِج الرمز التالي في quickstart.py:

    chat/quickstart/quickstart.py
    from __future__ import print_function

import os.path

from google.auth.transport.requests import Request
from google.oauth2.credentials import Credentials
from google_auth_oauthlib.flow import InstalledAppFlow
from google.apps import chat_v1 as google_chat


# If modifying these scopes, delete the file token.json.
SCOPES = ['https://www.googleapis.com/auth/chat.spaces.readonly']


def main():
    """Shows basic usage of the Google Chat API.
    """
    creds = None
    # The file token.json stores the user's access and refresh tokens, and is
    # created automatically when the authorization flow completes for the first
    # time.
    if os.path.exists('token.json'):
        creds = Credentials.from_authorized_user_file('token.json', SCOPES)
    # If there are no (valid) credentials available, let the user log in.
    if not creds or not creds.valid:
        if creds and creds.expired and creds.refresh_token:
            creds.refresh(Request())
        else:
            flow = InstalledAppFlow.from_client_secrets_file(
                'credentials.json', SCOPES)
            creds = flow.run_local_server(port=0)
        # Save the credentials for the next run
        with open('token.json', 'w') as token:
            token.write(creds.to_json())

    try:
        # Create a client
        client = google_chat.ChatServiceClient(
            credentials = creds,
            client_options = {
                "scopes" : SCOPES
            }
        )

        # Initialize request argument(s)
        request = google_chat.ListSpacesRequest(
            # Filter spaces by space type (SPACE or GROUP_CHAT or DIRECT_MESSAGE)
            filter = 'space_type = "SPACE"'
        )

        # Make the request
        page_result = client.list_spaces(request)

        # Handle the response. Iterating over page_result will yield results and
        # resolve additional pages automatically.
        for response in page_result:
            print(response)
    except Exception as error:
        # TODO(developer) - Handle errors from Chat API.
        print(f'An error occurred: {error}')


if __name__ == '__main__':
    main()

تشغيل النموذج

  1. في دليل العمل، أنشِئ النموذج وشغِّله:

    python3 quickstart.py
  1. في المرة الأولى التي تشغِّل فيها النموذج، سيُطلب منك السماح بالوصول:
    1. إذا لم يسبق لك تسجيل الدخول إلى حساب Google، سجِّل الدخول عند المطالبة بذلك. إذا كنت مسجِّلاً الدخول إلى حسابات متعددة، اختَر حسابًا واحدًا لاستخدامه في التفويض.
    2. انقر على حسنًا.

    يتم تشغيل تطبيق Python ويستدعي Google Chat API.

    يتم تخزين معلومات التفويض في نظام الملفات، لذا لن يُطلب منك التفويض في المرة التالية التي تشغِّل فيها رمز النموذج.

الخطوات التالية