בקשה
סוג אחד של עדכון שחל על מצגת.
ייצוג ב-JSON |
---|
{ // Union field |
שדות | |
---|---|
שדה האיחוד
kind . סוג העדכון. צריך למלא שדה אחד בדיוק.
kind
יכול להיות רק אחד מהערכים הבאים:
|
|
createSlide
|
יצירת שקף חדש. |
createShape
|
יצירת צורה חדשה. |
createTable
|
יצירת טבלה חדשה. |
insertText
|
הוספת טקסט לצורה או לתא בטבלה. |
insertTableRows
|
הוספת שורות לטבלה. |
insertTableColumns
|
הוספת עמודות לטבלה. |
deleteTableRow
|
מחיקה של שורה מטבלה. |
deleteTableColumn
|
מחיקה של עמודה מטבלה. |
replaceAllText
|
החלפת כל המופעים של הטקסט שצוין. |
deleteObject
|
מחיקה של דף או רכיב דף מהמצגת. |
updatePageElementTransform
|
עדכון הטרנספורמציה של רכיב דף. |
updateSlidesPosition
|
עדכון המיקום של קבוצת שקפים במצגת. |
deleteText
|
מחיקת טקסט מצורה או מתא בטבלה. |
createImage
|
יצירת תמונה. |
createVideo
|
יצירת סרטון. |
createSheetsChart
|
יוצרת תרשים מוטמע של Google Sheets. |
createLine
|
יצירת קו. |
refreshSheetsChart
|
רענון תרשים ב-Google Sheets. |
updateShapeProperties
|
עדכון המאפיינים של |
updateImageProperties
|
עדכון המאפיינים של |
updateVideoProperties
|
עדכון המאפיינים של |
updatePageProperties
|
עדכון המאפיינים של |
updateTableCellProperties
|
עדכון המאפיינים של |
updateLineProperties
|
עדכון המאפיינים של |
createParagraphBullets
|
יוצרת סמלי נקודה-קו עבור פסקאות. |
replaceAllShapesWithImage
|
החלפת כל הצורות שתואמות לקריטריונים מסוימים בתמונה. |
duplicateObject
|
שכפול של שקף או רכיב דף. |
updateTextStyle
|
|
replaceAllShapesWithSheetsChart
|
החלפת כל הצורות שתואמות לקריטריונים מסוימים בתרשים של Google Sheets. |
deleteParagraphBullets
|
מחיקת תוויות של נקודות מפסיק מהפסקאות. |
updateParagraphStyle
|
|
updateTableBorderProperties
|
מעדכנת את המאפיינים של גבולות הטבלה ב- |
updateTableColumnProperties
|
עדכון המאפיינים של עמודת |
updateTableRowProperties
|
עדכון המאפיינים של שורת |
mergeTableCells
|
מיזוג תאים ב- |
unmergeTableCells
|
ביטול המיזוג של תאים ב- |
groupObjects
|
קיבוץ אובייקטים, כמו רכיבי דף. |
ungroupObjects
|
ביטול הקיבוץ של אובייקטים, כמו
|
updatePageElementAltText
|
מעדכנת את הכותרת ו/או את התיאור של הטקסט החלופי של |
replaceImage
|
מחליפה תמונה קיימת בתמונה חדשה. |
updateSlideProperties
|
עדכון המאפיינים של שקף |
updatePageElementsZOrder
|
מעדכנת את סדר Z של |
updateLineCategory
|
הקוד מעדכן את הקטגוריה של |
rerouteLine
|
המערכת מנתבת מחדש את |
CreateSlideRequest
יצירת שקף.
ייצוג ב-JSON |
---|
{ "objectId": string, "insertionIndex": integer, "slideLayoutReference": { object ( |
שדות | |
---|---|
objectId
|
מזהה אובייקט שסופק על ידי משתמש.
אם מציינים מזהה, הוא צריך להיות ייחודי בכל הדפים ורכיבי הדפים במצגת. המזהה חייב להתחיל בתו אלפאנומרי או בקו תחתון (תואם לביטוי הרגולרי
אם לא מציינים מזהה, נוצר מזהה ייחודי. |
insertionIndex
|
אינדקס אופציונלי שמתחיל ב-0 ומציין איפה להוסיף את השקפים. אם לא מציינים אינדקס, השקופית נוצרת בסוף. |
slideLayoutReference
|
הפניה לפריסה של השקף שרוצים להוסיף, על סמך התבנית הראשית הנוכחית, שהיא אחת מהאפשרויות הבאות:
אם ה-LayoutReference לא נמצא בגרסה הראשית הנוכחית, תוחזר שגיאה 400 (בקשה לא חוקית).
אם לא מציינים ערך של רכיב העיצוב, המערכת משתמשת ברכיב העיצוב |
placeholderIdMappings[]
|
רשימה אופציונלית של מיפויים של מזהי אובייקטים מה- |
LayoutReference
הפניה לפריסת השקף. האפשרויות הן:
- פריסה מוגדרת מראש
- אחת מהפריסות במצגת.
ייצוג ב-JSON |
---|
{ // Union field |
שדות | |
---|---|
שדה האיחוד
kind . הסוג של LayoutReference.
kind
יכול להיות רק אחד מהערכים הבאים:
|
|
predefinedLayout
|
פריסה מוגדרת מראש. |
layoutId
|
מזהה פריסה: מזהה האובייקט של אחת הפריסות במצגת. |
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 |
שדות | |
---|---|
objectId
|
מזהה אובייקט שמסופק על ידי המשתמש עבור placeholder שצוין למעלה, שייווצר בשקופית.
אם מציינים מזהה, הוא צריך להיות ייחודי בכל הדפים ורכיבי הדפים במצגת. המזהה חייב להתחיל בתו אלפאנומרי או בקו תחתון (תואם לביטוי הרגולרי
אם לא מציינים מזהה, נוצר מזהה ייחודי. |
שדה האיחוד
kind . הסוג לזיהוי placeholder בפריסה.
kind
יכול להיות רק אחד מהערכים הבאים:
|
|
layoutPlaceholder
|
placeholder בתצוגה שמחובר לשקף. צריך רק את |
layoutPlaceholderObjectId
|
מזהה האובייקט של placeholder בתבנית שתחול על שקף. |
CreateShapeRequest
יצירת צורה חדשה.
ייצוג ב-JSON |
---|
{ "objectId": string, "elementProperties": { object ( |
שדות | |
---|---|
objectId
|
מזהה אובייקט שסופק על ידי משתמש.
אם מציינים מזהה, הוא צריך להיות ייחודי בכל הדפים ורכיבי הדפים במצגת. המזהה חייב להתחיל בתו אלפאנומרי או בקו תחתון (תואם לביטוי הרגולרי
|
elementProperties
|
מאפייני הרכיב של הצורה. |
shapeType
|
סוג הצורה. |
PageElementProperties
מאפיינים נפוצים של רכיב דף.
הערה: כשאתם יוצרים PageElement
בפעם הראשונה, ממשק ה-API עשוי לשנות את הערכים של size
ושל transform
, אבל הגודל החזותי לא ישתנה.
ייצוג ב-JSON |
---|
{ "pageObjectId": string, "size": { object ( |
שדות | |
---|---|
pageObjectId
|
מזהה האובייקט של הדף שבו נמצא הרכיב. |
size
|
הגודל של הרכיב. |
transform
|
הטרנספורמציה של האלמנט. |
CreateTableRequest
יצירת טבלה חדשה.
ייצוג ב-JSON |
---|
{
"objectId": string,
"elementProperties": {
object ( |
שדות | |
---|---|
objectId
|
מזהה אובייקט שסופק על ידי משתמש.
אם מציינים מזהה, הוא צריך להיות ייחודי בכל הדפים ורכיבי הדפים במצגת. המזהה חייב להתחיל בתו אלפאנומרי או בקו תחתון (תואם לביטוי הרגולרי
אם לא מציינים מזהה, נוצר מזהה ייחודי. |
elementProperties
|
מאפייני הרכיב של הטבלה. הטבלה תיווצר בגודל שצוין, בכפוף לגודל מינימלי. אם לא מציינים גודל, המערכת תגדיר את הגודל של הטבלה באופן אוטומטי. לטרנספורמציות של טבלאות צריך להיות קנה מידה של 1 ואין להן רכיבי גזירה. אם לא מציינים טרנספורמציה, הטבלה תהיה ממוקמת במרכז הדף. |
rows
|
מספר השורות בטבלה. |
columns
|
מספר העמודות בטבלה. |
InsertTextRequest
הוספת טקסט לצורה או לתא בטבלה.
ייצוג ב-JSON |
---|
{
"objectId": string,
"cellLocation": {
object ( |
שדות | |
---|---|
objectId
|
מזהה האובייקט של הצורה או הטבלה שבהן הטקסט יוצמד. |
cellLocation
|
המיקום האופציונלי של תא בטבלה, אם הטקסט יתווסף לתא בטבלה. אם השדה הזה קיים, הוא חייב להפנות לטבלה. |
text
|
הטקסט שרוצים להוסיף.
הוספת תו של שורה חדשה תיצור באופן משתמע
סגנונות הטקסט של הטקסט שהוכנס ייקבעו באופן אוטומטי, בדרך כלל תוך שמירה על סגנון הטקסט הסמוך. ברוב המקרים, הטקסט יתווסף ל- תווי בקרה מסוימים (U+0000-U+0008, U+000C-U+001F) ותווים מאזור השימוש הפרטי של מישור Unicode Basic Multilingual (U+E000-U+F8FF) יוסרו מהטקסט שהוכנס. |
insertionIndex
|
האינדקס שבו הטקסט יתווסף, ביחידות קוד של Unicode, על סמך אינדקסים של האינדקס מבוסס על אפס ומחושב מתחילת המחרוזת. יכול להיות שהאינדקס יותאם כדי למנוע הוספות בתוך אשכולות גרפיות של Unicode. במקרים כאלה, הטקסט יוכנס מיד אחרי אשכול הגרפמות. |
InsertTableRowsRequest
הוספת שורות לטבלה.
ייצוג ב-JSON |
---|
{
"tableObjectId": string,
"cellLocation": {
object ( |
שדות | |
---|---|
tableObjectId
|
הטבלה שאליה רוצים להוסיף שורות. |
cellLocation
|
מיקום התא בטבלת העזר שממנו יתווספו שורות. תתווסף שורה חדשה מעל (או מתחת) לשורה שבה נמצא תא העזר. אם תא העזר הוא תא ממוזג, תתווסף שורה חדשה מעל (או מתחת) לתא הממוזג. |
insertBelow
|
האם להוסיף שורות חדשות מתחת למיקום של תא העזר.
|
number
|
מספר השורות להוספה. מקסימום 20 לכל בקשה. |
InsertTableColumnsRequest
הוספת עמודות לטבלה.
הגודל של העמודות האחרות בטבלה ישתנה כך שיתאים לעמודה החדשה.
ייצוג ב-JSON |
---|
{
"tableObjectId": string,
"cellLocation": {
object ( |
שדות | |
---|---|
tableObjectId
|
הטבלה שבה רוצים להוסיף עמודות. |
cellLocation
|
מיקום התא בטבלת העזר שממנו יתווספו העמודות. תתווסף עמודה חדשה משמאל (או מימין) לעמודה שבה נמצא תא ההפניה. אם תא ההפניה הוא תא ממוזג, תתווסף עמודה חדשה משמאל (או מימין) לתא הממוזג. |
insertRight
|
האם להוסיף עמודות חדשות מימין למיקום של תא העזר.
|
number
|
מספר העמודות שרוצים להוסיף. מקסימום 20 לכל בקשה. |
DeleteTableRowRequest
מחיקה של שורה מטבלה.
ייצוג ב-JSON |
---|
{
"tableObjectId": string,
"cellLocation": {
object ( |
שדות | |
---|---|
tableObjectId
|
הטבלה שממנה רוצים למחוק שורות. |
cellLocation
|
מיקום התא בטבלת העזר שממנו תימחק שורה. השורה שהתא הזה משתרע עליה תימחק. אם מדובר בתא ממוזג, מספר שורות יימחקו. אם לא נותרו שורות בטבלה אחרי המחיקה הזו, כל הטבלה נמחקת. |
DeleteTableColumnRequest
מחיקה של עמודה מטבלה.
ייצוג ב-JSON |
---|
{
"tableObjectId": string,
"cellLocation": {
object ( |
שדות | |
---|---|
tableObjectId
|
הטבלה שממנה רוצים למחוק עמודות. |
cellLocation
|
מיקום התא בטבלת העזר שממנה תימחק עמודה. העמודה שהתא הזה משתרע עליה תימחק. אם מדובר בתא ממוזג, יימחקו כמה עמודות. אם לא נותרו עמדות בטבלה אחרי המחיקה הזו, כל הטבלה נמחקת. |
ReplaceAllTextRequest
הפונקציה מחליפה את כל המופעים של טקסט שתואמים לקריטריון מסוים ב-replace text
.
ייצוג ב-JSON |
---|
{ "replaceText": string, "pageObjectIds": [ string ], // Union field |
שדות | |
---|---|
replaceText
|
הטקסט שיחליף את הטקסט התואם. |
pageObjectIds[]
|
אם הערך לא ריק, הוא מגביל את ההתאמות לרכיבי דפים רק בדפים הנתונים.
הפונקציה מחזירה את השגיאה 400 (בקשה לא חוקית) אם צוין מזהה אובייקט הדף של |
שדה האיחוד
criteria . הקריטריונים שבהם נעשה שימוש כדי להתאים טקסט להחלפה.
criteria
יכול להיות רק אחד מהערכים הבאים:
|
|
containsText
|
חיפוש טקסט בצורה שתואמת למחרוזת המשנה הזו. |
SubstringMatchCriteria
קריטריון שתואמת למחרוזת טקסט ספציפית בצורה או בטבלה.
ייצוג ב-JSON |
---|
{ "text": string, "matchCase": boolean, "searchByRegex": boolean } |
שדות | |
---|---|
text
|
הטקסט שרוצים לחפש בצורה או בטבלה. |
matchCase
|
מציין אם החיפוש צריך להתחשב ברישיות:
|
searchByRegex
|
זה שינוי אופציונלי. הערך True אם צריך להתייחס לערך החיפוש כביטוי רגולרי. צריך לסמן בתווי בריחה (escape) את כל הקווים הנטויים לאחור בתבנית.
|
DeleteObjectRequest
מחיקה של אובייקט, pages
או page elements
, מהמצגת.
ייצוג ב-JSON |
---|
{ "objectId": string } |
שדות | |
---|---|
objectId
|
מזהה האובייקט של הדף או רכיב הדף שרוצים למחוק.
אם אחרי פעולת מחיקה, הערך של אם מוחקים placeholder בפריסה, נמחקים גם placeholders ריקים שעברו בירושה. |
UpdatePageElementTransformRequest
עדכון הטרנספורמציה של רכיב דף.
עדכון הטרנספורמציה של קבוצה ישנה את הטרנספורמציה המוחלטת של רכיבי הדף בקבוצה הזו, וכתוצאה מכך יכול להיות שינוי במראה החזותי שלהם. פרטים נוספים זמינים במסמכי התיעוד של PageElement.transform
.
ייצוג ב-JSON |
---|
{ "objectId": string, "transform": { object ( |
שדות | |
---|---|
objectId
|
מזהה האובייקט של רכיב הדף שרוצים לעדכן. |
transform
|
מטריצת הטרנספורמציה של הקלט ששימשה לעדכון רכיב הדף. |
applyMode
|
מצב היישום של עדכון הטרנספורמציה. |
ApplyMode
מצבי היישום של עדכון הטרנספורמציה.
טיפוסים בני מנייה (enum) | |
---|---|
APPLY_MODE_UNSPECIFIED
|
מצב לא מוגדר. |
RELATIVE
|
החלת המטריצה החדשה של AffineTransform על המטריצה הקיימת, והחלפת המטריצה הקיימת בשרשור שנוצר. |
ABSOLUTE
|
מחליף את המטריצה הקיימת של AffineTransform במטריצה החדשה. |
UpdateSlidesPositionRequest
עדכון המיקום של השקפים במצגת.
ייצוג ב-JSON |
---|
{ "slideObjectIds": [ string ], "insertionIndex": integer } |
שדות | |
---|---|
slideObjectIds[]
|
המזהים של השקפים במצגת שרוצים להעביר. השקפים ברשימה הזו חייבים להיות בסדר המוצג במצגת, בלי כפילויות. |
insertionIndex
|
האינדקס שבו השקפים צריכים להתווסף, על סמך סידור השקפים לפני ההעברה. הערך חייב להיות בין אפס למספר השקפים במצגת, כולל. |
DeleteTextRequest
מחיקת טקסט מצורה או מתא בטבלה.
ייצוג ב-JSON |
---|
{ "objectId": string, "cellLocation": { object ( |
שדות | |
---|---|
objectId
|
מזהה האובייקט של הצורה או הטבלה שממנה הטקסט יימחק. |
cellLocation
|
המיקום האופציונלי של תא הטבלה אם רוצים למחוק את הטקסט מתא בטבלה. אם השדה הזה קיים, הוא חייב להפנות לטבלה. |
textRange
|
טווח הטקסט למחיקה, על סמך אינדקסים של
תמיד יש תו שורה חדשה משתמע בסוף הטקסט של צורה או של תא בטבלה, ואי אפשר למחוק אותו.
מחיקת טקסט שמעבר לגבול של פסקה עלולה לגרום לשינויים בסגנונות וברשימות של הפסקות, כי שתי הפסקות ימוזגו. טווחים שכוללים רק יחידת קוד אחת של זוג סמלי עזר מורחבים כך שיכללו את שתי יחידות הקוד. |
טווח
מציין טווח רציף של קולקציה שנוספה לאינדקס, כמו תווים בטקסט.
ייצוג ב-JSON |
---|
{
"startIndex": integer,
"endIndex": integer,
"type": enum ( |
שדות | |
---|---|
startIndex
|
אינדקס אופציונלי שמתחיל בספרה אפס של תחילת האוסף. חובה ביחס לטווחים |
endIndex
|
אינדקס אופציונלי שמתחיל באפס ומציין את סוף האוסף. חובה לטווח |
type
|
סוג הטווח. |
סוג
סוגי הטווחים.
טיפוסים בני מנייה (enum) | |
---|---|
RANGE_TYPE_UNSPECIFIED
|
סוג הטווח לא צוין. אסור להשתמש בערך הזה. |
FIXED_RANGE
|
טווח קבוע. צריך לציין גם את הערך של startIndex וגם את הערך של endIndex .
|
FROM_START_INDEX
|
הטווח מתחיל ב-startIndex וממשיך עד לסוף האוסף. אסור לציין את הערך endIndex .
|
ALL
|
הגדרת הטווח לאורך האוסף כולו. אסור לציין גם את הערך של startIndex וגם את הערך של endIndex .
|
CreateImageRequest
יצירת תמונה.
ייצוג ב-JSON |
---|
{ "objectId": string, "elementProperties": { object ( |
שדות | |
---|---|
objectId
|
מזהה אובייקט שסופק על ידי משתמש.
אם מציינים מזהה, הוא צריך להיות ייחודי בכל הדפים ורכיבי הדפים במצגת. המזהה חייב להתחיל בתו אלפאנומרי או בקו תחתון (תואם לביטוי הרגולרי
אם לא מציינים מזהה, נוצר מזהה ייחודי. |
elementProperties
|
מאפייני הרכיב של התמונה. אם יחס הגובה-רוחב של הגודל שצוין לא תואם ליחס הגובה-רוחב של התמונה, התמונה תתאים לגודל ותתמקם במרכז כדי לשמור על יחס הגובה-רוחב. הטרנספורמציה שצוינה תחול אחרי הפעולה הזו.
המאפיין |