REST Resource: presentations.pages

משאב: דף

דף במצגת.

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

  "slideProperties": {
    object (SlideProperties)
  },
  "layoutProperties": {
    object (LayoutProperties)
  },
  "notesProperties": {
    object (NotesProperties)
  },
  "masterProperties": {
    object (MasterProperties)
  }
}
שדות
objectId

string

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

pageType

enum (PageType)

סוג הדף.

pageElements[]

object (PageElement)

רכיבי הדף שמעובדים בדף.

revisionId

string

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

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

pageProperties

object (PageProperties)

מאפייני הדף.

commentAnchors[]

object (CommentAnchor)

פלט בלבד. עוגני התגובות שמופיעים בדף.

comments[]

object (CommentThread)

פלט בלבד. שרשורי התגובות שמשויכים לדף. העמודה הזו מאוכלסת רק אם הדף אוחזר באמצעות GetPageRequest עם commentsViewMode מאוכלס. אחרת, התגובות מוחזרות ב-Presentation דרך GetPresentationRequest.

commentsViewMode

enum (CommentsViewMode)

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

מאפיינים שספציפיים לכל סוג דף. לא נדרשים מאפיינים נוספים לשימוש ב-Masters. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות:
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,

  "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)
  }
}
שדות
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.

סוג הרכיב שמיוצג על ידי PageElement. כל הודעה מכילה מאפיינים שספציפיים לסוג הזה של רכיב הדף. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות:
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 סוג שמייצג אוסף משולב של PageElement.

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

object (PageElement)

אוסף הרכיבים בקבוצה. הגודל המינימלי של קבוצה הוא 2.

WordArt

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

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

string

הטקסט מוצג כאובייקט טקסט מעוצב.

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 הסוגים הראשונים של ThemeColorType לצבעים הקונקרטיים שלהם. המערכת תתעלם מצבעים של ThemeColorTypes שנותרו.

PageBackgroundFill

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

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

  "solidFill": {
    object (SolidFill)
  },
  "stretchedPictureFill": {
    object (StretchedPictureFill)
  }
}
שדות
propertyState

enum (PropertyState)

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

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

סוג מילוי הרקע. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות:
solidFill

object (SolidFill)

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

stretchedPictureFill

object (StretchedPictureFill)

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

סוף השדות הבלעדיים.

StretchedPictureFill

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

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

string

קריאת הערך contentUrl:

כתובת 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)

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

CommentAnchor

מכיל רשימה של כל המיקומים ב-Page שמקובעים ל-CommentThread באמצעות אותו anchorId. יכול להיות שמספר עוגנים נפרדים יפנו לאותו מיקום, בתוך Page או בדפים שונים,

ייצוג ב-JSON
{
  "anchorId": string,
  "objectAnchors": [
    {
      object (ObjectAnchor)
    }
  ]
}
שדות
anchorId

string

פלט בלבד. המזהה הייחודי של העוגן של התגובה.

objectAnchors[]

object (ObjectAnchor)

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

ObjectAnchor

מייצג נתוני עוגן של תגובה שקשורים לאובייקט ב-Slides, למשל Page או PageElement.

ייצוג ב-JSON
{
  "objectId": string,

  "shapeTextAnchors": {
    object (ShapeTextAnchors)
  },
  "tableCellAnchors": {
    object (TableCellAnchors)
  }
}
שדות
objectId

string

פלט בלבד. הדף או הרכיב בדף שהשרשור של התגובה מוצמד אליו.

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

object (ShapeTextAnchors)

מאוכלס עבור Shapes שיש להם תגובות שמעוגנות לטווחים של טקסט בצורה [text][google.apps.slides.v1.Shape.TextContent].

tableCellAnchors

object (TableCellAnchors)

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

סוף השדות הבלעדיים.

ShapeTextAnchors

מייצג טווחי טקסט בתוך צורה שמכוסה על ידי עוגן של תגובה.

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

object (TextRange)

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

TextRange

מציינת טווח רציף של טקסט בתוך צורה או תא בטבלה text.

ייצוג ב-JSON
{
  "startIndex": integer,
  "endIndex": integer
}
שדות
startIndex

integer

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

endIndex

integer

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

TableCellAnchors

מייצג טווחי תאים בטבלה שמוצמדים להם עוגנים של תגובות.

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

object (TableCellTextRanges)

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

TableCellTextRanges

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

ייצוג ב-JSON
{
  "cellLocation": {
    object (TableCellLocation)
  },
  "ranges": [
    {
      object (TextRange)
    }
  ]
}
שדות
cellLocation

object (TableCellLocation)

המיקום של התא בטבלה.

ranges[]

object (TextRange)

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

Methods

get

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

getThumbnail

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