דף זה תורגם על ידי Cloud Translation API.

סוגי אירועים.

בדף הזה מוסבר על הנכס eventType ומפרטים של סוגי האירועים שזמינות ב-API של יומן Google.

יומן Google מאפשר למשתמשים ליצור אירועים גנריים וגם אירועים מיועדים לתרחישים לדוגמה ספציפיים ולמאפיינים מותאמים אישית.

סוג האירוע מופיע במקומות הבאים ב-API:

כל האירועים מוחזרים עם eventType.
eventType צריך להגדיר אותו כשיוצרים או מעדכנים משאב של אירוע. אם המדיניות לא מוגדרת, ייעשה שימוש בסוג אחד ('default').
eventTypes אפשר לציין את העמודות Events:list (רשימת אירועים) קריאה לרשימת אירועים מסוגים מסוימים. אם לא צוין סוג, כל סוגי האירועים יוחזר.
eventTypes ניתן לציין את הערך בשדה Events:watch התקשרות להירשם לקבלת עדכונים על אירועים מסוגים מסוימים. אם לא צוין סוג שצוין, הבקשה תוביל להרשמה לכל סוגי האירועים.

אירוע ברירת המחדל

אירועים עם סוג האירוע default נוצרים ומשמשים כאחד האירועים הראשיים של Google Calendar API. הן תומכות במגוון רחב של נכסים מידע שיכול לשמש להתאמה אישית נוספת של האירוע.

צפייה ליצור אירועים כדי להתחיל לעבוד איתם אירועים ביומן Google.

יום הולדת

ימי הולדת הם אירועים מיוחדים שנמשכים כל היום, עם חזרה שנתית. הם כוללים המפרטים הבאים:

eventType מוגדר 'birthday'
start ו- ב-end שדות צריך להגדיר אירוע של יום שלם שנמשך יום אחד בלבד.
ערך השדה visibility חייב להיות 'private'.
ערך השדה transparency חייב להיות 'transparent'.
צריכה להיות חזרה שנתית, כלומר השדה recurrence חייב להיות 'RRULE:FREQ=YEARLY' אירועי יום הולדת שיחול ב-29 בפברואר חייבים להיות כלל לחזרה הבא: 'RRULE:FREQ=YEARLY;BYMONTH=2;BYMONTHDAY=-1'
יכול להכיל colorId, summary והקבוצה reminders.
הם לא תומכים במאפייני אירועים אחרים.

אירועים מ-Gmail

אירועים שנוצרים באופן אוטומטי מ-Gmail הם מסוג 'fromGmail'.

אי אפשר ליצור אירוע מהסוג הזה ב-Google Calendar API באמצעות insert.

ה-API מאפשר לעדכן את colorId, reminders, visibility, transparency, status, private וגם shared נכסים מורחבים באמצעות העדכון ותיקון.

ה-API תומך ב-get וב- להציג שיטות לקריאת אירועים מ: Gmail. eventTypes יכול להיות מוגדרת לערך 'fromGmail' כך שיוצגו רק אירועים שנוצרו מ-Gmail. אם לא צוין סוג שצוינו, אירועים מ-Gmail יופיעו לצד כל סוגי האירועים האחרים.

ה-API תומך ב-method watch כדי להירשם לעדכונים על אירועים מ-Gmail ביומן Google. אם לא צוין סוג שציינת, יתבצע הרשמה לכל סוגי האירועים, כולל 'fromGmail'.

אפשר למחוק אירועים מ-Gmail באמצעות delete של ממשק API של יומן Google.

שינוי מארגן האירוע מ-Gmail באמצעות העברה או אין תמיכה בשיטות עדכון.

זמן לעצמי, מחוץ למשרד ובמיקום העבודה

אפשר להשתמש ב-API של יומן Google כדי ליצור ולנהל אירועים שמציגים את של משתמשי יומן Google.

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

עיון בסוגי אירועים ב-Google Apps Script

Google Apps Script הוא ענן מבוסס-JavaScript שפת סקריפטים שמאפשרת לכם לבנות אפליקציות עסקיות שמשתלבות עם Google Workspace הפיתוח של סקריפטים נעשה באמצעות עורך קוד מבוסס-דפדפן הם מאוחסנים ופועלים בשרתים של Google. ראה גם Google Apps Script המדריך למתחילים כדי להתחיל להשתמש Apps Script לשליחת בקשות ל-API של יומן Google.

בהוראות שבהמשך מוסבר איך לקרוא ולנהל אירועים באמצעות Google Calendar API בתור שירות מתקדם ב- Google Apps Script. לרשימה מלאה של המשאבים והשיטות ב-Google Calendar API: עיינו במאמרי העזרה.

יצירה והגדרה של הסקריפט

כדי ליצור סקריפט, עוברים אל script.google.com/create.
בחלונית הימנית, ליד שירותים, לוחצים על 'הוספת שירות'. .
בוחרים באפשרות Google Calendar API ולוחצים על הוספה.
אחרי ההפעלה, ה-API יופיע בחלונית הימנית. השיטות הזמינות וגם אפשר לרשום בכלי העריכה את הכיתות ב-API באמצעות מילת המפתח יומן Google.

(אופציונלי) מעדכנים את הפרויקט ב-Google Cloud.

לכל פרויקט ב-Google Apps Script משויך פרויקט ב-Google Cloud. שלך הסקריפט יכול להשתמש בפרויקט ברירת המחדל ש-Google Apps Script יכול לפעול בו באופן אוטומטי יוצרת. אם רוצים להשתמש בפרויקט מותאם אישית ב-Google Cloud, אפשר לקרוא את המאמר מעבר אל של פרויקט סטנדרטי אחר ב-Cloud. אחרי הגדרת הפרויקט ב-Google Cloud, בוחרים באפשרות Editor בצד ימין כדי לנווט חזרה אל בעורך הקוד.

הוספת קוד לסקריפט

דוגמת הקוד הבאה מראה איך להציג ברשימה, לקרוא וליצור אירועים עם ערכי eventType שונים.

מדביקים את הפקודה הבאה בעורך הקוד.

const CALENDAR_ID = 'CALENDAR_ID' || 'primary';

/** Lists default events. */
function listDefaultEvents() {
  listEvents('default');
}

/** Lists events from Gmail. */
function listEventsFromGmail() {
  listEvents('fromGmail');
}

/**
  * Lists events with the given event type. If no type is specified, lists all events.
  * See https://developers.google.com/calendar/api/v3/reference/events/list
  */
function listEvents(eventType = undefined) {
  // Query parameters for the list request.
  const optionalArgs = {
    eventTypes: eventType ? [eventType] : undefined,
    singleEvents: true,
    timeMax: '2024-07-30T00:00:00+01:00',
    timeMin: '2024-07-29T00:00:00+01:00',
  }
  try {
    var response = Calendar.Events.list(CALENDAR_ID, optionalArgs);
    response.items.forEach(event => console.log(event));
  } catch (exception) {
    console.log(exception.message);
  }
}

/**
  * Reads the event with the given eventId.
  * See https://developers.google.com/calendar/api/v3/reference/events/get
  */
function readEvent() {
  try {
    var response = Calendar.Events.get(CALENDAR_ID, 'EVENT_ID');
    console.log(response);
  } catch (exception) {
    console.log(exception.message);
  }
}

/** Creates a default event. */
function createDefaultEvent() {
  const event = {
    start: { dateTime: '2024-07-30T10:30:00+01:00'},
    end: { dateTime: '2024-07-30T12:30:00+01:00'},
    description: 'Created from Apps Script.',
    eventType: 'default',
    summary: 'Sample event',
  }
  createEvent(event);
}

/**
  * Creates a Calendar event.
  * See https://developers.google.com/calendar/api/v3/reference/events/insert
  */
function createEvent(event) {

  try {
    var response = Calendar.Events.insert(event, CALENDAR_ID);
    console.log(response);
  } catch (exception) {
    console.log(exception.message);
  }
}

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

CALENDAR_ID: כתובת האימייל של היומן אל לאחזר וליצור אירועים בהם. קבוע זה מוגדר תחילה כ- 'primary', שהיא מילת מפתח לגישה ליומן הראשי של משתמש שמחובר לחשבון. שינוי הערך הזה יאפשר לך לקרוא אירועים ביומנים של משתמשים אחרים שיש לך גישה אליהם.
EVENT_ID: מזהה האירוע. אפשר לקרוא ל- events:list כדי לאחזר מזהי אירועים.

מריצים את דוגמת הקוד

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