Requests

בקשה

סוג עדכון יחיד להחלה על מצגת.

ייצוג ב-JSON 
{

  // Union field kind can be only one of the following:
  "createSlide": {
    object (CreateSlideRequest)
  },
  "createShape": {
    object (CreateShapeRequest)
  },
  "createTable": {
    object (CreateTableRequest)
  },
  "insertText": {
    object (InsertTextRequest)
  },
  "insertTableRows": {
    object (InsertTableRowsRequest)
  },
  "insertTableColumns": {
    object (InsertTableColumnsRequest)
  },
  "deleteTableRow": {
    object (DeleteTableRowRequest)
  },
  "deleteTableColumn": {
    object (DeleteTableColumnRequest)
  },
  "replaceAllText": {
    object (ReplaceAllTextRequest)
  },
  "deleteObject": {
    object (DeleteObjectRequest)
  },
  "updatePageElementTransform": {
    object (UpdatePageElementTransformRequest)
  },
  "updateSlidesPosition": {
    object (UpdateSlidesPositionRequest)
  },
  "deleteText": {
    object (DeleteTextRequest)
  },
  "createImage": {
    object (CreateImageRequest)
  },
  "createVideo": {
    object (CreateVideoRequest)
  },
  "createSheetsChart": {
    object (CreateSheetsChartRequest)
  },
  "createLine": {
    object (CreateLineRequest)
  },
  "refreshSheetsChart": {
    object (RefreshSheetsChartRequest)
  },
  "updateShapeProperties": {
    object (UpdateShapePropertiesRequest)
  },
  "updateImageProperties": {
    object (UpdateImagePropertiesRequest)
  },
  "updateVideoProperties": {
    object (UpdateVideoPropertiesRequest)
  },
  "updatePageProperties": {
    object (UpdatePagePropertiesRequest)
  },
  "updateTableCellProperties": {
    object (UpdateTableCellPropertiesRequest)
  },
  "updateLineProperties": {
    object (UpdateLinePropertiesRequest)
  },
  "createParagraphBullets": {
    object (CreateParagraphBulletsRequest)
  },
  "replaceAllShapesWithImage": {
    object (ReplaceAllShapesWithImageRequest)
  },
  "duplicateObject": {
    object (DuplicateObjectRequest)
  },
  "updateTextStyle": {
    object (UpdateTextStyleRequest)
  },
  "replaceAllShapesWithSheetsChart": {
    object (ReplaceAllShapesWithSheetsChartRequest)
  },
  "deleteParagraphBullets": {
    object (DeleteParagraphBulletsRequest)
  },
  "updateParagraphStyle": {
    object (UpdateParagraphStyleRequest)
  },
  "updateTableBorderProperties": {
    object (UpdateTableBorderPropertiesRequest)
  },
  "updateTableColumnProperties": {
    object (UpdateTableColumnPropertiesRequest)
  },
  "updateTableRowProperties": {
    object (UpdateTableRowPropertiesRequest)
  },
  "mergeTableCells": {
    object (MergeTableCellsRequest)
  },
  "unmergeTableCells": {
    object (UnmergeTableCellsRequest)
  },
  "groupObjects": {
    object (GroupObjectsRequest)
  },
  "ungroupObjects": {
    object (UngroupObjectsRequest)
  },
  "updatePageElementAltText": {
    object (UpdatePageElementAltTextRequest)
  },
  "replaceImage": {
    object (ReplaceImageRequest)
  },
  "updateSlideProperties": {
    object (UpdateSlidePropertiesRequest)
  },
  "updatePageElementsZOrder": {
    object (UpdatePageElementsZOrderRequest)
  },
  "updateLineCategory": {
    object (UpdateLineCategoryRequest)
  },
  "rerouteLine": {
    object (RerouteLineRequest)
  }
  // End of list of possible types for union field kind.
}
שדות
שדה איחוד kind. סוג העדכון. צריך למפות שדה אחד בדיוק. ‫kind יכול להיות רק אחד מהבאים:
createSlide

object (CreateSlideRequest)

יצירת שקף חדש.

createShape

object (CreateShapeRequest)

יצירת צורה חדשה.

createTable

object (CreateTableRequest)

יצירת טבלה חדשה.

insertText

object (InsertTextRequest)

הוספת טקסט לצורה או לתא בטבלה.

insertTableRows

object (InsertTableRowsRequest)

הוספת שורות לטבלה.

insertTableColumns

object (InsertTableColumnsRequest)

הוספת עמודות לטבלה.

deleteTableRow

object (DeleteTableRowRequest)

מחיקת שורה מטבלה.

deleteTableColumn

object (DeleteTableColumnRequest)

מחיקת עמודה מטבלה.

replaceAllText

object (ReplaceAllTextRequest)

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

deleteObject

object (DeleteObjectRequest)

מחיקת דף או רכיב בדף מהמצגת.

updatePageElementTransform

object (UpdatePageElementTransformRequest)

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

updateSlidesPosition

object (UpdateSlidesPositionRequest)

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

deleteText

object (DeleteTextRequest)

מחיקת טקסט מצורה או מתא בטבלה.

createImage

object (CreateImageRequest)

יוצר תמונה.

createVideo

object (CreateVideoRequest)

יוצר סרטון.

createSheetsChart

object (CreateSheetsChartRequest)

יוצרת תרשים מוטמע של Google Sheets.

createLine

object (CreateLineRequest)

יוצר קו.

refreshSheetsChart

object (RefreshSheetsChartRequest)

רענון של תרשים ב-Google Sheets.

updateShapeProperties

object (UpdateShapePropertiesRequest)

מעדכן את המאפיינים של Shape.

updateImageProperties

object (UpdateImagePropertiesRequest)

מעדכן את המאפיינים של Image.

updateVideoProperties

object (UpdateVideoPropertiesRequest)

מעדכן את המאפיינים של Video.

updatePageProperties

object (UpdatePagePropertiesRequest)

מעדכן את המאפיינים של Page.

updateTableCellProperties

object (UpdateTableCellPropertiesRequest)

מעדכן את המאפיינים של TableCell.

updateLineProperties

object (UpdateLinePropertiesRequest)

מעדכן את המאפיינים של Line.

createParagraphBullets

object (CreateParagraphBulletsRequest)

יוצרת תבליטים לפסקאות.

replaceAllShapesWithImage

object (ReplaceAllShapesWithImageRequest)

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

duplicateObject

object (DuplicateObjectRequest)

משכפל רכיב בשקף או בדף.

updateTextStyle

object (UpdateTextStyleRequest)

מעדכן את הסגנון של הטקסט בתוך Shape או Table.

replaceAllShapesWithSheetsChart

object (ReplaceAllShapesWithSheetsChartRequest)

החלפת כל הצורות שתואמות לקריטריונים מסוימים בתרשים של Google Sheets.

deleteParagraphBullets

object (DeleteParagraphBulletsRequest)

מוחק תבליטים מפסקה.

updateParagraphStyle

object (UpdateParagraphStyleRequest)

עדכון הסגנון של פסקאות בתוך Shape או Table.

updateTableBorderProperties

object (UpdateTableBorderPropertiesRequest)

מעדכן את המאפיינים של גבולות הטבלה ב-Table.

updateTableColumnProperties

object (UpdateTableColumnPropertiesRequest)

מעדכן את המאפיינים של עמודה Table.

updateTableRowProperties

object (UpdateTableRowPropertiesRequest)

מעדכן את המאפיינים של שורה Table.

mergeTableCells

object (MergeTableCellsRequest)

הפונקציה ממזגת תאים ב-Table.

unmergeTableCells

object (UnmergeTableCellsRequest)

ביטול המיזוג של תאים ב-Table.

groupObjects

object (GroupObjectsRequest)

קיבוץ אובייקטים, כמו רכיבים בדף.

ungroupObjects

object (UngroupObjectsRequest)

מבטל את הקיבוץ של אובייקטים, כמו groups.

updatePageElementAltText

object (UpdatePageElementAltTextRequest)

מעדכן את הכותרת ו/או את התיאור של הטקסט החלופי של תמונה מסוג page element.

replaceImage

object (ReplaceImageRequest)

מחליפה תמונה קיימת בתמונה חדשה.

updateSlideProperties

object (UpdateSlidePropertiesRequest)

עדכון המאפיינים של שקף

updatePageElementsZOrder

object (UpdatePageElementsZOrderRequest)

מעדכן את סדר ה-Z של page elements.

updateLineCategory

object (UpdateLineCategoryRequest)

מעדכן את הקטגוריה של line.

rerouteLine

object (RerouteLineRequest)

מנתב מחדש את line כך שהוא מחובר לשני אתרי החיבור הקרובים ביותר ברכיבי הדף המחוברים.

CreateSlideRequest

יוצר שקף.

ייצוג ב-JSON 
{
  "objectId": string,
  "insertionIndex": integer,
  "slideLayoutReference": {
    object (LayoutReference)
  },
  "placeholderIdMappings": [
    {
      object (LayoutPlaceholderIdMapping)
    }
  ]
}
שדות
objectId

string

מזהה אובייקט שהמשתמש סיפק.

אם מציינים מזהה, הוא צריך להיות ייחודי בכל הדפים ורכיבי הדפים במצגת. המזהה חייב להתחיל בתו אלפאנומרי או בקו תחתון (מתאים לביטוי הרגולרי [a-zA-Z0-9_]). התווים הנותרים יכולים לכלול את התווים האלה, וגם מקף או נקודתיים (מתאים לביטוי הרגולרי [a-zA-Z0-9_-:]). אורך המזהה צריך להיות בין 5 ל-50 תווים, כולל.

אם לא מציינים מזהה, נוצר מזהה ייחודי.

insertionIndex

integer

אינדקס אופציונלי מבוסס-אפס שמציין איפה להוסיף את השקפים.

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

slideLayoutReference

object (LayoutReference)

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

  • המאסטר של אינדקס השקף הקודם.
  • השקף הראשי של השקף הראשון, אם insertionIndex הוא אפס.
  • התבנית הראשית הראשונה במצגת, אם אין שקפים.

אם לא נמצא LayoutReference בפריסת האב הנוכחית, מוחזרת שגיאת בקשה שגויה (400).

אם לא מציינים הפניה לפריסה, השקף משתמש בפריסה המוגדרת מראש BLANK.

placeholderIdMappings[]

object (LayoutPlaceholderIdMapping)

רשימה אופציונלית של מיפויי מזהי אובייקטים מתוך placeholder (s) בפריסה אל הפלייסהולדרים שנוצרו בשקף מהפריסה שצוינה. אפשר להשתמש בו רק כשמציינים את slideLayoutReference.

LayoutReference

טבלת הסבר לפריסת שקפים. הוא יכול להתייחס לאחד מהדברים הבאים:

  • פריסה מוגדרת מראש
  • אחת מהפריסות במצגת.
ייצוג ב-JSON 
{

  // Union field kind can be only one of the following:
  "predefinedLayout": enum (PredefinedLayout),
  "layoutId": string
  // End of list of possible types for union field kind.
}
שדות
שדה איחוד kind. סוג ההפניה לפריסה. ‫kind יכול להיות רק אחד מהבאים:
predefinedLayout

enum (PredefinedLayout)

פריסה מוגדרת מראש.

layoutId

string

מזהה הפריסה: מזהה האובייקט של אחת מהפריסות במצגת.

PredefinedLayout

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

טיפוסים בני מנייה (enum)
PREDEFINED_LAYOUT_UNSPECIFIED פריסה לא מוגדרת.
BLANK פריסה ריקה, ללא ערכי פלייסהולדר.
CAPTION_ONLY פריסה עם כתובית בתחתית.
TITLE פריסה עם כותרת וכותרת משנה.
TITLE_AND_BODY פריסה עם כותרת וגוף.
TITLE_AND_TWO_COLUMNS פריסה עם כותרת ושתי עמודות.
TITLE_ONLY פריסה עם כותרת בלבד.
SECTION_HEADER פריסה עם שם של קטע.
SECTION_TITLE_AND_DESCRIPTION פריסה עם כותרת וכותרת משנה בצד אחד ותיאור בצד השני.
ONE_COLUMN_TEXT פריסה עם כותרת אחת וגוף אחד, מסודרים בעמודה אחת.
MAIN_POINT פריסה עם נקודה מרכזית.
BIG_NUMBER פריסה עם כותרת מספר גדולה.

LayoutPlaceholderIdMapping

מיפוי המזהים שצוין על ידי המשתמש עבור פלייסהולדר [מציין מיקום] שייווצר בשקף מפריסה שצוינה.

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

  // Union field kind can be only one of the following:
  "layoutPlaceholder": {
    object (Placeholder)
  },
  "layoutPlaceholderObjectId": string
  // End of list of possible types for union field kind.
}
שדות
objectId

string

מזהה אובייקט שסופק על ידי המשתמש עבור ה-placeholder שצוין למעלה, שאותו רוצים ליצור בשקף.

אם מציינים מזהה, הוא צריך להיות ייחודי בכל הדפים ורכיבי הדפים במצגת. המזהה חייב להתחיל בתו אלפאנומרי או בקו תחתון (מתאים לביטוי הרגולרי [a-zA-Z0-9_]). התווים הנותרים יכולים לכלול את התווים האלה, וגם מקף או נקודתיים (מתאים לביטוי הרגולרי [a-zA-Z0-9_-:]). אורך המזהה צריך להיות בין 5 ל-50 תווים.

אם לא מציינים מזהה, נוצר מזהה ייחודי.

שדה איחוד kind. סוג לזיהוי פלייסהולדר בפריסה. ‫kind יכול להיות רק אחד מהבאים:
layoutPlaceholder

object (Placeholder)

הפלייסולדר בפריסה שיחול על השקף. צריך להשתמש רק ב-type וב-index. לדוגמה, בפריסה מוגדרת מראש יכול להיות שיש placeholder של שם הפריט עם אינדקס 0 ו-placeholder של גוף הטקסט עם אינדקס 0.TITLE_AND_BODY

layoutPlaceholderObjectId

string

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

CreateShapeRequest

יצירת צורה חדשה.

ייצוג ב-JSON 
{
  "objectId": string,
  "elementProperties": {
    object (PageElementProperties)
  },
  "shapeType": enum (Type)
}
שדות
objectId

string

מזהה אובייקט שהמשתמש סיפק.

אם מציינים מזהה, הוא צריך להיות ייחודי בכל הדפים ורכיבי הדפים במצגת. המזהה חייב להתחיל בתו אלפאנומרי או בקו תחתון (מתאים לביטוי הרגולרי [a-zA-Z0-9_]). התווים הנותרים יכולים לכלול את התווים האלה, וגם מקף או נקודתיים (מתאים לביטוי הרגולרי [a-zA-Z0-9_-:]). אורך המזהה צריך להיות בין 5 ל-50 תווים. אם השדה ריק, המערכת תיצור מזהה ייחודי.

elementProperties

object (PageElementProperties)

מאפייני הרכיב של הצורה.

shapeType

enum (Type)

סוג הצורה.

PageElementProperties

מאפיינים נפוצים של רכיב בדף.

הערה: כשיוצרים לראשונה PageElement, יכול להיות שממשק ה-API ישנה את הערכים של size ושל transform, אבל הגודל החזותי לא ישתנה.

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

string

מזהה האובייקט של הדף שבו נמצא הרכיב.

size

object (Size)

גודל הרכיב.

transform

object (AffineTransform)

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

CreateTableRequest

יצירת טבלה חדשה.

ייצוג ב-JSON 
{
  "objectId": string,
  "elementProperties": {
    object (PageElementProperties)
  },
  "rows": integer,
  "columns": integer
}
שדות
objectId

string

מזהה אובייקט שהמשתמש סיפק.

אם מציינים מזהה, הוא צריך להיות ייחודי בכל הדפים ורכיבי הדפים במצגת. המזהה חייב להתחיל בתו אלפאנומרי או בקו תחתון (מתאים לביטוי הרגולרי [a-zA-Z0-9_]). התווים הנותרים יכולים לכלול את התווים האלה, וגם מקף או נקודתיים (מתאים לביטוי הרגולרי [a-zA-Z0-9_-:]). אורך המזהה צריך להיות בין 5 ל-50 תווים.

אם לא מציינים מזהה, נוצר מזהה ייחודי.

elementProperties

object (PageElementProperties)

מאפייני הרכיב של הטבלה.

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

ההגדרה scale של טרנספורמציות של טבלאות חייבת להיות 1, ואסור שיהיו רכיבי הטיה. אם לא מציינים טרנספורמציה, הטבלה תהיה ממורכזת בדף.

rows

integer

מספר השורות בטבלה.

columns

integer

מספר העמודות בטבלה.

InsertTextRequest

הוספת טקסט לצורה או לתא בטבלה.

ייצוג ב-JSON 
{
  "objectId": string,
  "cellLocation": {
    object (TableCellLocation)
  },
  "text": string,
  "insertionIndex": integer
}
שדות
objectId

string

מזהה האובייקט של הצורה או הטבלה שבהן הטקסט יוכנס.

cellLocation

object (TableCellLocation)

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

text

string

הטקסט שיוכנס.

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

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

חלק מתווי הבקרה (U+0000-U+0008, U+000C-U+001F) ותווים מאזור השימוש הפרטי של Unicode Basic Multilingual Plane (U+E000-U+F8FF) יוסרו מהטקסט שמוסיפים.

insertionIndex

integer

האינדקס שבו הטקסט יוכנס, ביחידות קוד Unicode, על סמך TextElement אינדקסים.

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

InsertTableRowsRequest

הוספת שורות לטבלה.

ייצוג ב-JSON 
{
  "tableObjectId": string,
  "cellLocation": {
    object (TableCellLocation)
  },
  "insertBelow": boolean,
  "number": integer
}
שדות
tableObjectId

string

הטבלה שאליה רוצים להוסיף שורות.

cellLocation

object (TableCellLocation)

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

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

insertBelow

boolean

האם להוסיף שורות חדשות מתחת למיקום תא ההפניה.

  • True ‫: insert below the cell.
  • False ‫: insert above the cell.
number

integer

מספר השורות שיוכנסו. עד 20 לכל בקשה.

InsertTableColumnsRequest

הוספת עמודות לטבלה.

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

ייצוג ב-JSON 
{
  "tableObjectId": string,
  "cellLocation": {
    object (TableCellLocation)
  },
  "insertRight": boolean,
  "number": integer
}
שדות
tableObjectId

string

הטבלה שאליה רוצים להוסיף עמודות.

cellLocation

object (TableCellLocation)

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

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

insertRight

boolean

האם להוסיף עמודות חדשות מימין למיקום של תא ההפניה.

  • True ‫: insert to the right.
  • False : insert to the left.
number

integer

מספר העמודות שרוצים להוסיף. עד 20 לכל בקשה.

DeleteTableRowRequest

מחיקת שורה מטבלה.

ייצוג ב-JSON 
{
  "tableObjectId": string,
  "cellLocation": {
    object (TableCellLocation)
  }
}
שדות
tableObjectId

string

הטבלה שממנה רוצים למחוק שורות.

cellLocation

object (TableCellLocation)

המיקום של התא בטבלת ההפניה שממנו תימחק שורה.

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

DeleteTableColumnRequest

מחיקת עמודה מטבלה.

ייצוג ב-JSON 
{
  "tableObjectId": string,
  "cellLocation": {
    object (TableCellLocation)
  }
}
שדות
tableObjectId

string

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

cellLocation

object (TableCellLocation)

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

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

ReplaceAllTextRequest

הפונקציה מחליפה את כל המופעים של טקסט שתואמים לקריטריון מסוים ב-replace text.

ייצוג ב-JSON 
{
  "replaceText": string,
  "pageObjectIds": [
    string
  ],

  // Union field criteria can be only one of the following:
  "containsText": {
    object (SubstringMatchCriteria)
  }
  // End of list of possible types for union field criteria.
}
שדות
replaceText

string

הטקסט שיחליף את הטקסט התואם.

pageObjectIds[]

string

אם הוא לא ריק, הוא מגביל את ההתאמות לרכיבי דף רק בדפים הנתונים.

הפונקציה מחזירה שגיאת בקשה שגויה (400) אם ניתן לה מזהה אובייקט של דף notes master, או אם לא קיים דף עם מזהה האובייקט הזה במצגת.

שדה איחוד criteria. הקריטריונים שמשמשים להתאמת הטקסט להחלפה. ‫criteria יכול להיות רק אחד מהבאים:
containsText

object (SubstringMatchCriteria)

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

SubstringMatchCriteria

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

ייצוג ב-JSON 
{
  "text": string,
  "matchCase": boolean,
  "searchByRegex": boolean
}
שדות
text

string

הטקסט לחיפוש בצורה או בטבלה.

matchCase

boolean

מציין אם החיפוש צריך להתחשב באותיות רישיות:

  • True ‫: החיפוש תלוי באותיות רישיות.
  • False ‫: החיפוש לא תלוי באותיות רישיות.
searchByRegex

boolean

אופציונלי. ‫True אם צריך להתייחס לערך החיפוש כאל ביטוי רגולרי. צריך להוסיף תו בריחה לכל קו נטוי הפוך בתבנית.

  • True : הטקסט לחיפוש מטופל כביטוי רגולרי.
  • False ‫: הטקסט לחיפוש נחשב למחרוזת משנה לצורך התאמה.

DeleteObjectRequest

מוחק אובייקט, pages או page elements, מהמצגת.

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

string

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

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

אם מוחקים פלייס הולדר בפריסה, נמחקים גם פלייס הולדרים ריקים שמועברים בירושה.

UpdatePageElementTransformRequest

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

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

ייצוג ב-JSON 
{
  "objectId": string,
  "transform": {
    object (AffineTransform)
  },
  "applyMode": enum (ApplyMode)
}
שדות
objectId

string

מזהה האובייקט של רכיב הדף שרוצים לעדכן.

transform

object (AffineTransform)

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

applyMode

enum (ApplyMode)

מצב ההחלה של עדכון השינוי.

ApplyMode

מצבי ההחלה של עדכון הטרנספורמציה.

טיפוסים בני מנייה (enum)
APPLY_MODE_UNSPECIFIED מצב לא מוגדר.
RELATIVE מחילה את מטריצת ה-AffineTransform החדשה על המטריצה הקיימת, ומחליפה את המטריצה הקיימת בתוצאה של השרשור.
ABSOLUTE הפונקציה מחליפה את מטריצת AffineTransform הקיימת במטריצה החדשה.

UpdateSlidesPositionRequest

עדכון המיקום של השקפים במצגת.

ייצוג ב-JSON 
{
  "slideObjectIds": [
    string
  ],
  "insertionIndex": integer
}
שדות
slideObjectIds[]

string

המזהים של השקפים במצגת שצריך להעביר. השקפים ברשימה הזו צריכים להיות בסדר שבו הם מופיעים במצגת, בלי כפילויות.

insertionIndex

integer

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

DeleteTextRequest

מחיקת טקסט מצורה או מתא בטבלה.

ייצוג ב-JSON 
{
  "objectId": string,
  "cellLocation": {
    object (TableCellLocation)
  },
  "textRange": {
    object (Range)
  }
}
שדות
objectId

string

מזהה האובייקט של הצורה או הטבלה שממנה יימחק הטקסט.

cellLocation

object (TableCellLocation)

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

textRange

object (Range)

טווח הטקסט למחיקה, על סמך TextElement אינדקסים.

תמיד יש תו מעבר שורה מרומז בסוף הטקסט של צורה או של תא בטבלה, ואי אפשר למחוק אותו. Range.Type.ALL ישתמש בגבולות הנכונים, אבל צריך להיזהר כשמציינים גבולות מפורשים לסוגי טווחים FROM_START_INDEX ו- FIXED_RANGE. לדוגמה, אם הטקסט הוא 'ABC', ואחריו ירידת שורה מרומזת, אז הערך המקסימלי הוא 2 עבור textRange.start_index ו-3 עבור textRange.end_index.

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

טווחים שכוללים רק יחידת קוד אחת של זוג תחליפים מורחבים כך שיכללו את שתי יחידות הקוד.

טווח

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

ייצוג ב-JSON 
{
  "startIndex": integer,
  "endIndex": integer,
  "type": enum (Type)
}
שדות
startIndex

integer

אינדקס אופציונלי שמתחיל מאפס של תחילת האוסף. חובה לטווחים FIXED_RANGE ו-FROM_START_INDEX.

endIndex

integer

האינדקס האופציונלי מבוסס-אפס של סוף האוסף. נדרש עבור FIXED_RANGE טווחים.

type

enum (Type)

סוג הטווח.

סוג

סוגי הטווחים.

טיפוסים בני מנייה (enum)
RANGE_TYPE_UNSPECIFIED סוג הטווח לא צוין. אסור להשתמש בערך הזה.
FIXED_RANGE טווח קבוע. חובה לציין גם את startIndex וגם את endIndex.
FROM_START_INDEX הטווח מתחיל ב-startIndex וממשיך עד סוף האוסף. אין לציין את הערך endIndex.
ALL ההגדרה הזו קובעת שהטווח יהיה כל האורך של האוסף. אסור לציין את המאפיינים startIndex ו-endIndex.

CreateImageRequest

יוצר תמונה.

ייצוג ב-JSON 
{
  "objectId": string,
  "elementProperties": {
    object (PageElementProperties)
  },

  // Union field image_source can be only one of the following:
  "url": string
  // End of list of possible types for union field image_source.
}
שדות
objectId

string

מזהה אובייקט שהמשתמש סיפק.

אם מציינים מזהה, הוא צריך להיות ייחודי בכל הדפים ורכיבי הדפים במצגת. המזהה חייב להתחיל בתו אלפאנומרי או בקו תחתון (מתאים לביטוי הרגולרי [a-zA-Z0-9_]). התווים הנותרים יכולים לכלול את התווים האלה, וגם מקף או נקודתיים (מתאים לביטוי הרגולרי [a-zA-Z0-9_-:]). אורך המזהה צריך להיות בין 5 ל-50 תווים.

אם לא מציינים מזהה, נוצר מזהה ייחודי.

elementProperties

object (PageElementProperties)

מאפייני הרכיב של התמונה.

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

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

המאפיין PageElementProperties.transform הוא אופציונלי. אם לא מציינים טרנספורמציה, התמונה תמוקם בפינה השמאלית העליונה של הדף.

שדה איחוד image_source. סוג מקור התמונה. ‫image_source יכול להיות רק אחד מהבאים:
url

string

כתובת ה-URL של התמונה.

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

כתובת ה-URL שסיפקתם צריכה להיות נגישה לכולם, והאורך שלה לא יכול להיות יותר מ-2KB. כתובת ה-URL נשמרת עם התמונה ומוצגת בשדה Image.source_url.

CreateVideoRequest

יוצר סרטון.

הערה: כדי ליצור סרטון מ-Google Drive, לאפליקציה ששולחת את הבקשה צריכות להיות לפחות אחת מההרשאות הבאות של OAuth: drive, ‏ drive.readonly או drive.file.

ייצוג ב-JSON 
{
  "objectId": string,
  "elementProperties": {
    object (PageElementProperties)
  },
  "source": enum (Source),
  "id": string
}
שדות
objectId

string

מזהה אובייקט שהמשתמש סיפק.

אם מציינים מזהה, הוא צריך להיות ייחודי בכל הדפים ורכיבי הדפים במצגת. המזהה חייב להתחיל בתו אלפאנומרי או בקו תחתון (מתאים לביטוי הרגולרי [a-zA-Z0-9_]). התווים הנותרים יכולים לכלול את התווים האלה, וגם מקף או נקודתיים (מתאים לביטוי הרגולרי [a-zA-Z0-9_-:]). אורך המזהה צריך להיות בין 5 ל-50 תווים.

אם לא מציינים מזהה, נוצר מזהה ייחודי.

elementProperties

object (PageElementProperties)

מאפייני הרכיב של הסרטון.

המאפיין PageElementProperties.size הוא אופציונלי. אם לא מציינים גודל, השרת בוחר גודל ברירת מחדל.

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

source

enum (Source)

מקור הסרטון.

id

string

המזהה הייחודי של מקור הסרטון.

לדוגמה, בסרטון YouTube‏ https://www.youtube.com/watch?v=7U3axjORYZ0, המזהה הוא 7U3axjORYZ0. לדוגמה, אם כתובת ה-URL של סרטון ב-Google Drive היא https://drive.google.com/file/d/1xCgQLFTJi5_Xl8DgW_lcUYq5e-q6Hi5Q המזהה הוא 1xCgQLFTJi5_Xl8DgW_lcUYq5e-q6Hi5Q.

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

CreateSheetsChartRequest

יוצרת תרשים מוטמע של Google Sheets.

הערה: כדי ליצור תרשים, צריך להגדיר לפחות אחד מההיקפים הבאים של OAuth: spreadsheets.readonly, ‏ spreadsheets, ‏ drive.readonly, ‏ drive.file או drive.

ייצוג ב-JSON 
{
  "objectId": string,
  "elementProperties": {
    object (PageElementProperties)
  },
  "spreadsheetId": string,
  "chartId": integer,
  "linkingMode": enum (LinkingMode)
}
שדות
objectId

string

מזהה אובייקט שהמשתמש סיפק.

אם מציינים מזהה, הוא צריך להיות ייחודי בכל הדפים ורכיבי הדפים במצגת. המזהה צריך להתחיל בתו של מילה [a-zA-Z0-9_] ואחריו כל אחד מהתווים הבאים [a-zA-Z0-9_-:], בכל כמות שהיא. האורך של המזהה צריך להיות בין 5 ל-50 תווים. אם השדה ריק, המערכת תיצור מזהה ייחודי.

elementProperties

object (PageElementProperties)

מאפייני הרכיב של התרשים.

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

spreadsheetId

string

המזהה של הגיליון האלקטרוני ב-Google Sheets שמכיל את התרשים.

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

chartId

integer

המזהה של התרשים הספציפי בגיליון האלקטרוני של Google Sheets.

linkingMode

enum (LinkingMode)

המצב שבו התרשים מקושר לגיליון האלקטרוני של המקור. אם לא מציינים, התרשים יהיה תמונה שלא מקושרת.

LinkingMode

המצב שבו התרשים מקושר לגיליון האלקטרוני של המקור.

טיפוסים בני מנייה (enum)
NOT_LINKED_IMAGE התרשים לא משויך לגיליון האלקטרוני של המקור, ואי אפשר לעדכן אותו. תרשים שלא מקושר יתווסף כתמונה.
LINKED קישור התרשים מאפשר לעדכן אותו, ושאר שותפי העריכה יראו קישור לגיליון האלקטרוני.

CreateLineRequest

יוצר קו.

ייצוג ב-JSON 
{
  "objectId": string,
  "elementProperties": {
    object (PageElementProperties)
  },
  "lineCategory": enum (Category),
  "category": enum (LineCategory)
}
שדות
objectId

string

מזהה אובייקט שהמשתמש סיפק.

אם מציינים מזהה, הוא צריך להיות ייחודי בכל הדפים ורכיבי הדפים במצגת. המזהה חייב להתחיל בתו אלפאנומרי או בקו תחתון (מתאים לביטוי הרגולרי [a-zA-Z0-9_]). התווים הנותרים יכולים לכלול את התווים האלה, וגם מקף או נקודתיים (מתאים לביטוי הרגולרי [a-zA-Z0-9_-:]). אורך המזהה צריך להיות בין 5 ל-50 תווים.

אם לא מציינים מזהה, נוצר מזהה ייחודי.

elementProperties

object (PageElementProperties)

מאפייני הרכיב של הקו.

lineCategory
(deprecated)

enum (Category)

הקטגוריה של השורה שרוצים ליצור.

יצא משימוש : במקום זאת, צריך להשתמש ב-category.

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

אם מציינים גם category וגם lineCategory, category מקבל עדיפות.

category

enum (LineCategory)

הקטגוריה של השורה שרוצים ליצור.

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

אם מציינים גם category וגם lineCategory, category מקבל עדיפות.

אם לא תציינו ערך למאפיין category, אבל תציינו ערך למאפיין lineCategory, המערכת תשתמש בערך שציינתם למאפיין lineCategory.

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

קטגוריה

קטגוריות הקווים.

טיפוסים בני מנייה (enum)
STRAIGHT מחברים ישרים, כולל מחבר ישר 1. זוהי קטגוריית ברירת המחדל אם לא מציינים קטגוריה.
BENT מחברים כפופים, כולל מחברים כפופים 2 עד 5.
CURVED מחברים מעוקלים, כולל מחברים מעוקלים 2 עד 5.

RefreshSheetsChartRequest

מרעננים תרשים מוטמע של Google Sheets על ידי החלפתו בגרסה העדכנית ביותר של התרשים מ-Google Sheets.

הערה: כדי לרענן תרשימים, צריך לפחות אחד מההיקפים הבאים של OAuth: ‏spreadsheets.readonly, ‏ spreadsheets, ‏ drive.readonly או drive.

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

string

מזהה האובייקט של התרשים שרוצים לרענן.

UpdateShapePropertiesRequest

מעדכנים את המאפיינים של Shape.

ייצוג ב-JSON 
{
  "objectId": string,
  "shapeProperties": {
    object (ShapeProperties)
  },
  "fields": string
}
שדות
objectId

string

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

shapeProperties

object (ShapeProperties)

מאפייני הצורה לעדכון.

fields

string (FieldMask format)

השדות שצריך לעדכן.

צריך לציין לפחות שדה אחד. האלמנט root shapeProperties מרומז ואין לציין אותו. אפשר להשתמש בסימן "*" אחד כקיצור לרשימה של כל השדות.

לדוגמה, כדי לעדכן את צבע המילוי של הרקע של הצורה, מגדירים את fields לערך "shapeBackgroundFill.solidFill.color".

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

UpdateImagePropertiesRequest

מעדכנים את המאפיינים של Image.

ייצוג ב-JSON 
{
  "objectId": string,
  "imageProperties": {
    object (ImageProperties)
  },
  "fields": string
}
שדות
objectId

string

מזהה האובייקט של התמונה שעליה מוחלים העדכונים.

imageProperties

object (ImageProperties)

מאפייני התמונה לעדכון.

fields

string (FieldMask format)

השדות שצריך לעדכן.

צריך לציין לפחות שדה אחד. האלמנט root imageProperties מרומז ואין לציין אותו. אפשר להשתמש בסימן "*" אחד כקיצור לרשימה של כל השדות.

לדוגמה, כדי לעדכן את צבע המתאר של התמונה, מגדירים את fields לערך "outline.outlineFill.solidFill.color".

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

UpdateVideoPropertiesRequest

מעדכנים את המאפיינים של Video.

ייצוג ב-JSON 
{
  "objectId": string,
  "videoProperties": {
    object (VideoProperties)
  },
  "fields": string
}
שדות
objectId

string

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

videoProperties

object (VideoProperties)

מאפייני הסרטון לעדכון.

fields

string (FieldMask format)

השדות שצריך לעדכן.

צריך לציין לפחות שדה אחד. האלמנט root videoProperties מרומז ואין לציין אותו. אפשר להשתמש בסימן "*" אחד כקיצור לרשימה של כל השדות.

לדוגמה, כדי לעדכן את צבע המתאר של הסרטון, מגדירים את fields לערך "outline.outlineFill.solidFill.color".

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

UpdatePagePropertiesRequest

מעדכן את המאפיינים של Page.

ייצוג ב-JSON 
{
  "objectId": string,
  "pageProperties": {
    object (PageProperties)
  },
  "fields": string
}
שדות
objectId

string

מזהה האובייקט של הדף שעליו חל העדכון.

pageProperties

object (PageProperties)

מאפייני הדף לעדכון.

fields

string (FieldMask format)

השדות שצריך לעדכן.

צריך לציין לפחות שדה אחד. האלמנט root pageProperties מרומז ואין לציין אותו. אפשר להשתמש בסימן "*" אחד כקיצור לרשימה של כל השדות.

לדוגמה, כדי לעדכן את צבע המילוי של הרקע של הדף, מגדירים את fields לערך "pageBackgroundFill.solidFill.color".

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

UpdateTableCellPropertiesRequest

מעדכנים את המאפיינים של TableCell.

ייצוג ב-JSON 
{
  "objectId": string,
  "tableRange": {
    object (TableRange)
  },
  "tableCellProperties": {
    object (TableCellProperties)
  },
  "fields": string
}
שדות
objectId

string

מזהה האובייקט של הטבלה.

tableRange

object (TableRange)

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

tableCellProperties

object (TableCellProperties)

מאפייני התאים בטבלה שצריך לעדכן.

fields

string (FieldMask format)

השדות שצריך לעדכן.

צריך לציין לפחות שדה אחד. האלמנט root tableCellProperties מרומז ואין לציין אותו. אפשר להשתמש בסימן "*" אחד כקיצור לרשימה של כל השדות.

לדוגמה, כדי לעדכן את צבע המילוי של הרקע של תא בטבלה, מגדירים את fields לערך "tableCellBackgroundFill.solidFill.color".

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

TableRange

טווח טבלה מייצג הפניה לקבוצת משנה של טבלה.

חשוב לציין שהתאים שמוגדרים בטווח של טבלה לא בהכרח יוצרים מלבן. לדוגמה, נניח שיש לנו טבלה בגודל 3x3 שבה כל התאים בשורה האחרונה מוזגו. הטבלה נראית כך: 

 [   ][   ][   ]
 [   ][   ][   ]
 [             ]

טווח טבלה עם מיקום = (0, 0), טווח שורות = 3 וטווח עמודות = 2 מציין את התאים הבאים: 

 [ x ][ x ][   ]
 [ x ][ x ][   ]
 [ x    x    x ]
ייצוג ב-JSON 
{
  "location": {
    object (TableCellLocation)
  },
  "rowSpan": integer,
  "columnSpan": integer
}
שדות
location

object (TableCellLocation)

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

rowSpan

integer

מספר השורות בטווח הטבלה.

columnSpan

integer

מספר העמודות בטווח הטבלה.

UpdateLinePropertiesRequest

מעדכן את המאפיינים של Line.

ייצוג ב-JSON 
{
  "objectId": string,
  "lineProperties": {
    object (LineProperties)
  },
  "fields": string
}
שדות
objectId

string

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

lineProperties

object (LineProperties)

מאפייני הקו לעדכון.

fields

string (FieldMask format)

השדות שצריך לעדכן.

צריך לציין לפחות שדה אחד. האלמנט root lineProperties מרומז ואין לציין אותו. אפשר להשתמש בסימן "*" אחד כקיצור לרשימה של כל השדות.

לדוגמה, כדי לעדכן את צבע המילוי של הקו, מגדירים את fields לערך "lineFill.solidFill.color".

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

CreateParagraphBulletsRequest

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

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

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

ייצוג ב-JSON 
{
  "objectId": string,
  "cellLocation": {
    object (TableCellLocation)
  },
  "textRange": {
    object (Range)
  },
  "bulletPreset": enum (BulletGlyphPreset)
}
שדות
objectId

string

מזהה האובייקט של הצורה או הטבלה שמכילות את הטקסט שאליו רוצים להוסיף תבליטים.

cellLocation

object (TableCellLocation)

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

textRange

object (Range)

טווח הטקסט שאליו יוחלו הגדרות קבועות מראש של תבליטים, על סמך אינדקסים של TextElement.

bulletPreset

enum (BulletGlyphPreset)

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

BulletGlyphPreset

דפוסים מוגדרים מראש של גליפים של תבליטים לרשימות בטקסט.

בדוגמאות האלה אנחנו משתמשים בתבליטים מהסוגים הבאים:

  • ARROW : חץ, שמתאים לנקודת קוד Unicode U+2794
  • ARROW3D : חץ עם הצללה תלת-ממדית, שמתאים לנקודת קוד Unicode U+27a2
  • CHECKBOX : ריבוע חלול, שמתאים למיקום תו (code point) של Unicode ‏U+274f
  • CIRCLE : עיגול חלול, שמתאים למיקום תו (code point) של Unicode U+25cb
  • DIAMOND ‫: A solid diamond, corresponding to a Unicode U+25c6 code point
  • DIAMONDX : מעוין עם האות x, שמתאים למיקום תו (code point) של Unicode U+2756
  • HOLLOWDIAMOND : יהלום חלול, שמתאים למיקום תו (code point) של Unicode U+25c7
  • ‫DISC : עיגול מלא, שמתאים למיקום תו (code point) של Unicode‏ U+25cf
  • ‫SQUARE : ריבוע מלא, שמתאים למיקום תו (code point) של Unicode U+25a0
  • STAR ‫: כוכב, שמתאים לנקודת קוד Unicode U+2605
  • ALPHA : אות קטנה, כמו 'a',‏ 'b' או 'c'.
  • UPPERALPHA ‫: אות רישית, כמו A,‏ B או C.
  • DIGIT ‫: מספר, כמו '1',‏ '2' או '3'.
  • ZERODIGIT : מספר שבו מספרים עם ספרה אחת מתחילים באפס, כמו 01, 02 או 03. למספרים עם יותר מספרה אחת לא מוסיפים אפס בתחילת המספר.
  • ‫ROMAN : ספרה רומית באותיות קטנות, כמו i,‏ ii או iii.
  • ‫UPPERROMAN : ספרה רומית באותיות רישיות, כמו 'I',‏ 'II' או 'III'.
  • LEFTTRIANGLE : משולש שמצביע שמאלה, שמתאים לנקודת קוד Unicode U+25c4
טיפוסים בני מנייה (enum)
BULLET_DISC_CIRCLE_SQUARE רשימה עם תבליטים עם DISC, CIRCLE ו- SQUARE סמל תבליט ל-3 רמות הקינון הראשונות ברשימה.
BULLET_DIAMONDX_ARROW3D_SQUARE רשימה עם תבליטים עם DIAMONDX, ARROW3D ו- SQUARE סמל תבליט ל-3 רמות הקינון הראשונות ברשימה.
BULLET_CHECKBOX רשימת תבליטים עם CHECKBOX סמלי תבליטים לכל רמות ההזחה ברשימה.
BULLET_ARROW_DIAMOND_DISC רשימה עם תבליטים עם ARROW, DIAMOND ו- DISC סמל תבליט ל-3 רמות הקינון הראשונות ברשימה.
BULLET_STAR_CIRCLE_SQUARE רשימה עם תבליטים עם STAR, CIRCLE ו- SQUARE סמל תבליט ל-3 רמות הקינון הראשונות ברשימה.
BULLET_ARROW3D_CIRCLE_SQUARE רשימה עם תבליטים עם ARROW3D, CIRCLE ו- SQUARE סמל תבליט ל-3 רמות הקינון הראשונות ברשימה.
BULLET_LEFTTRIANGLE_DIAMOND_DISC רשימה עם תבליטים עם LEFTTRIANGLE, DIAMOND ו- DISC סמל תבליט ל-3 רמות הקינון הראשונות ברשימה.
BULLET_DIAMONDX_HOLLOWDIAMOND_SQUARE רשימה עם תבליטים עם DIAMONDX, HOLLOWDIAMOND ו- SQUARE סמל תבליט ל-3 רמות הקינון הראשונות ברשימה.
BULLET_DIAMOND_CIRCLE_SQUARE רשימה עם תבליטים עם DIAMOND, CIRCLE ו- SQUARE סמל תבליט ל-3 רמות הקינון הראשונות ברשימה.
NUMBERED_DIGIT_ALPHA_ROMAN רשימה ממוספרת עם DIGIT, ALPHA ו- ROMAN סמלים מספריים ל-3 רמות הקינון הראשונות ברשימה, ואחריהם נקודות.
NUMBERED_DIGIT_ALPHA_ROMAN_PARENS רשימה ממוספרת עם DIGIT, ALPHA ו- ROMAN סמלים מספריים ל-3 רמות הקינון הראשונות ברשימה, ואחריהם סוגריים.
NUMBERED_DIGIT_NESTED רשימה ממוספרת עם DIGIT גליפים מספריים שמופרדים באמצעות נקודות, כשכל רמת קינון משתמשת בגליף של רמת הקינון הקודמת כקידומת. לדוגמה: '1.', '1.1.', ‪'2.', ‫'2.2.'.
NUMBERED_UPPERALPHA_ALPHA_ROMAN רשימה ממוספרת עם UPPERALPHA, ALPHA ו- ROMAN סמלים מספריים ל-3 רמות הקינון הראשונות ברשימה, ואחריהם נקודות.
NUMBERED_UPPERROMAN_UPPERALPHA_DIGIT רשימה ממוספרת עם UPPERROMAN, UPPERALPHA ו- DIGIT סמלים מספריים ל-3 רמות הקינון הראשונות ברשימה, ואחריהם נקודות.
NUMBERED_ZERODIGIT_ALPHA_ROMAN רשימה ממוספרת עם ZERODIGIT, ALPHA ו- ROMAN סמלים מספריים ל-3 רמות הקינון הראשונות ברשימה, ואחריהם נקודות.

ReplaceAllShapesWithImageRequest

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

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

ייצוג ב-JSON 
{
  "replaceMethod": enum (ReplaceMethod),
  "imageReplaceMethod": enum (ImageReplaceMethod),
  "pageObjectIds": [
    string
  ],

  // Union field criteria can be only one of the following:
  "containsText": {
    object (SubstringMatchCriteria)
  }
  // End of list of possible types for union field criteria.

  // Union field image_source can be only one of the following:
  "imageUrl": string
  // End of list of possible types for union field image_source.
}
שדות
replaceMethod
(deprecated)

enum (ReplaceMethod)

השיטה replace.

יצא משימוש : במקום זאת, צריך להשתמש ב-imageReplaceMethod.

אם מציינים גם replaceMethod וגם imageReplaceMethod, המדיניות imageReplaceMethod מקבלת עדיפות.

imageReplaceMethod

enum (ImageReplaceMethod)

השיטה להחלפת התמונה.

אם מציינים גם replaceMethod וגם imageReplaceMethod, המדיניות imageReplaceMethod מקבלת עדיפות.

אם לא תציינו ערך למאפיין imageReplaceMethod, אבל תציינו ערך למאפיין replaceMethod, המערכת תשתמש בערך שציינתם למאפיין replaceMethod.

אם לא תציינו אף אחת מהאפשרויות, המערכת תשתמש בערך CENTER_INSIDE.

pageObjectIds[]

string

אם הוא לא ריק, הוא מגביל את ההתאמות לרכיבי דף רק בדפים הנתונים.

מחזירה שגיאת בקשה שגויה (400) אם ניתן מזהה אובייקט של דף מסוג notes page או notes master, או אם דף עם מזהה האובייקט הזה לא קיים במצגת.

שדה איחוד criteria. הקריטריונים שהצורות צריכות לעמוד בהם כדי שיוחלף. ‫criteria יכול להיות רק אחד מהבאים:
containsText

object (SubstringMatchCriteria)

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

שדה איחוד image_source. סוג מקור התמונה. ‫image_source יכול להיות רק אחד מהבאים:
imageUrl

string

כתובת ה-URL של התמונה.

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

אורך כתובת ה-URL שצוינה יכול להיות עד 2KB. כתובת ה-URL עצמה נשמרת עם התמונה, ומוצגת דרך השדה Image.source_url.

ReplaceMethod

השיטה replace.

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

ImageReplaceMethod

השיטה להחלפת התמונה.

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

DuplicateObjectRequest

משכפל רכיב בשקף או בדף.

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

ייצוג ב-JSON 
{
  "objectId": string,
  "objectIds": {
    string: string,
    ...
  }
}
שדות
objectId

string

המזהה של האובייקט לשכפול.

objectIds

map (key: string, value: string)

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

כל המפתחות צריכים להתאים למזהים קיימים במצגת. כל הערכים צריכים להיות ייחודיים בפיד, ולהתחיל בתו אלפאנומרי או בקו תחתון (מתאים לביטוי הרגולרי [a-zA-Z0-9_]). התווים הנותרים יכולים לכלול גם את התווים האלה, וגם מקף או נקודתיים (מתאים לביטוי הרגולרי [a-zA-Z0-9_-:]). האורך של המזהה החדש צריך להיות בין 5 ל-50 תווים.

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

UpdateTextStyleRequest

עדכון העיצוב של הטקסט ב-Shape או ב-Table.

ייצוג ב-JSON 
{
  "objectId": string,
  "cellLocation": {
    object (TableCellLocation)
  },
  "style": {
    object (TextStyle)
  },
  "textRange": {
    object (Range)
  },
  "fields": string
}
שדות
objectId

string

מזהה האובייקט של הצורה או הטבלה עם הטקסט שרוצים לעצב.

cellLocation

object (TableCellLocation)

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

style

object (TextStyle)

הסגנונות שרוצים להגדיר לטקסט.

אם הערך של סגנון מסוים זהה לערך של סגנון האב, הסגנון הזה יוגדר כסגנון שמועבר בירושה.

שינויים מסוימים בסגנון הטקסט עשויים לגרום לשינויים אחרים שנועדו לשקף את ההתנהגות של כלי העריכה ב-Slides. מידע נוסף זמין במסמכי התיעוד של TextStyle.

textRange

object (Range)

טווח הטקסט לעיצוב.

אפשר להרחיב את הטווח כך שיכלול שורות חדשות סמוכות.

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

fields

string (FieldMask format)

השדות שצריך לעדכן.

צריך לציין לפחות שדה אחד. האלמנט root style מרומז ואין לציין אותו. אפשר להשתמש בסימן "*" אחד כקיצור לרשימה של כל השדות.

לדוגמה, כדי לעדכן את סגנון הטקסט למודגש, מגדירים את fields לערך "bold".

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

ReplaceAllShapesWithSheetsChartRequest

החלפת כל הצורות שתואמות לקריטריונים שצוינו בתרשים שסופק ב-Google Sheets. התרשים ישונה כך שיתאים לגודל ולמיקום של הצורה המקורית.

הערה: כדי להחליף צורות בתרשים, צריך לפחות אחד מההיקפים הבאים של OAuth: ‏spreadsheets.readonly, ‏ spreadsheets, ‏ drive.readonly או drive.

ייצוג ב-JSON 
{
  "containsText": {
    object (SubstringMatchCriteria)
  },
  "spreadsheetId": string,
  "chartId": integer,
  "linkingMode": enum (LinkingMode),
  "pageObjectIds": [
    string
  ]
}
שדות
containsText

object (SubstringMatchCriteria)

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

spreadsheetId

string

המזהה של הגיליון האלקטרוני ב-Google Sheets שמכיל את התרשים.

chartId

integer

המזהה של התרשים הספציפי בגיליון האלקטרוני של Google Sheets.

linkingMode

enum (LinkingMode)

המצב שבו התרשים מקושר לגיליון האלקטרוני של המקור. אם לא מציינים, התרשים יהיה תמונה שלא מקושרת.

pageObjectIds[]

string

אם הוא לא ריק, הוא מגביל את ההתאמות לרכיבי דף רק בדפים הנתונים.

הפונקציה מחזירה שגיאת בקשה שגויה (400) אם מזינים לה את מזהה אובייקט הדף של notes page או של notes master, או אם לא קיים מצגת דף עם מזהה האובייקט הזה.

LinkingMode

המצב שבו התרשים מקושר לגיליון האלקטרוני של המקור.

טיפוסים בני מנייה (enum)
NOT_LINKED_IMAGE התרשים לא משויך לגיליון האלקטרוני של המקור, ואי אפשר לעדכן אותו. תרשים שלא מקושר יתווסף כתמונה.
LINKED קישור התרשים מאפשר לעדכן אותו, ושאר שותפי העריכה יראו קישור לגיליון האלקטרוני.

DeleteParagraphBulletsRequest

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

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

ייצוג ב-JSON 
{
  "objectId": string,
  "cellLocation": {
    object (TableCellLocation)
  },
  "textRange": {
    object (Range)
  }
}
שדות
objectId

string

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

cellLocation

object (TableCellLocation)

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

textRange

object (Range)

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

UpdateParagraphStyleRequest

מעדכן את הסגנון של כל הפסקאות בתוך התג Shape או Table שחופפות לטווח האינדקס של הטקסט שצוין.

ייצוג ב-JSON 
{
  "objectId": string,
  "cellLocation": {
    object (TableCellLocation)
  },
  "style": {
    object (ParagraphStyle)
  },
  "textRange": {
    object (Range)
  },
  "fields": string
}
שדות
objectId

string

מזהה האובייקט של הצורה או הטבלה עם הטקסט שרוצים לעצב.

cellLocation

object (TableCellLocation)

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

style

object (ParagraphStyle)

הסגנון של הפסקה.

textRange

object (Range)

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

fields

string (FieldMask format)

השדות שצריך לעדכן.

צריך לציין לפחות שדה אחד. האלמנט root style מרומז ואין לציין אותו. אפשר להשתמש בסימן "*" אחד כקיצור לרשימה של כל השדות.

לדוגמה, כדי לעדכן את יישור הפסקה, מגדירים את fields לערך "alignment".

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

UpdateTableBorderPropertiesRequest

מעדכן את המאפיינים של גבולות הטבלה ב-Table.

ייצוג ב-JSON 
{
  "objectId": string,
  "tableRange": {
    object (TableRange)
  },
  "borderPosition": enum (BorderPosition),
  "tableBorderProperties": {
    object (TableBorderProperties)
  },
  "fields": string
}
שדות
objectId

string

מזהה האובייקט של הטבלה.

tableRange

object (TableRange)

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

borderPosition

enum (BorderPosition)

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

tableBorderProperties

object (TableBorderProperties)

מאפייני גבול הטבלה לעדכון.

fields

string (FieldMask format)

השדות שצריך לעדכן.

צריך לציין לפחות שדה אחד. האלמנט root tableBorderProperties מרומז ואין לציין אותו. אפשר להשתמש בסימן "*" אחד כקיצור לרשימה של כל השדות.

לדוגמה, כדי לעדכן את צבע המילוי של גבול הטבלה, מגדירים את fields לערך "tableBorderFill.solidFill.color".

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

BorderPosition

המיקום של גבול הטבלה.

טיפוסים בני מנייה (enum)
ALL כל הגבולות בטווח.
BOTTOM גבולות בתחתית הטווח.
INNER גבולות בתוך הטווח.
INNER_HORIZONTAL גבולות אופקיים בתוך הטווח.
INNER_VERTICAL גבולות אנכיים בתוך הטווח.
LEFT גבולות בצד ימין של הטווח.
OUTER גבולות לאורך החלק החיצוני של הטווח.
RIGHT גבולות בצד שמאל של הטווח.
TOP גבולות בחלק העליון של הטווח.

UpdateTableColumnPropertiesRequest

מעדכן את המאפיינים של עמודה Table.

ייצוג ב-JSON 
{
  "objectId": string,
  "columnIndices": [
    integer
  ],
  "tableColumnProperties": {
    object (TableColumnProperties)
  },
  "fields": string
}
שדות
objectId

string

מזהה האובייקט של הטבלה.

columnIndices[]

integer

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

tableColumnProperties

object (TableColumnProperties)

מאפייני העמודה בטבלה שרוצים לעדכן.

אם הערך של tableColumnProperties#columnWidth בבקשה קטן מ-406,400 יחידות EMU (32 נקודות), תוחזר שגיאה מסוג 400 בקשה שגויה.

fields

string (FieldMask format)

השדות שצריך לעדכן.

צריך לציין לפחות שדה אחד. האלמנט root tableColumnProperties מרומז ואין לציין אותו. אפשר להשתמש בסימן "*" אחד כקיצור לרשימה של כל השדות.

לדוגמה, כדי לעדכן את רוחב העמודה, מגדירים את fields לערך "columnWidth".

אם '"columnWidth"' נכלל במסכת השדות אבל הנכס לא מוגדר, רוחב העמודה יהיה 406,400 EMU (32 נקודות) כברירת מחדל.

UpdateTableRowPropertiesRequest

עדכון המאפיינים של שורה Table.

ייצוג ב-JSON 
{
  "objectId": string,
  "rowIndices": [
    integer
  ],
  "tableRowProperties": {
    object (TableRowProperties)
  },
  "fields": string
}
שדות
objectId

string

מזהה האובייקט של הטבלה.

rowIndices[]

integer

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

tableRowProperties

object (TableRowProperties)

מאפייני השורה בטבלה שרוצים לעדכן.

fields

string (FieldMask format)

השדות שצריך לעדכן.

צריך לציין לפחות שדה אחד. האלמנט root tableRowProperties מרומז ואין לציין אותו. אפשר להשתמש בסימן "*" אחד כקיצור לרשימה של כל השדות.

לדוגמה, כדי לעדכן את הגובה המינימלי של השורה, מגדירים את fields לערך "minRowHeight".

אם המאפיין 'minRowHeight' נכלל במסכת השדות אבל לא מוגדר, גובה השורה המינימלי יהיה 0 כברירת מחדל.

MergeTableCellsRequest

ממזגת תאים ב-Table.

ייצוג ב-JSON 
{
  "objectId": string,
  "tableRange": {
    object (TableRange)
  }
}
שדות
objectId

string

מזהה האובייקט של הטבלה.

tableRange

object (TableRange)

טווח הטבלה שמציין אילו תאים בטבלה ימוזגו.

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

UnmergeTableCellsRequest

ביטול המיזוג של תאים ב-Table.

ייצוג ב-JSON 
{
  "objectId": string,
  "tableRange": {
    object (TableRange)
  }
}
שדות
objectId

string

מזהה האובייקט של הטבלה.

tableRange

object (TableRange)

טווח הטבלה שמציין אילו תאים בטבלה יבוטל בהם המיזוג.

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

GroupObjectsRequest

מקבצים אובייקטים כדי ליצור קבוצת אובייקטים. לדוגמה, קבוצות PageElements כדי ליצור Group באותו הדף כמו כל הצאצאים.

ייצוג ב-JSON 
{
  "groupObjectId": string,
  "childrenObjectIds": [
    string
  ]
}
שדות
groupObjectId

string

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

אם מציינים מזהה, הוא צריך להיות ייחודי בכל הדפים ורכיבי הדפים במצגת. המזהה חייב להתחיל בתו אלפאנומרי או בקו תחתון (מתאים לביטוי הרגולרי [a-zA-Z0-9_]). התווים הנותרים יכולים לכלול את התווים האלה, וגם מקף או נקודתיים (מתאים לביטוי הרגולרי [a-zA-Z0-9_-:]). אורך המזהה צריך להיות בין 5 ל-50 תווים.

אם לא מציינים מזהה, נוצר מזהה ייחודי.

childrenObjectIds[]

string

מזהי האובייקטים של האובייקטים שרוצים לקבץ.

אפשר לקבץ רק רכיבים של דפים. צריכים להיות לפחות שני רכיבי דף באותו דף שלא נכללים כבר בקבוצה אחרת. אי אפשר לקבץ חלק מרכיבי הדף, כמו videos, tables ו- placeholders.

UngroupObjectsRequest

מבטל את הקיבוץ של אובייקטים, כמו groups.

ייצוג ב-JSON 
{
  "objectIds": [
    string
  ]
}
שדות
objectIds[]

string

מזהי האובייקטים של האובייקטים שרוצים לבטל את הקיבוץ שלהם.

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

UpdatePageElementAltTextRequest

מעדכן את הכותרת ו/או את התיאור של הטקסט החלופי של תמונה מסוג page element.

ייצוג ב-JSON 
{
  "objectId": string,
  "title": string,
  "description": string
}
שדות
objectId

string

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

title

string

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

description

string

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

ReplaceImageRequest

מחליפה תמונה קיימת בתמונה חדשה.

החלפת תמונה מסירה חלק מהתכונות של התמונה הקיימת.image effects

ייצוג ב-JSON 
{
  "imageObjectId": string,
  "imageReplaceMethod": enum (ImageReplaceMethod),

  // Union field image_source can be only one of the following:
  "url": string
  // End of list of possible types for union field image_source.
}
שדות
imageObjectId

string

המזהה של התמונה הקיימת שתוחלף. אפשר לאחזר את המזהה מהתגובה של בקשת GET.

imageReplaceMethod

enum (ImageReplaceMethod)

שיטת ההחלפה.

שדה איחוד image_source. סוג מקור התמונה. ‫image_source יכול להיות רק אחד מהבאים:
url

string

כתובת ה-URL של התמונה.

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

האורך של כתובת ה-URL שצוינה לא יכול להיות יותר מ-2KB. כתובת ה-URL נשמרת עם התמונה ומוצגת בשדה Image.source_url.

UpdateSlidePropertiesRequest

עדכון המאפיינים של שקף.

ייצוג ב-JSON 
{
  "objectId": string,
  "slideProperties": {
    object (SlideProperties)
  },
  "fields": string
}
שדות
objectId

string

מזהה האובייקט של השקף שהעדכון חל עליו.

slideProperties

object (SlideProperties)

מאפייני השקף לעדכון.

fields

string (FieldMask format)

השדות שצריך לעדכן.

צריך לציין לפחות שדה אחד. רכיב הבסיס slideProperties מרומז ואין לציין אותו. אפשר להשתמש בסימן "*" אחד כקיצור לרשימה של כל השדות.

לדוגמה, כדי לעדכן אם לדלג על שקף, מגדירים את fields לערך "isSkipped".

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

UpdatePageElementsZOrderRequest

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

ייצוג ב-JSON 
{
  "pageElementObjectIds": [
    string
  ],
  "operation": enum (ZOrderOperation)
}
שדות
pageElementObjectIds[]

string

מזהי האובייקטים של רכיבי הדף שרוצים לעדכן.

כל רכיבי הדף צריכים להיות באותו דף, ואסור לקבץ אותם.

operation

enum (ZOrderOperation)

הפעולה של Z-order שרוצים להחיל על רכיבי הדף.

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

ZOrderOperation

הפעולה לעדכון סדר ה-Z של רכיב בדף.

טיפוסים בני מנייה (enum)
Z_ORDER_OPERATION_UNSPECIFIED פעולה לא מוגדרת.
BRING_TO_FRONT העברת רכיבי הדף לחלק הקדמי של הדף.
BRING_FORWARD הפונקציה מעבירה את רכיבי הדף קדימה בדף, ברכיב אחד ביחס לרכיב הקדמי ביותר ברכיבי הדף שצוינו.
SEND_BACKWARD הפונקציה מעבירה את רכיבי הדף אחורה בדף, רכיב אחד אחורה ביחס לרכיב הכי אחורי ברכיבי הדף שצוינו.
SEND_TO_BACK שליחת רכיבי הדף לחלק האחורי של הדף.

UpdateLineCategoryRequest

מעדכן את הקטגוריה של line.

ייצוג ב-JSON 
{
  "objectId": string,
  "lineCategory": enum (LineCategory)
}
שדות
objectId

string

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

אפשר לעדכן רק שורה עם category שמציינת שהיא 'מחבר'.

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

lineCategory

enum (LineCategory)

קטגוריית השורה שאליה רוצים לעדכן.

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

RerouteLineRequest

מנתב מחדש את line כך שהוא מחובר בשני אתרי החיבור הקרובים ביותר ברכיבי הדף המחוברים.

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

string

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

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