יצירת מינוי ל-Google Workspace

Apps Script

• כדי להשתמש בפקודות של Google Cloud CLI במדריך הזה:
  1. מתקינים את Google Cloud CLI.
  2. אל לאתחל את gcloud CLI, להריץ את הקוד הבא:

    gcloud init
    

• פרויקט ב-Google Cloud עם חיוב מופעל. כדי להירשם ל-Chat, תצטרכו גם להפעיל את Chat API בפרויקט שלכם בענן להגדיר את שם האפליקציה, כתובת ה-URL של הדמות והתיאור. . פרטים נוספים זמינים במאמר איך מפתחים אפליקציה של Google Chat
• נדרש אימות משתמש עם מסך ההסכמה של OAuth שהוגדר עבור את האפליקציה. כשמגדירים את מסך ההסכמה, צריך לציין היקף כדי תומכים בכל סוג אירוע של המינוי. כדי להגדיר את ההסכמה לזהות את ההיקפים הנדרשים, בחירת היקפים

• פרויקט Apps Script:
  • שימוש בפרויקט ב-Google Cloud במקום בפרויקט ברירת המחדל שנוצר באופן אוטומטי על ידי Apps Script.
  • בכל היקפי הרשאות שהוספתם כדי להגדיר את מסך ההסכמה של OAuth, צריך להוסיף גם את את ההיקף לקובץ appsscript.json בפרויקט Apps Script שלכם. לדוגמה:

  "oauthScopes": [
    "https://www.googleapis.com/auth/chat.messages.readonly"
  ]
      

  • הפעלה השירות המתקדם Google Workspace Events.

Python

• Python 3.6 ומעלה
• הכלי לניהול חבילות pip
• ספריות הלקוח העדכניות של Google ל-Python. כדי להתקין או לעדכן אותם, מריצים את הפקודה הבאה הפקודה בממשק שורת הפקודה:

    pip3 install --upgrade google-api-python-client google-auth-oauthlib
    

• כדי להשתמש בפקודות של Google Cloud CLI במדריך הזה:
  1. מתקינים את Google Cloud CLI.
  2. אל לאתחל את gcloud CLI, להריץ את הקוד הבא:

    gcloud init
    

• פרויקט ב-Google Cloud עם חיוב מופעל. כדי להירשם ל-Chat, תצטרכו גם להפעיל את Chat API בפרויקט שלכם בענן להגדיר את שם האפליקציה, כתובת ה-URL של הדמות והתיאור. . פרטים נוספים זמינים במאמר איך מפתחים אפליקציה של Google Chat
• נדרש אימות משתמש עם מסך ההסכמה של OAuth שהוגדר עבור את האפליקציה. כשמגדירים את מסך ההסכמה, צריך לציין היקף כדי תומכים בכל סוג אירוע של המינוי. כדי להגדיר את ההסכמה לזהות את ההיקפים הנדרשים, בחירת היקפים

מסוף Google Cloud

במסוף Google Cloud, פותחים את פרויקט Google Cloud של האפליקציה ומפעילים את Google Workspace Event API ו-Pub/Sub API:

הפעלת ממשקי ה-API

gcloud

1. בספריית העבודה, נכנסים לחשבון Google:

   gcloud auth login
   

2. מגדירים את הפרויקט לפרויקט Cloud של האפליקציה:

   gcloud config set project PROJECT_ID
   

   מחליפים את PROJECT_ID ב- מזהה הפרויקט של הפרויקט ב-Cloud של האפליקציה.

3. הפעלה של Google Workspace Event API ו-Google Cloud Pub/Sub API:

   gcloud services enable pubsub.googleapis.com workspaceevents.googleapis.com
   

מסוף Google Cloud

1. נכנסים לדף Pub/Sub במסוף Google Cloud:

   כניסה לדף Google Cloud Pub/Sub

   מוודאים שהפרויקט ב-Cloud עבור האפליקציה נבחר.

2. לוחצים על add_box יצירת נושא. לבצע את הפעולות הבאות:

   1. מזינים שם לנושא, למשל workspace-events-topic.
   2. משאירים את הסימון של האפשרות הוספת מינוי ברירת מחדל. השם הזה ב-Pub/Sub ברירת המחדל של המינוי, כמו שם הנושא, workspace-events-topic-sub
   3. אופציונלי: עדכון או הגדרה של מאפיינים נוספים בנושא שלכם.

3. לוחצים על יצירה. שם הנושא המלא מופיע בפורמט הבא: projects/PROJECT_ID/topics/TOPIC_ID השם המלא הזה ישמש אתכם בשלב מאוחר יותר.

4. מעניקים גישה כדי לפרסם הודעות Pub/Sub בנושא:

   1. בדף של הנושא, עוברים לחלונית הצדדית ופותחים את Permissions.
   2. לוחצים על הוספת חשבון משתמש.
   3. בשדה Add principals, מוסיפים את חשבון השירות של אפליקציית Google Workspace שמספקת אירועים מינוי:
      1. באירועים של Chat: chat-api-push@system.gserviceaccount.com
      2. באירועים של Meet: meet-api-event-push@system.gserviceaccount.com
   4. בתפריט הקצאת תפקידים, בוחרים באפשרות Pub/Sub Publisher.
   5. לוחצים על שמירה. עדכון ההרשאות עשוי להימשך כמה דקות. בנושא שלכם.

gcloud

1. בפרויקט ב-Cloud, כדי ליצור נושא מריצים את הפקודה הבאה הפקודה:

   gcloud pubsub topics create TOPIC_ID
   

   מחליפים את TOPIC_ID במזהה ייחודי של הנושא, כמו בתור workspace-events-topic.

   בפלט יוצג שם הנושא המלא, בפורמט projects/PROJECT_ID/topics/TOPIC_ID רושמים בצד את השם ומוודאים שהערך שלו PROJECT_ID הוא מזהה הפרויקט ב-Cloud לאפליקציה. בשלב הבא משתמשים בשם הנושא, וכדי ליצור המינוי ל-Google Workspace מאוחר יותר.

2. כדי לפרסם הודעות בנושא צריך לתת גישה:

   gcloud pubsub topics add-iam-policy-binding TOPIC_NAME --member='serviceAccount:GOOGLE_WORKSPACE_APPLICATION' --role='roles/pubsub.publisher'
   

   מחליפים את מה שכתוב בשדות הבאים:

   • TOPIC_NAME: השם המלא של הנושא, שהוא כפלט מהשלב הקודם. בפורמט: projects/PROJECT_ID/topics/TOPIC_ID

   • GOOGLE_WORKSPACE_APPLICATION: אפליקציית Google Workspace שצריך להעביר אירועים אל המינוי שלך:

     • כדי לקבל אירועים מ-Chat: chat-api-push@system.gserviceaccount.com
     • כדי לקבל אירועים מ-Meet, צריך: meet-api-event-push@system.gserviceaccount.com

   יכול להיות שיעברו כמה דקות עד שההרשאות לנושא יתעדכן.

3. יוצרים מינוי Pub/Sub לנושא:

    gcloud pubsub subscriptions create SUBSCRIPTION_NAME --topic=TOPIC_NAME
   

   מחליפים את מה שכתוב בשדות הבאים:

   • SUBSCRIPTION_NAME: שם המינוי שלכם כמו workspace-events-subscription.
   • TOPIC_NAME: שם הנושא שיצרתם בשלב הקודם.

Apps Script

1. בפרויקט Apps Script, יוצרים קובץ סקריפט חדש שנקרא createSubscription ומוסיפים את הקוד הבא:

   function createSubscription() {
     // The Google Workspace resource to monitor for events.
     const targetResource = 'TARGET_RESOURCE';
   
     // The types of events to receive.
     const eventTypes = [EVENT_TYPES];
   
     // The endpoint to deliver events to, such as a Google Cloud Pub/Sub topic.
     const pubsubTopic = 'TOPIC_NAME';
   
     // Whether to include resource data or not.
     const resourceData = RESOURCE_DATA;
   
     // Call the Workspace Events API using the advanced service.
     const response = WorkspaceEvents.Subscriptions.create({
       targetResource: targetResource,
       eventTypes: eventTypes,
       notificationEndpoint: {
         pubsubTopic: pubsubTopic,
       },
       payloadOptions: {
         includeResource: resourceData
       }
     });
     console.log(response);
   }
   

   מחליפים את מה שכתוב בשדות הבאים:

   • TARGET_RESOURCE: המשאב של Google Workspace שנרשמת אליו, בפורמט של השם המלא של המשאב. עבור למשל, כדי להירשם למרחב ב-Google Chat עם מזהה המרחב AAAABBBB, שימוש ב-//chat.googleapis.com/spaces/AAAABBBB.
   • EVENT_TYPES: סוג אירוע אחד או יותר שרוצים להירשם אליו במשאב היעד. עיצוב כ מערך של מחרוזות כמו 'google.workspace.chat.message.v1.created'.
   • TOPIC_NAME: השם המלא של נושא Pub/Sub ש שיצרתם בפרויקט ב-Cloud. בפורמט: projects/PROJECT_ID/topics/TOPIC_ID

   • RESOURCE_DATA: ערך בוליאני שמציין אם המינוי כולל נתוני משאבים במטען הייעודי (payload):

     • True: כולל את כל נתוני המשאבים. כדי להגביל את השדות כלול, יש להוסיף את fieldMask ולציין לפחות שדה אחד עבור המשאב שהשתנה. רק מינויים לתמיכה במשאבי Chat, כולל לנתוני המשאבים.
     • False: החרגה של נתוני המשאבים.

2. כדי ליצור מינוי ל-Google Workspace, צריך להריץ את הפונקציה createSubscription בפרויקט Apps Script שלך.

Python

1. בספריית העבודה, יוצרים קובץ בשם create_subscription.py ומוסיפים את הקוד הבא:

   """Create subscription."""
   
   from google_auth_oauthlib.flow import InstalledAppFlow
   from googleapiclient.discovery import build
   
   # Specify required scopes.
   SCOPES = [SCOPES]
   
   # Authenticate with Google Workspace and get user authentication.
   flow = InstalledAppFlow.from_client_secrets_file('client_secrets.json', SCOPES)
   CREDENTIALS = flow.run_local_server()
   
   # The Google Workspace resource to monitor for events.
   TARGET_RESOURCE = 'TARGET_RESOURCE'
   
   # The types of events to receive.
   EVENT_TYPES = [EVENT_TYPES]
   
   # The endpoint to deliver events to, such as a Google Cloud Pub/Sub topic.
   TOPIC = 'TOPIC_NAME'
   
   # Call the Workspace Events API using the service endpoint.
   service = build(
       'workspaceevents',
       'v1',
       credentials=CREDENTIALS,
   )
   
   BODY = {
       'target_resource': TARGET_RESOURCE,
       'event_types': EVENT_TYPES,
       'notification_endpoint': {'pubsub_topic': TOPIC},
       'payload_options': {'include_resource': RESOURCE_DATA},
   }
   response = service.subscriptions().create(body=BODY).execute()
   print(response)
   

   מחליפים את מה שכתוב בשדות הבאים:

   • SCOPES: היקף הרשאות OAuth אחד או יותר שתומך בכל סוג אירוע למינוי. בפורמט של מערך מחרוזות. כדי לציין כמה היקפים, צריך להפריד ביניהם באמצעות פסיקים. לדוגמה, 'https://www.googleapis.com/auth/chat.spaces.readonly', 'https://www.googleapis.com/auth/chat.memberships.readonly'.
   • TARGET_RESOURCE: המשאב של Google Workspace שנרשמת אליו, בפורמט של השם המלא של המשאב. עבור למשל, כדי להירשם למרחב ב-Google Chat עם מזהה המרחב AAAABBBB, שימוש ב-//chat.googleapis.com/spaces/AAAABBBB.
   • EVENT_TYPES: סוג אירוע אחד או יותר שרוצים להירשם אליו במשאב היעד. עיצוב כ מערך של מחרוזות כמו 'google.workspace.chat.message.v1.created'.
   • TOPIC_NAME: השם המלא של נושא Pub/Sub ש שיצרתם בפרויקט ב-Cloud. בפורמט: projects/PROJECT_ID/topics/TOPIC_ID

   • RESOURCE_DATA: ערך בוליאני שמציין אם המינוי כולל נתוני משאבים במטען הייעודי (payload):

     • True: כולל את כל נתוני המשאבים. כדי להגביל את השדות כלול, יש להוסיף את fieldMask ולציין לפחות שדה אחד עבור המשאב שהשתנה. רק מינויים לתמיכה במשאבי Chat, כולל לנתוני המשאבים.
     • False: החרגה של נתוני המשאבים.

2. כדי ליצור את המינוי ל-Google Workspace, צריך להריץ את הפקודה הבאה ב- הטרמינל:

   python3 create_subscription.py
   

מסוף Google Cloud

1. להפעיל סוג אחד או יותר של אירוע במשאב היעד של מינוי ל-Google Workspace. לדוגמה, אם נרשמתם כמנויים ל הודעות במרחב ב-Chat, פרסום הודעה במרחב המשותף.

2. נכנסים לדף Pub/Sub במסוף Google Cloud:

   כניסה ל-Pub/Sub

   מוודאים שהפרויקט ב-Cloud עבור האפליקציה נבחר.

3. בתפריט Pub/Sub לוחצים על מינויים.

4. מוצאים בטבלה את מינוי Pub/Sub לנושא ולוחצים על שם המינוי.

5. לוחצים על הכרטיסייה הודעות.

6. לוחצים על Pull. יצירת אירוע עשויה להימשך מספר דקות הודעת Pub/Sub.

gcloud

1. להפעיל סוג אחד או יותר של אירוע במשאב היעד של מינוי ל-Google Workspace. לדוגמה, אם נרשמתם כמנויים ל הודעות במרחב ב-Chat, לפרסם הודעה במרחב המשותף.

2. מריצים את הפקודה הבאה:

   gcloud pubsub subscriptions pull PUBSUB_SUBSCRIPTION_NAME --format=json --limit=MESSAGE_COUNT --auto-ack
   

   מחליפים את מה שכתוב בשדות הבאים:

   • PUBSUB_SUBSCRIPTION_NAME: השם המלא של מינוי Pub/Sub, בפורמט projects/SUBSCRIPTION_ID/subscriptions/SUBSCRIPTION_ID.
   • MESSAGE_COUNT: המספר המקסימלי של הודעות Pub/Sub שרוצים לשלוף.

   יצירת Pub/Sub באירוע יכולה להימשך כמה דקות הודעה.