פעולות בשקף

‫Google Slides API מאפשר ליצור, להעביר ולמחוק שקפים. בדוגמאות שבדף הזה מוצגות כמה פעולות נפוצות בשקפים באמצעות השיטה presentations.batchUpdate.

בדוגמאות האלה נעשה שימוש במשתנים הבאים:

• ‫PRESENTATION_ID—מציין איפה מספקים את מזהה המצגת. אפשר למצוא את הערך של המזהה הזה בכתובת ה-URL של המצגת.
• ‫PAGE_ID ו-PAGE_ID2 – מציינים איפה מספקים את מזהי אובייקט הדף. אפשר לאחזר את הערך של המאפיין הזה מכתובת ה-URL או באמצעות בקשת קריאה של API.

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

העתקת שקף

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

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

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

הפרוטוקול לבקשה להעתקת שקף:

POST https://slides.googleapis.com/v1/presentations/PRESENTATION_ID:batchUpdate

{
  "requests": [
    {
      "duplicateObject": {
        "objectId": PAGE_ID,
        "objectIds": {
          "PAGE_ID": "COPY_PAGE_ID",
          "TABLE_ELEMENT_ID": "COPY_TABLE_ELEMENT_ID"
        }
      }
    }
  ]
}

יצירת שקף

בדוגמת הקוד הבאה של presentations.batchUpdate אפשר לראות איך משתמשים בשיטה CreateSlideRequest כדי ליצור שקף ולהוסיף אותו כשקף הרביעי (באמצעות insertionIndex, שמתחיל מאפס) במצגת.

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

הפרוטוקול של הבקשה ליצירת שקף:

POST https://slides.googleapis.com/v1/presentations/PRESENTATION_ID:batchUpdate

{
  "requests": [
    {
      "createSlide": {
        "objectId": "PAGE_ID",
        "insertionIndex": 3,
        "slideLayoutReference": {
          "predefinedLayout": "TITLE_AND_TWO_COLUMNS"
        }
      }
    }
  ]
}

יצירה של שקף ושינוי של משבצות placeholder

בדוגמת הקוד הבאה של presentations.batchUpdate אפשר לראות איך משתמשים בשיטה CreateSlideRequest כדי ליצור שקף באמצעות PredefinedLayout של TITLE_AND_TWO_COLUMNS.

אפשר לציין מחרוזת לשימוש כ-PAGE_ID בשקף (עם הגבלות מסוימות). ה-placeholderIdMappings משתמש ב-Type של TITLE. ההפניה TITLE_ID היא לצורת הפלייסהולדר בשקף, כדי שאפשר יהיה לשנות אותה.

הפרוטוקול הבא הוא פרוטוקול הבקשה ליצירת שקף ולשינוי של פלייסולדרים:

POST https://slides.googleapis.com/v1/presentations/PRESENTATION_ID:batchUpdate

{
  "requests": [
    {
      "createSlide": {
        "objectId": PAGE_ID,
        "slideLayoutReference": {
          "predefinedLayout": "TITLE_AND_TWO_COLUMNS"
        },
        "placeholderIdMappings": [
          {
            "layoutPlaceholder": {
              "type": "TITLE",
              "index": 0
            },
            "objectId": TITLE_ID,
           },
        ],
      }
    },
    {
      "insertText": {
        "objectId": TITLE_ID,
        "text": "This is my slide title",
      }
    },
  ]
}

העברת שקפים למיקום חדש

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

מזהי השקפים שצוינו (PAGE_ID ו-PAGE_ID2) צריכים להיות מסודרים לפי הסדר הקיים במצגת, בלי כפילויות. הערך insertionIndex מבוסס על אפס ומציין את המיקום שבו צריך להוסיף את השקפים, לפי הסדר לפני ההעברה. הערך צריך להיות בין אפס לבין מספר השקפים במצגת, כולל.

זהו פרוטוקול הבקשה להעברת שקפים למיקום חדש:

POST https://slides.googleapis.com/v1/presentations/PRESENTATION_ID:batchUpdate

{
  "requests": [
    {
      "updateSlidesPosition": {
        "slideObjectIds": [
          PAGE_ID,
          PAGE_ID2
          ],
        "insertionIndex": 0
      }
    }
  ]
}

הגדרת תמונת רקע לשקף

בדוגמת הקוד הבאה presentations.batchUpdate מוצג אופן השימוש בשיטה UpdatePagePropertiesRequest כדי להגדיר את תמונת הרקע של שקף שצוין על ידי PAGE_ID. ה-API מאחזר את התמונה באמצעות IMAGE_URL.

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

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

הפרוטוקול לבקשה להגדרת תמונת רקע לשקף:

POST https://slides.googleapis.com/v1/presentations/PRESENTATION_ID:batchUpdate

{
  "requests": [
    {
      "updatePageProperties": {
        "objectId": PAGE_ID,
        "pageProperties": {
          "pageBackgroundFill": {
            "stretchedPictureFill": {
              "contentUrl": IMAGE_URL
            }
          }
        },
        "fields": "pageBackgroundFill"
      }
    }
  ]
}

יצירת תמונה ממוזערת

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

אפשר גם לציין את הערכים mimeType ו-thumbnailSize שמוחזרים באמצעות השדה ThumbnailProperties כפרמטר של שאילתה.

הפרוטוקול הבא הוא פרוטוקול הבקשה ליצירת תמונה ממוזערת של הדף עם ThumbnailProperties:

 GET https://slides.googleapis.com/v1/presentations/PRESENTATION_ID/pages/PAGE_ID/thumbnail?thumbnailProperties.mimeType=PNG&thumbnailProperties.thumbnailSize=MEDIUM

{
  "width": 800,
  "height": 450,
  "contentUrl": "CONTENT_URL"
}