REST Resource: presentations.pages

משאב: דף

דף במצגת.

ייצוג ב-JSON
{
  "objectId": string,
  "pageType": enum (PageType),
  "pageElements": [
    {
      object (PageElement)
    }
  ],
  "revisionId": string,
  "pageProperties": {
    object (PageProperties)
  },

  // Union field properties can be only one of the following:
  "slideProperties": {
    object (SlideProperties)
  },
  "layoutProperties": {
    object (LayoutProperties)
  },
  "notesProperties": {
    object (NotesProperties)
  },
  "masterProperties": {
    object (MasterProperties)
  }
  // End of list of possible types for union field properties.
}
שדות
objectId

string

מזהה האובייקט של הדף הזה. למזהי האובייקטים שבהם משתמשים Page ו-PageElement יש את אותו מרחב שמות.

pageType

enum (PageType)

סוג הדף.

pageElements[]

object (PageElement)

רכיבי הדף שעבר רינדור בדף.

revisionId

string

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

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

pageProperties

object (PageProperties)

המאפיינים של הדף.

שדה האיחוד properties. מאפיינים שספציפיים לכל סוג דף. לא נדרשים נכסים נוספים כדי ליצור קובצי master. הערך של properties יכול להיות רק אחת מהאפשרויות הבאות:
slideProperties

object (SlideProperties)

מאפיינים ספציפיים לשקף. השדה מוגדר רק אם pageType = SLIDE.

layoutProperties

object (LayoutProperties)

נכסים ספציפיים לפריסה. השדה מוגדר רק אם pageType = LAYOUT.

notesProperties

object (NotesProperties)

הערות לגבי נכסים ספציפיים. מוגדר רק אם pageType = NOTES.

masterProperties

object (MasterProperties)

נכסי הורה ספציפיים. השדה מוגדר רק אם pageType = MASTER.

PageType

סוג הדף.

טיפוסים בני מנייה (enum)
SLIDE דף שקף.
MASTER דף שקף ראשי.
LAYOUT דף פריסה.
NOTES דף של הערות.
NOTES_MASTER דף ראשי של הערות.

PageElement

רכיב חזותי שעבר עיבוד בדף.

ייצוג ב-JSON
{
  "objectId": string,
  "size": {
    object (Size)
  },
  "transform": {
    object (AffineTransform)
  },
  "title": string,
  "description": string,

  // Union field element_kind can be only one of the following:
  "elementGroup": {
    object (Group)
  },
  "shape": {
    object (Shape)
  },
  "image": {
    object (Image)
  },
  "video": {
    object (Video)
  },
  "line": {
    object (Line)
  },
  "table": {
    object (Table)
  },
  "wordArt": {
    object (WordArt)
  },
  "sheetsChart": {
    object (SheetsChart)
  },
  "speakerSpotlight": {
    object (SpeakerSpotlight)
  }
  // End of list of possible types for union field element_kind.
}
שדות
objectId

string

מזהה האובייקט של רכיב הדף הזה. למזהי האובייקטים שבהם משתמשים google.apps.slides.v1.Page ו-google.apps.slides.v1.PageElement יש את אותו מרחב שמות.

size

object (Size)

הגודל של רכיב הדף.

transform

object (AffineTransform)

הטרנספורמציה של אלמנט הדף.

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

הטרנספורמציה הראשונית של Group שנוצרה זה עתה היא תמיד טרנספורמציית הזהות.

title

string

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

אין תמיכה בשדה הזה לאלמנטי Group.

description

string

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

אין תמיכה בשדה הזה לאלמנטי Group.

שדה האיחוד element_kind. סוג הרכיב ש-PageElement הזה מייצג. כל הודעה מכילה את המאפיינים שספציפיים לסוג רכיב הדף הזה. הערך של element_kind יכול להיות רק אחת מהאפשרויות הבאות:
elementGroup

object (Group)

אוסף של רכיבי דף שמחוברים יחד כיחידה אחת.

shape

object (Shape)

צורה כללית.

image

object (Image)

רכיב של דף תמונה.

video

object (Video)

רכיב בדף של סרטון.

line

object (Line)

מרכיב דף של שורה.

table

object (Table)

רכיב דף של טבלה.

wordArt

object (WordArt)

רכיב דף של טקסט מעוצב.

sheetsChart

object (SheetsChart)

תרשים מקושר שמוטמע מ-Google Sheets. תרשימים לא מקושרים מיוצגים כתמונות.

speakerSpotlight

object (SpeakerSpotlight)

זרקור על הדובר.

קבוצה

סוג PageElement שמייצג אוסף משולב של רכיבי PageElements.

ייצוג ב-JSON
{
  "children": [
    {
      object (PageElement)
    }
  ]
}
שדות
children[]

object (PageElement)

אוסף הרכיבים בקבוצה. הקבוצה צריכה להכיל לפחות 2 משתמשים.

WordArt

סוג PageElement שמייצג טקסט מעוצב.

ייצוג ב-JSON
{
  "renderedText": string
}
שדות
renderedText

string

הטקסט שעבר עיבוד כ-Word Art.

SpeakerSpotlight

סוג PageElement שמייצג 'זרקור על הדובר'.

ייצוג ב-JSON
{
  "speakerSpotlightProperties": {
    object (SpeakerSpotlightProperties)
  }
}
שדות
speakerSpotlightProperties

object (SpeakerSpotlightProperties)

המאפיינים של הזרקור על הדובר.

SpeakerSpotlightProperties

המאפיינים של SpeakerSpotlight.

ייצוג ב-JSON
{
  "outline": {
    object (Outline)
  },
  "shadow": {
    object (Shadow)
  }
}
שדות
outline

object (Outline)

המתאר של הזרקור על הדובר. אם לא מגדירים את הפרמטר, לא תהיה לתמונה קו מתאר.

shadow

object (Shadow)

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

SlideProperties

המאפיינים של Page שרלוונטיים רק לדפים עם pageType‏ SLIDE.

ייצוג ב-JSON
{
  "layoutObjectId": string,
  "masterObjectId": string,
  "notesPage": {
    object (Page)
  },
  "isSkipped": boolean
}
שדות
layoutObjectId

string

מזהה האובייקט של הפריסה שעליו מבוססת השקופית הזו. המאפיין הזה הוא לקריאה בלבד.

masterObjectId

string

מזהה האובייקט של התבנית הראשית שעליו מבוסס השקופית. המאפיין הזה הוא לקריאה בלבד.

notesPage

object (Page)

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

isSkipped

boolean

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

LayoutProperties

המאפיינים של Page רלוונטיים רק לדפים עם pageType‏ LAYOUT.

ייצוג ב-JSON
{
  "masterObjectId": string,
  "name": string,
  "displayName": string
}
שדות
masterObjectId

string

מזהה האובייקט של תבנית המאסטר שעל בסיסה מבוסס הפריסה הזו.

name

string

השם של הפריסה.

displayName

string

השם של הפריסה, שקריא לאנשים.

NotesProperties

המאפיינים של Page שרלוונטיים רק לדפים עם pageType NOTES.

ייצוג ב-JSON
{
  "speakerNotesObjectId": string
}
שדות
speakerNotesObjectId

string

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

MasterProperties

המאפיינים של Page שרלוונטיים רק לדפים עם pageType‏ MASTER.

ייצוג ב-JSON
{
  "displayName": string
}
שדות
displayName

string

השם של המאסטר שקריא לבני אדם.

PageProperties

המאפיינים של Page.

הדף יקבל תכונות מהדף ההורה. בהתאם לסוג הדף, ההיררכיה מוגדרת ב-SlideProperties או ב-LayoutProperties.

ייצוג ב-JSON
{
  "pageBackgroundFill": {
    object (PageBackgroundFill)
  },
  "colorScheme": {
    object (ColorScheme)
  }
}
שדות
pageBackgroundFill

object (PageBackgroundFill)

מילוי הרקע של הדף. אם לא מגדירים את הערך, מילוי הרקע עובר בירושה מדף הורה, אם הוא קיים. אם לדף אין דף הורה, ברירת המחדל של מילוי הרקע היא המילוי התואם בכלי העריכה של Slides.

colorScheme

object (ColorScheme)

ערכת הצבעים של הדף. אם לא תגדירו אותה, ערכת הצבעים תעבור בירושה מדף הורה. אם לדף אין דף הורה, תבנית הצבעים תהיה תבנית ברירת המחדל של Slides, שתואמת לברירת המחדל בכלי העריכה של Slides.

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

PageBackgroundFill

מילוי הרקע של הדף.

ייצוג ב-JSON
{
  "propertyState": enum (PropertyState),

  // Union field kind can be only one of the following:
  "solidFill": {
    object (SolidFill)
  },
  "stretchedPictureFill": {
    object (StretchedPictureFill)
  }
  // End of list of possible types for union field kind.
}
שדות
propertyState

enum (PropertyState)

מצב המאפיין של מילוי הרקע.

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

שדה האיחוד kind. סוג מילוי הרקע. הערך של kind יכול להיות רק אחת מהאפשרויות הבאות:
solidFill

object (SolidFill)

מילוי בצבע אחיד.

stretchedPictureFill

object (StretchedPictureFill)

תמונה מורחבת.

StretchedPictureFill

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

ייצוג ב-JSON
{
  "contentUrl": string,
  "size": {
    object (Size)
  }
}
שדות
contentUrl

string

קריאת התוכן:

כתובת URL של תמונה עם משך חיים שמוגדר כברירת מחדל ל-30 דקות. כתובת ה-URL הזו מתויגת עם החשבון של מבקש הגישה. כל מי שיש לו את כתובת ה-URL יכול לגשת לתמונה כאילו הוא מגיש הבקשה המקורי. יכול להיות שתאבדו את הגישה לתמונה אם הגדרות השיתוף של המצגת ישתנו.

כתיבת contentUrl:

התמונה אוחזר פעם אחת בזמן ההוספה, ועותק שלה נשמר לצורך הצגה במצגת. התמונות צריכות להיות בגודל של עד 50MB, לא יכולות לחרוג מ-25 מגה-פיקסל וחייבות להיות בפורמט PNG,‏ JPEG או GIF.

אורך כתובת ה-URL שצריך לספק הוא עד 2KB.

size

object (Size)

הגודל המקורי של מילוי התמונה. השדה הזה הוא לקריאה בלבד.

ColorScheme

לוח הצבעים של צבעים מוגדרים מראש לדף.

ייצוג ב-JSON
{
  "colors": [
    {
      object (ThemeColorPair)
    }
  ]
}
שדות
colors[]

object (ThemeColorPair)

ThemeColorType וזוגות הצבעים הספציפיים התואמים.

ThemeColorPair

זוג שממפה סוג של צבע עיצוב לצבע הספציפי שהוא מייצג.

ייצוג ב-JSON
{
  "type": enum (ThemeColorType),
  "color": {
    object (RgbColor)
  }
}
שדות
type

enum (ThemeColorType)

הסוג של צבע העיצוב.

color

object (RgbColor)

צבע הבטון שתואם לסוג צבע העיצוב שלמעלה.

Methods

get

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

getThumbnail

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