עדכון או חידוש של מינוי ל-Google Workspace

בדף הזה מוסבר איך לחדש מינוי ל-Google Workspace באמצעות השיטה subscriptions.update(). אפשר להשתמש בשיטה הזו כדי לעדכן את מועד התפוגה של המינוי, כולל חידוש המינוי למועד התפוגה המקסימלי האפשרי, או כדי לעדכן את רשימת סוגי האירועים שיישלחו לגבי המשאב היעד.

Apps Script

  • פרויקט 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 Workspace

בקטע הזה נסביר איך משתמשים בשיטה subscriptions.update() של Google Workspace Events API כדי לחדש מינוי עד למועד התפוגה המקסימלי שלו. כדי לציין את שעת התפוגה המקסימלית, מעדכנים את השדה ttl של המשאב Subscription לערך 0.

מועד התפוגה המקסימלי תלוי בנתוני המשאבים שכלולים בעומס העבודה של האירוע. מידע נוסף על מועדי תפוגה זמין במאמר נתוני אירועים באירועים של Google Workspace.

כדי לחדש מינוי ל-Google Workspace:

Apps Script

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

    function updateSubscription() {
      // The name of the subscription to update.
      const name = 'subscriptions/SUBSCRIPTION_ID';
    
      // Call the Workspace Events API using the advanced service.
      const response = WorkspaceEvents.Subscriptions.patch({
        ttl: '0s',
      }, name);
      console.log(response);
    }
    

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

    • SUBSCRIPTION_ID: המזהה של המינוי. כדי לקבל את המזהה, אפשר להשתמש באחת מהאפשרויות הבאות:
      • הערך בשדה uid.
      • המזהה של שם המשאב שמוצג בשדה name. לדוגמה, אם שם המשאב הוא subscriptions/subscription-123, צריך להשתמש ב-subscription-123.
  2. כדי לעדכן את המינוי ל-Google Workspace, מריצים את הפונקציה updateSubscription בפרויקט Apps Script.

Python

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

    """Update 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()
    
    # Call the Workspace Events API using the service endpoint.
    service = build(
        'workspaceevents',
        'v1',
        credentials=CREDENTIALS,
    )
    
    BODY = {
        'ttl': {'seconds': 0},
    }
    NAME = 'subscriptions/SUBSCRIPTION_ID'
    response = (
        service.subscriptions()
        .patch(name=NAME, updateMask='ttl', body=BODY)
        .execute()
    )
    print(response)
    

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

    • SCOPES: היקף הרשאות OAuth אחד או יותר שתומכים בכל סוג אירוע עבור המינוי. בפורמט של מערך מחרוזות. כדי לציין כמה היקפים, מפרידים ביניהם בפסיקים. לדוגמה, 'https://www.googleapis.com/auth/chat.spaces.readonly', 'https://www.googleapis.com/auth/chat.memberships.readonly'.
    • SUBSCRIPTION_ID: המזהה של המינוי. כדי לקבל את המזהה, אפשר להשתמש באחת מהאפשרויות הבאות:
      • הערך בשדה uid.
      • המזהה של שם המשאב שמוצג בשדה name. לדוגמה, אם שם המשאב הוא subscriptions/subscription-123, צריך להשתמש ב-subscription-123.
  2. בספריית העבודה, מוודאים ששמרתם את פרטי הכניסה של מזהה הלקוח ב-OAuth ושנתתם לקובץ את השם client_secrets.json. דוגמת הקוד משתמשת בקובץ ה-JSON הזה כדי לבצע אימות באמצעות Google Workspace ולקבל את פרטי הכניסה של המשתמש. להוראות, תוכלו לקרוא את המאמר יצירת פרטי כניסה של מזהה לקוח OAuth.

  3. כדי לעדכן את המינוי ל-Google Workspace, מריצים את הפקודה הבאה במסוף:

    python3 update_subscription.py
Google Workspace Events API מחזיר פעולה ממושכת שמכילה את המופע של המשאב Subscription.

כדי לקבל פרטים על המשאב Subscription המעודכן, משתמשים ב-method‏ operations.get() ומציינים את המשאב Operation שהוחזר מהבקשה subscriptions.update(). אחרת, אם מציינים משאב Operation מגרסה קודמת של המינוי, התגובה תהיה ריקה.