פעולות בשקף

באמצעות 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 מוסבר איך להשתמש ב-method‏ 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"
        }
      }
    }
  ]
}

יצירה של שקף ושינוי של placeholders

בדוגמת הקוד הבאה של presentations.batchUpdate מוסבר איך להשתמש ב-method‏ CreateSlideRequest כדי ליצור שקף באמצעות PredefinedLayout של TITLE_AND_TWO_COLUMNS.

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

זהו פרוטוקול הבקשה ליצירת שקף ולשינוי של תוספי placeholder:

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"
}