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

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

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

slideLayoutReference

object (LayoutReference)

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

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

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

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

placeholderIdMappings[]

object (LayoutPlaceholderIdMapping)

רשימה אופציונלית של מיפויים של מזהי אובייקטים מה-placeholder בפריסה אל ה-placeholders שנוצרים בשקופית מהפריסה שצוינה. אפשר להשתמש בו רק כשמציינים את הערך 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. הסוג של LayoutReference. kind יכול להיות רק אחד מהערכים הבאים:
predefinedLayout

enum (PredefinedLayout)

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

layoutId

string

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

PredefinedLayout

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

טיפוסים בני מנייה (enum)
PREDEFINED_LAYOUT_UNSPECIFIED פריסה לא צוינה.
BLANK פריסה ריקה, ללא placeholders.
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

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

ייצוג ב-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. הסוג לזיהוי placeholder בפריסה. kind יכול להיות רק אחד מהערכים הבאים:
layoutPlaceholder

object (Placeholder)

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

layoutPlaceholderObjectId

string

מזהה האובייקט של placeholder בתבנית שתחול על שקף.

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)

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

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

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

rows

integer

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

columns

integer

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

InsertTextRequest

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

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

string

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

cellLocation

object (TableCellLocation)

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

text

string

הטקסט שרוצים להוסיף.

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

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

תווי בקרה מסוימים (U+0000-U+0008, ‏ U+000C-U+001F) ותווים מאזור השימוש הפרטי של מישור Unicode Basic Multilingual (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 : הוספה מתחת לתא.
  • False : הוספה מעל התא.
number

integer

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

InsertTableColumnsRequest

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

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

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

string

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

cellLocation

object (TableCellLocation)

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

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

insertRight

boolean

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

  • True : הוספה שמאלה.
  • False : הוספה שמאלה.
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 אם צריך להתייחס לערך החיפוש כביטוי רגולרי. צריך לסמן בתווי בריחה (escape) את כל הקווים הנטויים לאחור בתבנית.

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

DeleteObjectRequest

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

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

string

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

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

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

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)

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

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. בסרטון ב-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.

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

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

string

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

UpdateShapePropertiesRequest

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

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

string

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

shapeProperties

object (ShapeProperties)

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

fields

string (FieldMask format)

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

צריך לציין שדה אחד לפחות. השורש shapeProperties הוא משוער ואין צורך לציין אותו. אפשר להשתמש ב-"*" אחד כקיצור דרך להצגת כל השדות.

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

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

UpdateImagePropertiesRequest

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

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

string

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

imageProperties

object (ImageProperties)

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

fields

string (FieldMask format)

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

צריך לציין שדה אחד לפחות. השורש 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)

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

צריך לציין שדה אחד לפחות. השורש 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)

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

צריך לציין שדה אחד לפחות. השורש 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)

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

צריך לציין שדה אחד לפחות. השורש tableCellProperties הוא משוער ואין צורך לציין אותו. אפשר להשתמש ב-"*" אחד כקיצור דרך להצגת כל השדות.

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

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

TableRange

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

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

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

טווח טבלה עם המיקום = (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)

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

צריך לציין שדה אחד לפחות. השורש lineProperties הוא משוער ואין צורך לציין אותו. אפשר להשתמש ב-"*" אחד כקיצור דרך להצגת כל השדות.

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

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

CreateParagraphBulletsRequest

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

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

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

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

string

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

cellLocation

object (TableCellLocation)

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

textRange

object (Range)

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

bulletPreset

enum (BulletGlyphPreset)

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

BulletGlyphPreset

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

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

  • ARROW : חץ, התואם למיקום תו (code point) U+2794 ב-Unicode
  • ARROW3D : חץ עם צללית תלת-ממדית, התואם למיקום תו (code point) U+27a2 ב-Unicode
  • CHECKBOX : ריבוע ריק, התואם למיקום תו (code point) ב-Unicode‏ U+274f
  • CIRCLE : עיגול חלול, התואם למיקום תו (code point) ב-Unicode‏ U+25cb
  • DIAMOND : ריבוע שחור מלא, שתואם למיקום תו (code point) U+25c6 ב-Unicode
  • DIAMONDX : יהלום עם 'x', התואם למיקום תו (code point) של Unicode‏ U+2756
  • HOLLOWDIAMOND : יהלום חלול, התואם למיקום תו (code point) U+25c7 ב-Unicode
  • DISC : עיגול מלא, התואם למיקום תו (code point) ב-Unicode‏ U+25cf
  • SQUARE : ריבוע מלא, התואם למיקום תו (code point) ב-Unicode‏ U+25a0
  • STAR : כוכב, התואם למיקום התו (code point) U+2605 ב-Unicode
  • 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 : משולש שמצביע שמאלה, התואם למיקום תו (code point) U+25c4 ב-Unicode
טיפוסים בני מנייה (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)

שיטת ההחלפה.

הוצא משימוש : צריך להשתמש ב-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

שיטת ההחלפה.

טיפוסים בני מנייה (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

עדכון הסגנון של הטקסט ב-