מחיקת מינוי ל-Google Workspace

בדף הזה מוסבר איך מוחקים מינוי ל-Google Workspace באמצעות subscriptions.delete() .

כשמוחקים מינוי, האפליקציה לא מקבלת יותר אירועים. אם עד שיפוג התוקף של המינוי, הוא יימחק באופן אוטומטי על ידי Google Workspace Event API.

דרישות מוקדמות

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. כדי ליצור תיעוד, תוכלו להיעזר במאמר יצירת מינוי.

  • נדרש אימות:

    • לאימות משתמשים, נדרש היקף שתומך לפחות באחד מסוגי האירועים של המינוי. כדי לזהות היקף הרשאות, אפשר לעיין במאמר היקפים לפי סוג אירוע.
    • כדי לאמת אפליקציות, נדרש היקף הרשאות chat.bot (באפליקציות של Google Chat בלבד).

מחיקת מינוי שאושר על ידי משתמש

דוגמת הקוד הבאה מוחקת משאב Subscription באמצעות אימות משתמש.

כדי למחוק מינוי:

Apps Script

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

    function deleteSubscription() {
  // The name of the subscription to delete.
  const name = 'subscriptions/SUBSCRIPTION_ID';

  // Call the Workspace Events API using the advanced service.
  const response = WorkspaceEvents.Subscriptions.remove(name);
  console.log(response);
}

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

    • SUBSCRIPTION_ID: מזהה המינוי. כדי למצוא את המזהה, אפשר להשתמש באחת מהאפשרויות הבאות:
      • הערך של uid.
      • המזהה של שם המשאב שמיוצג בקובץ name. לדוגמה, אם שם המשאב הוא subscriptions/subscription-123, שימוש ב-subscription-123.

  2. כדי למחוק את המינוי, עליך להריץ את הפונקציה deleteSubscription ב- פרויקט Apps Script.

Python

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

    """Delete subscription."""

from google_auth_oauthlib.flow import InstalledAppFlow
from googleapiclient.discovery import build

# Specify required scopes.
SCOPES = ['SCOPE']

# 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,
)

NAME = 'subscriptions/SUBSCRIPTION_ID'
response = service.subscriptions().delete(name=NAME).execute()
print(response)

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

    • SCOPE: היקף הרשאות OAuth שתומך לפחות סוג אירוע אחד מהמינוי. לדוגמה, אם המינוי מקבל אירועים מרחב משותף מעודכן ב-Chat, https://www.googleapis.com/auth/chat.spaces.readonly.
    • SUBSCRIPTION_ID: מזהה המינוי. כדי למצוא את המזהה, אפשר להשתמש באחת מהאפשרויות הבאות:
      • הערך של uid.
      • המזהה של שם המשאב שמיוצג בקובץ name. לדוגמה, אם שם המשאב הוא subscriptions/subscription-123, שימוש ב-subscription-123.

  2. בספריית העבודה, צריך לוודא ששמרת את מזהה הלקוח של OAuth ונותנים את השם client_secrets.json. דוגמת הקוד משתמשת בקובץ ה-JSON הזה כדי לבצע אימות באמצעות Google Workspace ולקבל פרטי כניסה של משתמשים. לקבלת הוראות, מידע נוסף זמין בקטע יצירת מזהה לקוח OAuth פרטי כניסה לחשבון.

  3. כדי למחוק את המינוי, מריצים את הפקודה הבאה בטרמינל:

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