ייבוא נתונים ל-Google Chat

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

למטה מפורט תהליך הייבוא המלא:

1. תכנון הייבוא
2. הגדרת הרשאה לאפליקציית Chat
3. יצירת מרחב משותף במצב ייבוא
4. ייבוא משאבים
5. אימות משאבים מיובאים
6. התאמה להבדלים בין משאבים מיובאים לבין נתוני מקור
7. מצב ייבוא מלא
8. איך מעניקים גישה למרחב המשותף אחרי מצב ייבוא
9. פתרון בעיות

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

תכנון הייבוא

לתכנן בהתאם את כמות הנתונים לייבוא, ולהבין איך מגבלות ומכסות שימוש יכולות להשפיע על את תהליך הייבוא, וצריך לשים לב לסוגים של המרחבים המשותפים ב-Chat בתהליך ייבוא למרחב חדש.

בדיקה של מגבלות השימוש ב-API

הזמן שנדרש לייבוא נתונים ל-Chat יכול להשתנות מאוד בהתאם לכמות המשאבים ב-Chat שרוצים לייבא. צריך לבדוק את אפליקציית Chat מגבלות השימוש וכמות הנתונים שתוזמנו מפלטפורמת העברת ההודעות של המקור כדי לקבוע את ציר הזמן המשוער.

כשמייבאים הודעות למרחב משותף, מומלץ לפזר את השיחות אליו אל messages.create() בשרשורי הודעות שונים.

זיהוי המרחבים המשותפים הנתמכים לייבוא

מצב הייבוא תומך רק ב-SpaceType של SPACE. הוא לא תומך DIRECT_MESSAGE אם אתם משתמשים בתצוגה המקדימה למפתחים התוכנית, GROUP_CHAT הוא גם נתמך. לעיון במסמכי התיעוד בנושא SpaceType אפשר לקבל מידע נוסף.

יצירת מרחב משותף במצב ייבוא

כדי ליצור מרחב במצב ייבוא, קוראים אמצעי תשלום אחד (create) ב מקור מידע אחד (Space) ומגדירים את importMode לערך true.

כשיוצרים את המרחב המשותף במצב ייבוא, חשוב לשים לב לנקודות הבאות.

• התאריך והשעה - זכרו, חובה להשלים את מצב הייבוא תוך 30 יום ימים. אם המרחב המשותף עדיין במצב ייבוא אחרי 30 ימים מאז הקריאה ל-method spaces.create(), נמחק אוטומטית ולא ניתן לשחזר אותו.
  • אל תשתמשו בערך של createTime כדי לעקוב אחרי פקיעת התוקף של מסגרת הזמן של 30 יום. זו לא תמיד זהה לזו שקוראים ל-method spaces.create(). מתי באמצעות מצב ייבוא, ניתן להגדיר את השדה createTime לערך חותמת הזמן שבה המרחב המשותף נוצר במקור כדי לשמר את זמן היצירה המקורי.
• שם המשאב של המרחב המשותף (name) – המזהה הייחודי שמשמש לאחזור מידע על שטח ספציפי, ומופיעים בה הפניות בשלבים מאוחרים יותר כשמייבאים תוכן לתוך המרחב.

כדי לשמר את זמן היצירה של ישות המרחב המקבילה מהמקור פלטפורמת העברת ההודעות, אפשר להגדיר את createTime של המרחב. הזה צריך להגדיר את createTime לערך בין 1 בינואר 2000 לבין השעה הנוכחית.

כדי ליצור מרחב חיצוני במצב ייבוא, צריך להגדיר את externalUserAllowed לערך true. כשהייבוא יסתיים, תוכלו להוסיף משתמשים חיצוניים.

תוכלו לראות בדוגמה הבאה איך ליצור מרחב משותף במצב ייבוא:

function createSpaceInImportMode() {
  const space = Chat.Spaces.create({
      spaceType: 'SPACE',
      displayName: 'DISPLAY_NAME',
      importMode: true,
      createTime: (new Date('January 1, 2000')).toJSON()
  });
  console.log(space.name);
}

"""Create a space in import mode."""

import datetime

from google.oauth2 import service_account
from googleapiclient.discovery import build

# Specify required scopes.
SCOPES = [
    'https://www.googleapis.com/auth/chat.import',
]

CREDENTIALS = (
    service_account.Credentials.from_service_account_file('credentials.json')
    .with_scopes(SCOPES)
    .with_subject('EMAIL')
)

# Build a service endpoint for Chat API.
service = build('chat', 'v1', credentials=CREDENTIALS)

result = (
    service.spaces()
    .create(
        body={
            'spaceType': 'SPACE',
            'displayName': 'DISPLAY_NAME',
            'importMode': True,
            'createTime': f'{datetime.datetime(2000, 1, 1).isoformat()}Z',
        }
    )
    .execute()
)

print(result)

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

• EMAIL: כתובת האימייל של חשבון המשתמש שאתם מתחזים לרשות שחלה על הדומיין כולו.
• DISPLAY_NAME: השם של המרחב המשותף שנוצר בו במצב ייבוא. השם הזה חייב להיות שם ייחודי של המרחב המשותף שמוצג בפני משתמשי צ'אט. מומלץ להשתמש בשם המוצג הזהה המרחב שממנו מייבאים נתונים.

ייבוא משאבים

כדי לייבא משאבים מפלטפורמות אחרות של העברת הודעות, אתם צריכים ליצור את Google Chat משאבים (כמו הודעות, תגובות וקבצים מצורפים) במרחב של מצב הייבוא. כשיוצרים משאב במרחב, מציינים נתונים מפלטפורמת ההודעות שממנה מתבצעת ההעברה.

הודעות

האפליקציות שלכם ל-Chat יכולות לייבא הודעות לפי ההרשאה שלהן, או בשם משתמש באמצעות התחזות. מחבר ההודעה מוגדר חשבון משתמש שאליו בוצעה התחזות. מידע נוסף זמין במאמר הבא: מתן הרשאה לאפליקציות Chat. כדי לייבא במרחב עם מצב ייבוא, אמצעי תשלום אחד (create) ב משאב Message. כדי לשמר את זמן היצירה של ההודעה המקורית מהמקור פלטפורמת העברת הודעות, אפשר להגדיר את createTime של ההודעה. הזה צריך להגדיר את createTime כערך בין זמן יצירת המרחב המשותף הזמן שהוגדר קודם לכן והיום הנוכחי.

הודעות באותו מרחב לא יכולות להכיל את אותו createTime, גם אם הודעות קודמות באותו זמן יימחקו.

אי אפשר לעבד קישור בהודעות שיש בהן כתובות URL של צד שלישי במרחבים משותפים במצב ייבוא תצוגות מקדימות ב-Google Chat.

כשיוצרים הודעות במצב ייבוא, במרחבים משותפים לא מוצגות התראות ולא שולחים אימיילים למשתמשים כלשהם, כולל הודעות שמכילות אזכורים של משתמשים.

תוכלו להיעזר בדוגמה הבאה כדי ליצור הודעה במרחב עם מצב ייבוא:

"""Create a message in import mode space."""

import datetime

from google.oauth2 import service_account
from googleapiclient.discovery import build

# Specify required scopes.
SCOPES = [
    'https://www.googleapis.com/auth/chat.import',
]

CREDENTIALS = (
    service_account.Credentials.from_service_account_file('credentials.json')
    .with_scopes(SCOPES)
    .with_subject('EMAIL')
)

# Build a service endpoint for Chat API.
service = build('chat', 'v1', credentials=CREDENTIALS)

NAME = 'spaces/SPACE_NAME'
result = (
    service.spaces()
    .messages()
    .create(
        parent=NAME,
        body={
            'text': 'Hello, world!',
            'createTime': f'{datetime.datetime(2000, 1, 2).isoformat()}Z',
        },
    )
    .execute()
)

print(result)

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

• EMAIL: כתובת האימייל של חשבון המשתמש שאתם מתחזים אליו עם הרשאה ברמת הדומיין.
• SPACE_NAME: השם של המרחב המשותף שנוצר במצב ייבוא.

תגובות

אפשר לייבא מאפליקציית Chat תגובות בקשר להודעות באמצעות Chat API. לקבלת מידע על השיטות של המשאבים ועל סוגי התמיכה באימות במרחבים של מצב ייבוא, מתן הרשאה לאפליקציות Chat.

קבצים מצורפים

אפליקציית Chat יכולה העלאת קבצים מצורפים באמצעות Chat API. לקבלת מידע על השיטות של המשאבים ועל סוגי התמיכה באימות במרחבים של מצב ייבוא, מתן הרשאה לאפליקציות Chat. אבל, לפעמים מומלץ מאוד להשתמש Google Drive API כדי להעלות קבצים מצורפים כקובצי Google Drive ולקשר את מזהי ה-URI של הקבצים את ההודעות המתאימות במרחבים המשותפים של מצב ייבוא כדי לייבא קבצים מצורפים פלטפורמות להעברת הודעות כדי לא להגיע למגבלה הפנימית של Google Chat לגבי קבצים מצורפים .

מינויים היסטוריים

מינויים היסטוריים הם מינויים שנוצרו עבור משתמשים שכבר עזבו את ישות החלל המקורית מפלטפורמת המקור של העברת הודעות, אבל אתם רוצים לשמור את הנתונים שלהם ב-Chat. למידע על הוספת משתתפים חדשים אחרי שהסתיים הייבוא של המרחב המשותף בקטע יצירת משאב מינוי.

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

בנוסף ל-deleteTime, אפשר גם להגדיר את createTime כדי לשמור שעת ההצטרפות המקורית של החברות ההיסטורית. בניגוד ל-deleteTime, הערך createTime הוא אופציונלי. אם המדיניות לא מוגדרת, המערכת מחשבת את createTime באופן אוטומטי לפי מתבצעת חיסור של מיקרו שנייה אחת מ-deleteTime. אם המדיניות מוגדרת, createTime חייב להיות לפני deleteTime. גם תאריך ההתחלה צריך להיות מאוחר יותר ממועד יצירת המרחב המשותף. הcreateTime הזה לא משתמשים במידע כדי לקבוע את שמירת הנתונים ולא גלויים בדף האדמין כמו מסוף Google Admin ו-Google Vault.

יכולות להיות כמה דרכים שבהן משתמש יכול להצטרף למרחבים משותפים ולעזוב אותם פלטפורמת העברת הודעות מהמקור (באמצעות הזמנות, הצטרפות בנפרד, הוספה על ידי משתמש אחר), ב-Chat הפעולות האלה מיוצגות על ידי השדות של היסטוריית החברות createTime ו-deleteTime שנוספו או הוסרו.

הדוגמה הבאה מראה איך ליצור חברות היסטורית בייבוא מרחב:

"""Create a historical membership in import mode space."""

import datetime

from google.oauth2 import service_account
from googleapiclient.discovery import build

# Specify required scopes.
SCOPES = [
    'https://www.googleapis.com/auth/chat.import',
]

CREDENTIALS = (
    service_account.Credentials.from_service_account_file('credentials.json')
    .with_scopes(SCOPES)
    .with_subject('EMAIL')
)

# Build a service endpoint for Chat API.
service = build('chat', 'v1', credentials=CREDENTIALS)

NAME = 'spaces/SPACE_NAME'
USER = 'users/USER_ID'
result = (
    service.spaces()
    .members()
    .create(
        parent=NAME,
        body={
            'createTime': f'{datetime.datetime(2000, 1, 3).isoformat()}Z',
            'deleteTime': f'{datetime.datetime(2000, 1, 4).isoformat()}Z',
            'member': {'name': USER, 'type': 'HUMAN'},
        },
    )
    .execute()
)

print(result)

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

• EMAIL: כתובת האימייל של חשבון המשתמש הנוכחי התחזות להרשאה ברמת הדומיין.
• SPACE_NAME: השם של המרחב המשותף שנוצר במצב ייבוא.
• USER_ID: המזהה הייחודי של משתמש.

ייבוא משאבים במרחב משותף חיצוני

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

אימות משאבים מיובאים

אפליקציית Chat יכולה לקרוא את התוכן ולאמת אותו של מרחב במצב ייבוא על ידי קריאה list method משאב Message. אפשר לקרוא משאבים של Reaction ו-Attachment מכל הודעה שהוחזרה emojiReactionSummaries ו-attachment שדות. אפליקציות צ'אט יכולות לקרוא לשיטה הזו רק בשם המשתמש באמצעות התחזות. לקבלת מידע נוסף מידע נוסף, ראה מתן הרשאה לאפליקציות Chat.

אפליקציית Chat יכולה גם לקרוא הודעות ספציפיות עבור באמצעות קריאה אמצעי תשלום אחד (get) במשאב Message. אפליקציות צ'אט יכולות לקרוא לשיטה הזו רק כדי לקרוא את ההודעות שלהן באמצעות משתמשים בסמכות שלהם. מידע נוסף זמין במאמר הבא: מתן הרשאה לאפליקציות Chat.

אפליקציות צ'אט יכולות להציג גם רשימות של מינויים היסטוריים, על ידי קריאה אמצעי תשלום אחד (list) ב משאב Membership. אחרי שיוצאים ממצב הייבוא של המרחב המשותף, השיטה list לא חושפת נתונים היסטוריים את החברויות במועדון של הערוץ. אפליקציות צ'אט יכולות להפעיל את השיטה הזו רק ב: מטעם משתמש באמצעות התחזות. מידע נוסף זמין במאמר הבא: מתן הרשאה לאפליקציות Chat.

אפשר לקרוא את המאפיינים של מרחב במצב ייבוא באמצעות קריאה ל אמצעי תשלום אחד (get) ב משאב Space. אפליקציות צ'אט יכולות לקרוא לשיטה הזו רק באמצעות ההרשאה שלהן. מידע נוסף זמין במאמר הבא: מתן הרשאה לאפליקציות Chat.

התאמה של הבדלים בין משאבים מיובאים לנתוני מקור

אם משאב מיובא כלשהו לא תואם יותר לישות המקורית מהמקור של פלטפורמת הודעות עקב שינויים בישות המקורית במהלך הייבוא, אפליקציות צ'אט יכולות לקרוא ל-Chat API כדי לשנות את מקור המידע בצ'אט. לדוגמה, אם משתמש עורך הודעה בהודעות המקור אחרי שההודעה נוצרה ב-Chat, אפליקציות צ'אט יכולות לעדכן את ההודעה המיובאת כך שתשקף את את התוכן הנוכחי של ההודעה המקורית.

הודעות

לעדכון שדות נתמכים בהודעה במרחב עם מצב ייבוא, שיטת update ב משאב Message. אפליקציות צ'אט יכולות לקרוא לשיטה הזו רק באמצעות אותה רשות היה בשימוש במהלך היצירה הראשונית של ההודעה. אם השתמשתם בהתחזות למשתמש במהלך יצירת ההודעה הראשונית, עליכם להשתמש באותו משתמש מתחזה כדי מעדכנים את ההודעה הזו.

כדי למחוק הודעה במרחב במצב ייבוא, קוראים אל אמצעי תשלום אחד (delete) ב משאב Message. הגרסה המקורית לא צריכה למחוק הודעות במרחב במצב ייבוא יוצר הודעות, וניתן למחוק אותן על ידי התחזות לכל משתמש בדומיין. אפליקציות צ'אט יכולות למחוק את ההודעות של עצמן בלבד בלתי הוגנת. מידע נוסף זמין במאמר הבא: מתן הרשאה לאפליקציות Chat.

תגובות

כדי למחוק תגובה להודעה במרחב במצב ייבוא, משתמשים ב אמצעי תשלום אחד (delete) במשאב reactions. לקבלת מידע על השיטות של המשאבים ועל סוגי התמיכה באימות במרחבים של מצב ייבוא, מתן הרשאה לאפליקציות Chat.

קבצים מצורפים

כדי לעדכן קבצים מצורפים להודעה במרחב במצב ייבוא, צריך להשתמש השיטה upload בmedia משאב. מידע על השיטות ועל סוגי האימות של המשאבים תמיכה במרחבים משותפים של מצב ייבוא. מתן הרשאה לאפליקציות Chat.

מינויים היסטוריים

כדי למחוק מינוי היסטורי במרחב במצב ייבוא, משתמשים אמצעי תשלום אחד (delete) ב משאב Membership. אחרי המרחב המשותף יוצא ממצב הייבוא, השיטה delete לא מאפשרת למחוק נתונים היסטוריים את החברויות במועדון של הערוץ.

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

Spaces

לעדכון שדות נתמכים ב- במרחב במצב ייבוא, השתמשו שיטת patch במשאב spaces.

כדי למחוק מרחב משותף במצב ייבוא, משתמשים אמצעי תשלום אחד (delete) במשאב spaces.

מידע על שיטות המשאבים ועל סוגי התמיכה באימות במרחבים משותפים של מצב ייבוא, מתן הרשאה לאפליקציות Chat.

השלמת מצב הייבוא

לפני קריאה ל-completeImport חשוב לוודא שאימות התאמה של הבדלים במשאבים הושלמו. יציאה ממרחב מתוך מצב ייבוא היא תהליך בלתי הפיך ממירה את המרחב המשותף במצב ייבוא למרחב רגיל. אין אינדיקטור ב: Chat שמשייך את המרחבים האלה לייבוא נתונים.

חשוב לרשום את התאריך והשעה של הקריאה אל completeImport, כלומר שם המשאב של המשתמש שביצע את השיחה, והתשובה הוחזרה. אולי הסרטון הזה יעזור לך אם נתקלים בבעיות וצריך לבדוק אותן.

כדי להשלים את מצב הייבוא ולהפוך את המרחב לנגיש למשתמשים, אפליקציית Chat יכולה לבצע קריאה ל-method completeImport מקור מידע אחד (Space). אפליקציות צ'אט יכולות להפעיל את השיטה הזו רק בשם המשתמש באמצעות התחזות. מידע נוסף זמין במאמר הבא: מתן הרשאה לאפליקציות Chat. המשתמש שאליו בוצעה התחזות יתווסף למרחב המשותף בתור מנהל/ת המרחב המשותף תסיימו את התהליך. יש לקרוא לשיטה הזו בתוך 30 יום ממועד הפעלת method ראשונית של create.space. אם תנסו לקרוא לשיטה הזו אחרי לאחר פרק זמן של 30 יום, השיחה נכשלה בגלל שהייבוא המרחב המשותף נמחק ולא נגיש יותר אפליקציית Chat.

המשתמש שאליו בוצעה התחזות בשיטה completeImport לא חייב להיות יוצר המרחב המשותף.

הדוגמה הבאה מראה איך להשלים את מצב הייבוא:

"""Complete import."""

from google.oauth2 import service_account
from googleapiclient.discovery import build

# Specify required scopes.
SCOPES = [
    'https://www.googleapis.com/auth/chat.import',
]

CREDENTIALS = (
    service_account.Credentials.from_service_account_file('credentials.json')
    .with_scopes(SCOPES)
    .with_subject('EMAIL')
)

# Build a service endpoint for Chat API.
service = build('chat', 'v1', credentials=CREDENTIALS)

NAME = 'spaces/SPACE_NAME'
result = service.spaces().completeImport(name=NAME).execute()

print(result)

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

• EMAIL: כתובת האימייל של חשבון המשתמש הנוכחי התחזות להרשאה ברמת הדומיין.
• SPACE_NAME: השם של המרחב המשותף שנוצר במצב ייבוא.

הענקת גישה למרחב המשותף אחרי מצב ייבוא

כדי לתת למשתמשי Chat גישה למרחב המשותף שיובא לאחרונה: אפליקציות ל-Chat יכולות להמשיך להשתמש בהיקף ההרשאות של chat.import ובמשתמש הזה התחזות בתוך 30 ימים מהקריאה הראשונית לביצוע של שיטת create.space() הבאים:

• הוספת אנשים למרחב המשותף: משתמשים בשיטה create(). במשאב Membership. מומלץ להפעיל אפליקציות Chat ליצור Membership משאבים מיד אחרי שהייבוא של המרחב המשותף הושלמה, כדי שאפליקציות של Chat יוכלו להמשיך להשתמש chat.import, ולוודא שלכל החברים המיובאים יש גישה אל המרחב המשותף.
• הגדרת קהל יעד: קוראים לפונקציה שיטת update() במשאב Space. מידע נוסף על יצירה והוספה של משתמשי יעד זמין במאמר להגדיר מרחב משותף ב-Google Chat שגלוי למשתמשים ספציפיים ארגון ב-Google Workspace

כדי להשתמש בשיטות האלה עם ההיקף chat.import, המשתמש שאליו בוצעה התחזות צריך להיות המנהל/ת של המרחב המשותף.

במרחבים חיצוניים: אמצעי תשלום אחד (create()) מאפשרת גם להזמין משתמשים מחוץ לארגון ב-Workspace. לוודא להבין את כל מגבלות ידועות עבור משתמשים חיצוניים.

פתרון בעיות

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

אחרי הייבוא של מרחב משותף, CompleteImportSpace משלים עם סטטוס של OK.

הייבוא לא הושלם לפני שפג התוקף של חלון הזמנים ל-30 יום

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

לצערנו, המרחב שנמחק לא זמין יותר או ניתן לשחזר אותו, להתחיל מחדש את תהליך הייבוא.

חיפוש מרחבים חסרים

אם אתם לא מוצאים את המרחב המשותף החדש ב-Chat, אפשר לבדוק את הטבלה הבאה לתגובה שקיבלת מאת CompleteImportSpace אל אפשר לקרוא את ההסבר וללמוד איך לפתור את הבעיה.