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.
}
فیلدها
فیلد Union 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 طوری تغییر مسیر می‌دهد که در دو نقطه اتصال نزدیک‌تر روی عناصر صفحه متصل، به هم متصل شود.

درخواست ایجاد اسلاید

یک اسلاید ایجاد می‌کند.

نمایش JSON
{
  "objectId": string,
  "insertionIndex": integer,
  "slideLayoutReference": {
    object (LayoutReference)
  },
  "placeholderIdMappings": [
    {
      object (LayoutPlaceholderIdMapping)
    }
  ]
}
فیلدها
objectId

string

شناسه شیء ارائه شده توسط کاربر.

اگر شناسه‌ای را مشخص می‌کنید، باید در بین تمام صفحات و عناصر صفحه در ارائه منحصر به فرد باشد. شناسه باید با یک کاراکتر الفبایی-عددی یا زیرخط شروع شود (با عبارت منظم [a-zA-Z0-9_] مطابقت دارد)؛ کاراکترهای باقی مانده می‌توانند شامل این کاراکترها و همچنین یک خط فاصله یا دو نقطه باشند (با عبارت منظم [a-zA-Z0-9_-:] مطابقت دارد). طول شناسه باید بین ۵ تا ۵۰ کاراکتر باشد، شامل همه.

اگر شناسه‌ای مشخص نکنید، یک شناسه منحصر به فرد ایجاد می‌شود.

insertionIndex

integer

اندیس اختیاری مبتنی بر صفر که نشان می‌دهد اسلایدها کجا درج شوند.

اگر اندیس را مشخص نکنید، اسلاید در انتها ایجاد می‌شود.

slideLayoutReference

object ( LayoutReference )

مرجع طرح‌بندی اسلایدی که قرار است درج شود، بر اساس فایل اصلی فعلی که یکی از موارد زیر است:

  • استاد فهرست اسلاید قبلی.
  • اگر مقدار insertionIndex برابر با صفر باشد، اسلاید اصلی (master) اولین اسلاید.
  • اولین استاد در ارائه، اگر اسلایدی وجود نداشته باشد.

اگر LayoutReference در فایل اصلی فعلی یافت نشود، خطای درخواست نادرست ۴۰۰ بازگردانده می‌شود.

اگر مرجع طرح‌بندی را مشخص نکنید، اسلاید از طرح‌بندی از پیش تعریف‌شده‌ی BLANK استفاده می‌کند.

placeholderIdMappings[]

object ( LayoutPlaceholderIdMapping )

یک لیست اختیاری از نگاشت‌های شناسه شیء از placeholder (های) جایگذاری در طرح‌بندی به نگهدارنده‌هایی که در اسلاید از طرح‌بندی مشخص شده ایجاد می‌شوند. فقط زمانی قابل استفاده است که slideLayoutReference مشخص شده باشد.

مرجع طرح‌بندی

مرجع طرح‌بندی اسلاید. این ممکن است به یکی از موارد زیر اشاره داشته باشد:

  • طرح از پیش تعریف شده
  • یکی از طرح‌بندی‌های موجود در ارائه.
نمایش 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 فیلد Union. kind LayoutReference.type فقط می‌تواند یکی از موارد زیر باشد:
predefinedLayout

enum ( PredefinedLayout )

طرح از پیش تعریف شده.

layoutId

string

شناسه طرح‌بندی: شناسه شیء یکی از طرح‌بندی‌های موجود در ارائه.

طرح از پیش تعریف شده

انواع طرح‌بندی از پیش تعریف‌شده. این‌ها طرح‌بندی‌هایی هستند که معمولاً در ارائه‌ها یافت می‌شوند. با این حال، هیچ تضمینی وجود ندارد که این طرح‌بندی‌ها در فایل اصلی فعلی وجود داشته باشند، زیرا ممکن است حذف شده باشند یا بخشی از قالب استفاده‌شده نباشند. علاوه بر این، ممکن است متغیرهای هر طرح‌بندی تغییر کرده باشند.

انوم‌ها
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 طرح‌بندی با عنوان با عدد بزرگ.

چیدمانPlaceholderIdMapping

نگاشت شناسه‌ی مشخص‌شده توسط کاربر برای یک نگهدارنده‌ی مکان که روی اسلایدی از یک طرح‌بندی مشخص ایجاد خواهد شد.

نمایش 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

یک شناسه شیء ارائه شده توسط کاربر برای نگهدارنده مکان مشخص شده در بالا که قرار است روی اسلاید ایجاد شود.

اگر شناسه‌ای را مشخص می‌کنید، باید در بین تمام صفحات و عناصر صفحه در ارائه منحصر به فرد باشد. شناسه باید با یک کاراکتر الفبایی-عددی یا زیرخط شروع شود (با عبارت منظم [a-zA-Z0-9_] مطابقت دارد)؛ کاراکترهای باقی مانده می‌توانند شامل این کاراکترها و همچنین یک خط فاصله یا دو نقطه باشند (با عبارت منظم [a-zA-Z0-9_-:] مطابقت دارد). طول شناسه نباید کمتر از ۵ یا بیشتر از ۵۰ باشد.

اگر شناسه‌ای مشخص نکنید، یک شناسه منحصر به فرد ایجاد می‌شود.

kind فیلد Union. نوعی که یک متغیر را در طرح‌بندی مشخص می‌کند. kind می‌تواند فقط یکی از موارد زیر باشد:
layoutPlaceholder

object ( Placeholder )

جایگذاری روی طرح‌بندی که روی اسلاید اعمال خواهد شد. فقط type و index مورد نیاز هستند. برای مثال، یک طرح‌بندی از پیش تعریف‌شده TITLE_AND_BODY معمولاً ممکن است یک جایگذاری TITLE با اندیس ۰ و یک جایگذاری BODY با اندیس ۰ داشته باشد.

layoutPlaceholderObjectId

string

شناسه‌ی شیءِ جای‌نگهدارنده در طرح‌بندی که روی اسلاید اعمال خواهد شد.

درخواست ایجاد شکل

شکل جدیدی ایجاد می‌کند.

نمایش JSON
{
  "objectId": string,
  "elementProperties": {
    object (PageElementProperties)
  },
  "shapeType": enum (Type)
}
فیلدها
objectId

string

شناسه شیء ارائه شده توسط کاربر.

اگر شناسه‌ای را مشخص می‌کنید، باید در بین تمام صفحات و عناصر صفحه در ارائه منحصر به فرد باشد. شناسه باید با یک کاراکتر الفبایی-عددی یا زیرخط شروع شود (با عبارت منظم [a-zA-Z0-9_] مطابقت دارد)؛ کاراکترهای باقی مانده می‌توانند شامل این کاراکترها و همچنین یک خط فاصله یا دو نقطه باشند (با عبارت منظم [a-zA-Z0-9_-:] مطابقت دارد). طول شناسه نباید کمتر از ۵ یا بیشتر از ۵۰ باشد. در صورت خالی بودن، یک شناسه منحصر به فرد ایجاد می‌شود.

elementProperties

object ( PageElementProperties )

خواص المان برای شکل.

shapeType

enum ( Type )

نوع شکل.

ویژگی‌های عنصر صفحه

ویژگی‌های رایج برای یک عنصر صفحه.

نکته: وقتی در ابتدا یک PageElement ایجاد می‌کنید، API ممکن است مقادیر size و transform تغییر دهد، اما اندازه بصری بدون تغییر خواهد ماند.

نمایش JSON
{
  "pageObjectId": string,
  "size": {
    object (Size)
  },
  "transform": {
    object (AffineTransform)
  }
}
فیلدها
pageObjectId

string

شناسه شیء صفحه‌ای که عنصر در آن قرار دارد.

size

object ( Size )

اندازه عنصر.

transform

object ( AffineTransform )

تبدیل برای عنصر.

درخواست ایجاد جدول

یک جدول جدید ایجاد می‌کند.

نمایش JSON
{
  "objectId": string,
  "elementProperties": {
    object (PageElementProperties)
  },
  "rows": integer,
  "columns": integer
}
فیلدها
objectId

string

شناسه شیء ارائه شده توسط کاربر.

اگر شناسه‌ای را مشخص می‌کنید، باید در بین تمام صفحات و عناصر صفحه در ارائه منحصر به فرد باشد. شناسه باید با یک کاراکتر الفبایی-عددی یا زیرخط شروع شود (با عبارت منظم [a-zA-Z0-9_] مطابقت دارد)؛ کاراکترهای باقی مانده می‌توانند شامل این کاراکترها و همچنین یک خط فاصله یا دو نقطه باشند (با عبارت منظم [a-zA-Z0-9_-:] مطابقت دارد). طول شناسه نباید کمتر از ۵ یا بیشتر از ۵۰ باشد.

اگر شناسه‌ای مشخص نکنید، یک شناسه منحصر به فرد ایجاد می‌شود.

elementProperties

object ( PageElementProperties )

ویژگی‌های عنصر برای جدول.

جدول با توجه به حداقل اندازه، در اندازه ارائه شده ایجاد خواهد شد. اگر اندازه‌ای ارائه نشود، جدول به طور خودکار اندازه‌گذاری می‌شود.

تبدیل‌های جدول باید مقیاس ۱ داشته باشند و هیچ مؤلفه برشی نداشته باشند. اگر هیچ تبدیلی ارائه نشود، جدول در مرکز صفحه قرار می‌گیرد.

rows

integer

تعداد ردیف‌های جدول.

columns

integer

تعداد ستون‌های جدول.

درخواست درج متن

متن را در یک شکل یا یک سلول جدول وارد می‌کند.

نمایش 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) و کاراکترهای ناحیه استفاده خصوصی صفحه چندزبانه پایه یونیکد (U+E000-U+F8FF) از متن درج شده حذف خواهند شد.

insertionIndex

integer

اندیسی که متن در آن درج خواهد شد، بر اساس واحدهای کد یونیکد و بر اساس اندیس‌های TextElement .

این اندیس مبتنی بر صفر است و از ابتدای رشته محاسبه می‌شود. این اندیس را می‌توان طوری تنظیم کرد که از درج در داخل خوشه‌های گرافِمِ یونیکد جلوگیری شود. در این موارد، متن بلافاصله پس از خوشه گرافِم درج خواهد شد.

درخواست درج سطرهای جدول

ردیف‌ها را در جدول درج می‌کند.

نمایش JSON
{
  "tableObjectId": string,
  "cellLocation": {
    object (TableCellLocation)
  },
  "insertBelow": boolean,
  "number": integer
}
فیلدها
tableObjectId

string

جدولی که قرار است سطرها در آن درج شوند.

cellLocation

object ( TableCellLocation )

محل سلول جدول مرجع که سطرها از آن درج خواهند شد.

یک ردیف جدید در بالا (یا پایین) ردیفی که سلول مرجع در آن قرار دارد، درج خواهد شد. اگر سلول مرجع یک سلول ادغام شده باشد، یک ردیف جدید در بالا (یا پایین) سلول ادغام شده درج خواهد شد.

insertBelow

boolean

آیا سطرهای جدید زیر محل سلول مرجع درج شوند یا خیر.

  • True : زیر سلول درج شود.
  • False : بالای سلول درج شود.
number

integer

تعداد ردیف‌هایی که باید درج شوند. حداکثر ۲۰ ردیف برای هر درخواست.

درخواست درج ستون‌های جدول

ستون‌ها را در جدول درج می‌کند.

ستون‌های دیگر جدول نیز تغییر اندازه خواهند داد تا با ستون جدید متناسب شوند.

نمایش JSON
{
  "tableObjectId": string,
  "cellLocation": {
    object (TableCellLocation)
  },
  "insertRight": boolean,
  "number": integer
}
فیلدها
tableObjectId

string

جدولی که قرار است ستون‌ها را در آن وارد کنید.

cellLocation

object ( TableCellLocation )

محل سلول جدول مرجع که ستون‌ها از آن درج خواهند شد.

یک ستون جدید در سمت چپ (یا راست) ستونی که سلول مرجع در آن قرار دارد، درج خواهد شد. اگر سلول مرجع، یک سلول ادغام شده باشد، یک ستون جدید در سمت چپ (یا راست) سلول ادغام شده درج خواهد شد.

insertRight

boolean

آیا ستون‌های جدید در سمت راست محل سلول مرجع درج شوند یا خیر.

  • True : در سمت راست وارد شود.
  • False : در سمت چپ وارد کنید.
number

integer

تعداد ستون‌هایی که باید درج شوند. حداکثر ۲۰ ستون برای هر درخواست.

درخواست حذف ردیف جدول

یک ردیف را از جدول حذف می‌کند.

نمایش JSON
{
  "tableObjectId": string,
  "cellLocation": {
    object (TableCellLocation)
  }
}
فیلدها
tableObjectId

string

جدولی که قرار است سطرهای آن حذف شوند.

cellLocation

object ( TableCellLocation )

مکان سلول جدول مرجع که یک ردیف از آن حذف خواهد شد.

ردیفی که این سلول در بر می‌گیرد حذف خواهد شد. اگر این یک سلول ادغام شده باشد، چندین ردیف حذف می‌شوند. اگر پس از این حذف هیچ ردیفی در جدول باقی نماند، کل جدول حذف می‌شود.

درخواست حذف جدول ستونی

یک ستون را از جدول حذف می‌کند.

نمایش JSON
{
  "tableObjectId": string,
  "cellLocation": {
    object (TableCellLocation)
  }
}
فیلدها
tableObjectId

string

جدولی که ستون‌های آن حذف می‌شوند.

cellLocation

object ( TableCellLocation )

محل سلول جدول مرجع که ستون از آن حذف خواهد شد.

ستونی که این سلول در بر می‌گیرد حذف خواهد شد. اگر این یک سلول ادغام شده باشد، چندین ستون حذف می‌شوند. اگر پس از این حذف هیچ ستونی در جدول باقی نماند، کل جدول حذف می‌شود.

درخواست جایگزینی همه متن

تمام نمونه‌های متنی که با یک معیار مطابقت دارند را با 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

اگر خالی نباشد، تطابق‌ها را فقط به عناصر صفحه در صفحات داده شده محدود می‌کند.

اگر شناسه شیء صفحه مربوط به یک notes master داده شود، یا اگر صفحه‌ای با آن شناسه شیء در ارائه وجود نداشته باشد، خطای درخواست نادرست ۴۰۰ را برمی‌گرداند.

criteria فیلد Union. معیارهایی که برای تطبیق متن جهت جایگزینی استفاده می‌شوند. criteria فقط می‌توانند یکی از موارد زیر باشند:
containsText

object ( SubstringMatchCriteria )

متنی را پیدا می‌کند که شکلی مطابق با این زیررشته داشته باشد.

معیارهای تطبیق زیررشته

معیاری که با رشته‌ی خاصی از متن در یک شکل یا جدول مطابقت دارد.

نمایش JSON
{
  "text": string,
  "matchCase": boolean,
  "searchByRegex": boolean
}
فیلدها
text

string

متنی که قرار است در شکل یا جدول جستجو شود.

matchCase

boolean

نشان می‌دهد که آیا جستجو باید به بزرگی و کوچکی حروف توجه کند یا خیر:

  • True : جستجو به حروف بزرگ و کوچک حساس است.
  • False : جستجو به حروف بزرگ و کوچک حساس نیست.
searchByRegex

boolean

اختیاری. اگر مقدار find باید به عنوان یک عبارت منظم در نظر گرفته شود، صحیح است. هرگونه بک اسلش در الگو باید escape شود.

  • True : متن جستجو به عنوان یک عبارت منظم در نظر گرفته می‌شود.
  • False : متن جستجو برای تطبیق به عنوان یک زیررشته در نظر گرفته می‌شود.

درخواست حذف شیء

یک شیء، چه pages و چه page elements ، را از ارائه حذف می‌کند.

نمایش JSON
{
  "objectId": string
}
فیلدها
objectId

string

شناسه‌ی شیء صفحه یا عنصر صفحه‌ای که قرار است حذف شود.

اگر پس از عملیات حذف، group فقط شامل ۱ عنصر صفحه باشد یا هیچ عنصر صفحه‌ای نداشته باشد، آن گروه نیز حذف می‌شود.

اگر یک placeholder در یک طرح‌بندی حذف شود، هر placeholder خالیِ به ارث رسیده از آن نیز حذف می‌شود.

درخواست تبدیل عنصر صفحه را به‌روزرسانی کنید

تبدیل یک عنصر صفحه را به‌روزرسانی می‌کند.

به‌روزرسانی تبدیل یک گروه، تبدیل مطلق عناصر صفحه در آن گروه را تغییر می‌دهد که می‌تواند ظاهر بصری آنها را تغییر دهد. برای جزئیات بیشتر به مستندات PageElement.transform مراجعه کنید.

نمایش JSON
{
  "objectId": string,
  "transform": {
    object (AffineTransform)
  },
  "applyMode": enum (ApplyMode)
}
فیلدها
objectId

string

شناسه‌ی شیء عنصر صفحه‌ای که قرار است به‌روزرسانی شود.

transform

object ( AffineTransform )

ماتریس تبدیل ورودی که برای به‌روزرسانی عنصر صفحه استفاده می‌شود.

applyMode

enum ( ApplyMode )

حالت اعمال به‌روزرسانی تبدیل.

حالت اعمال

حالت‌های اعمال به‌روزرسانی تبدیل.

انوم‌ها
APPLY_MODE_UNSPECIFIED حالت نامشخص.
RELATIVE ماتریس AffineTransform جدید را روی ماتریس موجود اعمال می‌کند و ماتریس موجود را با الحاق حاصل جایگزین می‌کند.
ABSOLUTE ماتریس AffineTransform موجود را با ماتریس جدید جایگزین می‌کند.

درخواست موقعیت اسلایدها را به‌روزرسانی کنید

موقعیت اسلایدها را در ارائه به‌روزرسانی می‌کند.

نمایش JSON
{
  "slideObjectIds": [
    string
  ],
  "insertionIndex": integer
}
فیلدها
slideObjectIds[]

string

شناسه‌های اسلایدهای موجود در ارائه که باید منتقل شوند. اسلایدهای موجود در این لیست باید به ترتیب ارائه موجود و بدون موارد تکراری باشند.

insertionIndex

integer

فهرستی که اسلایدها باید در آن قرار گیرند، بر اساس چیدمان اسلایدها قبل از جابجایی. باید بین صفر و تعداد اسلایدهای موجود در ارائه، شامل موارد زیر باشد.

درخواست حذف متن

متن را از یک شکل یا یک سلول جدول حذف می‌کند.

نمایش 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" باشد و به دنبال آن یک خط جدید ضمنی آمده باشد، حداکثر مقدار برای textRange.start_index برابر با ۲ و برای 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 )

نوع محدوده.

نوع

انواع محدوده‌ها.

انوم‌ها
RANGE_TYPE_UNSPECIFIED نوع محدوده نامشخص. این مقدار نباید استفاده شود.
FIXED_RANGE یک محدوده ثابت. هر دو startIndex و endIndex باید مشخص شوند.
FROM_START_INDEX محدوده را از startIndex شروع می‌کند و تا انتهای مجموعه ادامه می‌دهد. endIndex نباید مشخص شود.
ALL محدوده را به اندازه کل طول مجموعه تنظیم می‌کند. لازم نیست هم startIndex و هم endIndex مشخص شوند.

درخواست تصویر ایجاد کنید

تصویر ایجاد می‌کند.

نمایش 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_-:] مطابقت دارد). طول شناسه نباید کمتر از ۵ یا بیشتر از ۵۰ باشد.

اگر شناسه‌ای مشخص نکنید، یک شناسه منحصر به فرد ایجاد می‌شود.

elementProperties

object ( PageElementProperties )

ویژگی‌های عنصر برای تصویر.

وقتی نسبت ابعاد اندازه ارائه شده با نسبت ابعاد تصویر مطابقت نداشته باشد، تصویر نسبت به اندازه کوچک و بزرگ می‌شود تا نسبت ابعاد حفظ شود. تبدیل ارائه شده پس از این عملیات اعمال می‌شود.

ویژگی PageElementProperties.size اختیاری است. اگر اندازه را مشخص نکنید، از اندازه پیش‌فرض تصویر استفاده می‌شود.

ویژگی PageElementProperties.transform اختیاری است. اگر transform را مشخص نکنید، تصویر در گوشه بالا سمت چپ صفحه قرار می‌گیرد.

فیلد یونیونی image_source . نوع منبع تصویر. image_source فقط می‌تواند یکی از موارد زیر باشد:
url

string

آدرس اینترنتی تصویر.

تصویر یک بار در زمان درج دریافت می‌شود و یک کپی برای نمایش در داخل ارائه ذخیره می‌شود. حجم تصاویر باید کمتر از ۵۰ مگابایت باشد، نمی‌تواند از ۲۵ مگاپیکسل بیشتر باشد و باید در یکی از قالب‌های PNG، JPEG یا GIF باشد.

URL ارائه شده باید به صورت عمومی قابل دسترسی باشد و حداکثر ۲ کیلوبایت طول داشته باشد. URL به همراه تصویر ذخیره می‌شود و از طریق فیلد Image.source_url نمایش داده می‌شود.

درخواست ویدیو ایجاد کنید

یک ویدیو ایجاد می‌کند.

توجه: ایجاد ویدیو از گوگل درایو مستلزم آن است که برنامه درخواست‌کننده حداقل یکی از حوزه‌های احراز هویت 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_-:] مطابقت دارد). طول شناسه نباید کمتر از ۵ یا بیشتر از ۵۰ باشد.

اگر شناسه‌ای مشخص نکنید، یک شناسه منحصر به فرد ایجاد می‌شود.

elementProperties

object ( PageElementProperties )

ویژگی‌های عنصر برای ویدیو.

ویژگی PageElementProperties.size اختیاری است. اگر اندازه‌ای مشخص نکنید، سرور اندازه پیش‌فرض را انتخاب می‌کند.

ویژگی PageElementProperties.transform اختیاری است. تبدیل نباید دارای اجزای برشی باشد. اگر تبدیلی مشخص نکنید، ویدیو در گوشه بالا سمت چپ صفحه قرار می‌گیرد.

source

enum ( Source )

منبع ویدیو.

id

string

شناسه منحصر به فرد منبع ویدیو برای این ویدیو.

برای مثال، برای ویدیوی یوتیوب https://www.youtube.com/watch?v=7U3axjORYZ0 ، شناسه 7U3axjORYZ0 است. برای ویدیوی گوگل درایو https://drive.google.com/file/d/1xCgQLFTJi5_Xl8DgW_lcUYq5e-q6Hi5Q ، شناسه 1xCgQLFTJi5_Xl8DgW_lcUYq5e-q6Hi5Q است.

برای دسترسی به یک فایل ویدیویی گوگل درایو، ممکن است لازم باشد یک کلید منبع به هدر HTTP برای زیرمجموعه‌ای از فایل‌های قدیمی اضافه کنید. برای اطلاعات بیشتر، به «دسترسی به فایل‌های اشتراک‌گذاری‌شده با لینک با استفاده از کلیدهای منبع» مراجعه کنید.

درخواست ایجاد نمودارها

یک نمودار Google Sheets جاسازی‌شده ایجاد می‌کند.

نکته: ایجاد نمودار حداقل به یکی از حوزه‌های spreadsheets.readonly، spreadsheets، drive.readonly، drive.file یا drive OAuth نیاز دارد.

نمایش 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

شناسه‌ی صفحه‌گسترده‌ی گوگل‌شیت که نمودار در آن قرار دارد.

ممکن است لازم باشد برای زیرمجموعه‌ای از فایل‌های قدیمی، یک کلید منبع به هدر HTTP اضافه کنید. برای اطلاعات بیشتر، به «دسترسی به فایل‌های اشتراک‌گذاری‌شده با لینک با استفاده از کلیدهای منبع» مراجعه کنید.

chartId

integer

شناسه نمودار خاص در صفحه گسترده Google Sheets.

linkingMode

enum ( LinkingMode )

حالتی که نمودار با آن به صفحه گسترده منبع پیوند داده می‌شود. در صورت عدم تعیین این حالت، نمودار تصویری خواهد بود که پیوند داده نشده است.

حالت پیوند

حالتی که نمودار با آن به صفحه گسترده منبع پیوند داده می‌شود.

انوم‌ها
NOT_LINKED_IMAGE نمودار به صفحه گسترده منبع مرتبط نیست و قابل به‌روزرسانی نیست. نموداری که لینک نشده باشد، به عنوان تصویر درج خواهد شد.
LINKED پیوند دادن نمودار امکان به‌روزرسانی آن را فراهم می‌کند و سایر همکاران پیوندی به صفحه گسترده را مشاهده خواهند کرد.

درخواست خط جدید

یک خط ایجاد می‌کند.

نمایش JSON
{
  "objectId": string,
  "elementProperties": {
    object (PageElementProperties)
  },
  "lineCategory": enum (Category),
  "category": enum (LineCategory)
}
فیلدها
objectId

string

شناسه شیء ارائه شده توسط کاربر.

اگر شناسه‌ای را مشخص می‌کنید، باید در بین تمام صفحات و عناصر صفحه در ارائه منحصر به فرد باشد. شناسه باید با یک کاراکتر الفبایی-عددی یا زیرخط شروع شود (با عبارت منظم [a-zA-Z0-9_] مطابقت دارد)؛ کاراکترهای باقی مانده می‌توانند شامل این کاراکترها و همچنین یک خط فاصله یا دو نقطه باشند (با عبارت منظم [a-zA-Z0-9_-:] مطابقت دارد). طول شناسه نباید کمتر از ۵ یا بیشتر از ۵۰ باشد.

اگر شناسه‌ای مشخص نکنید، یک شناسه منحصر به فرد ایجاد می‌شود.

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 استفاده می‌شود.

دسته بندی

دسته بندی های خط.

انوم‌ها
STRAIGHT کانکتورهای مستقیم، شامل کانکتور مستقیم ۱. این دسته، دسته پیش‌فرض است وقتی که یکی مشخص نشده باشد.
BENT کانکتورهای خم شده، شامل کانکتور خم شده ۲ تا ۵.
CURVED کانکتورهای منحنی، شامل کانکتور منحنی ۲ تا ۵.

درخواست نمودار تازه‌سازی

نمودار تعبیه‌شده در Google Sheets را با جایگزینی آن با آخرین نسخه نمودار از Google Sheets، به‌روزرسانی می‌کند.

نکته: به‌روزرسانی نمودارها حداقل به یکی از حوزه‌های spreadsheets.readonly، spreadsheets، drive.readonly یا drive OAuth نیاز دارد.

نمایش JSON
{
  "objectId": string
}
فیلدها
objectId

string

شناسه‌ی شیء نموداری که قرار است به‌روزرسانی شود.

درخواست به‌روزرسانی ویژگی‌های شکل

به‌روزرسانی ویژگی‌های یک Shape

نمایش JSON
{
  "objectId": string,
  "shapeProperties": {
    object (ShapeProperties)
  },
  "fields": string
}
فیلدها
objectId

string

شناسه‌ی شیء شکلی که به‌روزرسانی‌ها روی آن اعمال می‌شوند.

shapeProperties

object ( ShapeProperties )

ویژگی‌های شکل برای به‌روزرسانی.

fields

string ( FieldMask format)

فیلدهایی که باید به‌روزرسانی شوند.

حداقل یک فیلد باید مشخص شود. ریشه shapeProperties ضمنی است و نباید مشخص شود. می‌توان از یک "*" به عنوان اختصار برای فهرست کردن هر فیلد استفاده کرد.

برای مثال، برای به‌روزرسانی رنگ پس‌زمینه‌ی شکل به رنگ ثابت، fields روی "shapeBackgroundFill.solidFill.color" تنظیم کنید.

برای تنظیم مجدد یک ویژگی به مقدار پیش‌فرض، نام فیلد آن را در ماسک فیلد قرار دهید اما خود فیلد را بدون تغییر رها کنید.

درخواست به‌روزرسانی ویژگی‌های تصویر

به‌روزرسانی ویژگی‌های یک Image

نمایش JSON
{
  "objectId": string,
  "imageProperties": {
    object (ImageProperties)
  },
  "fields": string
}
فیلدها
objectId

string

شناسه شیء تصویری که به‌روزرسانی‌ها روی آن اعمال می‌شوند.

imageProperties

object ( ImageProperties )

ویژگی‌های تصویر برای به‌روزرسانی.

fields

string ( FieldMask format)

فیلدهایی که باید به‌روزرسانی شوند.

حداقل یک فیلد باید مشخص شود. imageProperties ریشه ضمنی است و نباید مشخص شود. می‌توان از یک "*" به عنوان اختصار برای فهرست کردن هر فیلد استفاده کرد.

برای مثال، برای به‌روزرسانی رنگ حاشیه تصویر، fields روی "outline.outlineFill.solidFill.color" تنظیم کنید.

برای تنظیم مجدد یک ویژگی به مقدار پیش‌فرض، نام فیلد آن را در ماسک فیلد قرار دهید اما خود فیلد را بدون تغییر رها کنید.

درخواست به‌روزرسانیویژگی‌های ویدیو

به‌روزرسانی ویژگی‌های یک Video

نمایش JSON
{
  "objectId": string,
  "videoProperties": {
    object (VideoProperties)
  },
  "fields": string
}
فیلدها
objectId

string

شناسه‌ی شیء ویدیویی که به‌روزرسانی‌ها روی آن اعمال می‌شوند.

videoProperties

object ( VideoProperties )

ویژگی‌های ویدیو برای به‌روزرسانی.

fields

string ( FieldMask format)

فیلدهایی که باید به‌روزرسانی شوند.

حداقل یک فیلد باید مشخص شود. videoProperties ریشه ضمنی است و نباید مشخص شود. می‌توان از یک "*" به عنوان اختصار برای فهرست کردن هر فیلد استفاده کرد.

برای مثال، برای به‌روزرسانی رنگ حاشیه ویدیو، fields روی "outline.outlineFill.solidFill.color" تنظیم کنید.

برای تنظیم مجدد یک ویژگی به مقدار پیش‌فرض، نام فیلد آن را در ماسک فیلد قرار دهید اما خود فیلد را بدون تغییر رها کنید.

درخواست به‌روزرسانی ویژگی‌های صفحه

ویژگی‌های یک Page را به‌روزرسانی می‌کند.

نمایش JSON
{
  "objectId": string,
  "pageProperties": {
    object (PageProperties)
  },
  "fields": string
}
فیلدها
objectId

string

شناسه شیء صفحه‌ای که به‌روزرسانی روی آن اعمال می‌شود.

pageProperties

object ( PageProperties )

ویژگی‌های صفحه‌ای که باید به‌روزرسانی شوند.

fields

string ( FieldMask format)

فیلدهایی که باید به‌روزرسانی شوند.

حداقل یک فیلد باید مشخص شود. pageProperties ریشه ضمنی است و نباید مشخص شود. می‌توان از یک "*" به عنوان اختصار برای فهرست کردن هر فیلد استفاده کرد.

برای مثال، برای به‌روزرسانی رنگ پس‌زمینه صفحه به رنگ ثابت، fields روی "pageBackgroundFill.solidFill.color" تنظیم کنید.

برای تنظیم مجدد یک ویژگی به مقدار پیش‌فرض، نام فیلد آن را در ماسک فیلد قرار دهید اما خود فیلد را بدون تغییر رها کنید.

درخواست به‌روزرسانی ویژگی‌های سلول جدول

به‌روزرسانی ویژگی‌های یک 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" تنظیم کنید.

برای تنظیم مجدد یک ویژگی به مقدار پیش‌فرض، نام فیلد آن را در ماسک فیلد قرار دهید اما خود فیلد را بدون تغییر رها کنید.

جدول محدوده

یک محدوده جدول، نشان‌دهنده ارجاع به زیرمجموعه‌ای از یک جدول است.

لازم به ذکر است که سلول‌های مشخص شده توسط یک محدوده جدول لزوماً یک مستطیل تشکیل نمی‌دهند. برای مثال، فرض کنید یک جدول ۳ در ۳ داریم که تمام سلول‌های ردیف آخر آن با هم ادغام شده‌اند. جدول به این شکل است:

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

یک محدوده جدول با location = (0, 0)، row span = 3 و column span = 2، سلول‌های زیر را مشخص می‌کند:

 [ x ][ x ][   ]
 [ x ][ x ][   ]
 [ x    x    x ]
نمایش JSON
{
  "location": {
    object (TableCellLocation)
  },
  "rowSpan": integer,
  "columnSpan": integer
}
فیلدها
location

object ( TableCellLocation )

محل شروع محدوده جدول.

rowSpan

integer

طول ردیف‌های محدوده‌ی جدول.

columnSpan

integer

طول ستون‌های محدوده‌ی جدول.

درخواست به‌روزرسانی ویژگی‌های خط

ویژگی‌های یک Line را به‌روزرسانی می‌کند.

نمایش JSON
{
  "objectId": string,
  "lineProperties": {
    object (LineProperties)
  },
  "fields": string
}
فیلدها
objectId

string

شناسه شیء خطی که به‌روزرسانی روی آن اعمال می‌شود.

lineProperties

object ( LineProperties )

ویژگی‌های خط برای به‌روزرسانی.

fields

string ( FieldMask format)

فیلدهایی که باید به‌روزرسانی شوند.

حداقل یک فیلد باید مشخص شود. ویژگی های ریشه lineProperties ضمنی هستند و نباید مشخص شوند. یک "*" واحد می‌تواند به عنوان اختصار برای فهرست کردن هر فیلد استفاده شود.

برای مثال، برای به‌روزرسانی رنگ پر کردن یک‌دست خط، fields روی "lineFill.solidFill.color" تنظیم کنید.

برای تنظیم مجدد یک ویژگی به مقدار پیش‌فرض، نام فیلد آن را در ماسک فیلد قرار دهید اما خود فیلد را بدون تغییر رها کنید.

درخواست ایجادBulletsParagraph

برای تمام پاراگراف‌هایی که با محدوده‌ی شاخص متن داده شده همپوشانی دارند، علامت‌های راهنما (bullet) ایجاد می‌کند.

سطح تودرتوی هر پاراگراف با شمارش تب‌های ابتدای هر پاراگراف تعیین می‌شود. برای جلوگیری از فضای اضافی بین بولت و پاراگراف مربوطه، این تب‌های ابتدای پاراگراف با این درخواست حذف می‌شوند. این ممکن است شاخص‌های بخش‌هایی از متن را تغییر دهد.

اگر پاراگرافی که بلافاصله قبل از پاراگراف‌های در حال به‌روزرسانی قرار دارد، در فهرستی با پیش‌تنظیمات منطبق باشد، پاراگراف‌های در حال به‌روزرسانی به آن فهرست قبلی اضافه می‌شوند.

نمایش 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 : یک فلش، مربوط به یک کد پوینت یونیکد U+2794
  • ARROW3D : یک پیکان با سایه سه‌بعدی، مربوط به یک کد پوینت یونیکد U+27a2
  • CHECKBOX : یک مربع توخالی، مربوط به یک کد پوینت یونیکد U+274f
  • CIRCLE : یک دایره توخالی، مربوط به یک کد پوینت یونیکد U+25cb
  • DIAMOND : یک الماس جامد، مربوط به کد پوینت یونیکد U+25c6
  • DIAMONDX : یک لوزی با 'x' که مربوط به یک کد پوینت یونیکد U+2756 است.
  • HOLLOWDIAMOND : یک الماس توخالی، مربوط به کد پوینت یونیکد U+25c7
  • DISC : یک دایره توپر، مربوط به یک نقطه کد یونیکد U+25cf
  • SQUARE : یک مربع توپر، مربوط به یک کد پوینت یونیکد U+25a0
  • STAR : یک ستاره، مربوط به یک کد پوینت یونیکد U+2605
  • ALPHA : یک حرف کوچک، مانند «a»، «b» یا «c».
  • حروف بزرگ UPPERALPHA : یک حرف بزرگ، مانند 'A'، 'B' یا 'C'.
  • DIGIT : عددی مانند «۱»، «۲» یا «۳».
  • ZERODIGIT ): عددی که در آن اعداد تک رقمی با صفر شروع می‌شوند، مانند '01'، '02' یا '03'. اعدادی که بیش از یک رقم دارند، با صفر شروع نمی‌شوند.
  • ROMAN : یک عدد رومی کوچک، مانند «i»، «ii» یا «iii».
  • UPPERROMAN : یک عدد رومی با حروف بزرگ، مانند «I»، «II» یا «III».
  • LEFTTRIANGLE : مثلثی که به سمت چپ اشاره دارد و مربوط به نقطه کد یونیکد U+25c4 است.
انوم‌ها
BULLET_DISC_CIRCLE_SQUARE یک لیست نقطه‌ای با علامت‌های DISC ، CIRCLE و SQUARE برای سه سطح اول تودرتوی لیست.
BULLET_DIAMONDX_ARROW3D_SQUARE یک لیست نقطه‌ای با علامت‌های DIAMONDX ، ARROW3D و SQUARE برای سه سطح اول تودرتوی لیست.
BULLET_CHECKBOX یک لیست نقطه‌دار با علامت‌های نقطه‌ای CHECKBOX برای تمام سطوح تودرتوی لیست.
BULLET_ARROW_DIAMOND_DISC یک لیست نقطه‌ای با علامت‌های ARROW ، DIAMOND و DISC برای سه سطح اول تودرتوی لیست.
BULLET_STAR_CIRCLE_SQUARE یک لیست نقطه‌ای با علامت‌های STAR ، CIRCLE و SQUARE برای سه سطح اول تودرتوی لیست.
BULLET_ARROW3D_CIRCLE_SQUARE یک لیست نقطه‌ای با علامت‌های ARROW3D ، CIRCLE و SQUARE برای سه سطح اول تودرتوی لیست.
BULLET_LEFTTRIANGLE_DIAMOND_DISC یک لیست نقطه‌ای با علامت‌های LEFTTRIANGLE ، DIAMOND و DISC برای سه سطح اول تودرتوی لیست.
BULLET_DIAMONDX_HOLLOWDIAMOND_SQUARE یک لیست نقطه‌ای با علامت‌های نقطه‌ای DIAMONDX ، HOLLOWDIAMOND و SQUARE برای سه سطح اول تودرتوی لیست.
BULLET_DIAMOND_CIRCLE_SQUARE یک لیست نقطه‌ای با گلیف‌های DIAMOND ، CIRCLE و SQUARE برای سه سطح اول تودرتوی لیست.
NUMBERED_DIGIT_ALPHA_ROMAN یک لیست شماره‌گذاری شده با گلیف‌های عددی DIGIT ، ALPHA و ROMAN برای سه سطح اول تودرتوی لیست، و پس از آن نقطه.
NUMBERED_DIGIT_ALPHA_ROMAN_PARENS یک لیست شماره‌گذاری شده با گلیف‌های عددی DIGIT ، ALPHA و ROMAN برای سه سطح اول تودرتوی لیست، و به دنبال آن پرانتز.
NUMBERED_DIGIT_NESTED یک لیست شماره‌گذاری شده با گلیف‌های عددی DIGIT که با نقطه از هم جدا شده‌اند، که در آن هر سطح تودرتو از گلیف سطح تودرتوی قبلی به عنوان پیشوند استفاده می‌کند. برای مثال: '1.'، '1.1.'، '2.'، '2.2.'.
NUMBERED_UPPERALPHA_ALPHA_ROMAN یک لیست شماره‌گذاری شده با حروف عددی UPPERALPHA ، ALPHA و ROMAN برای سه سطح اول تودرتوی لیست، و پس از آن نقطه.
NUMBERED_UPPERROMAN_UPPERALPHA_DIGIT یک لیست شماره‌گذاری شده با گلیف‌های عددی UPPERROMAN ، UPPERALPHA و DIGIT برای سه سطح اول تودرتوی لیست، و پس از آن نقطه.
NUMBERED_ZERODIGIT_ALPHA_ROMAN یک لیست شماره‌گذاری شده با گلیف‌های عددی ZERODIGIT ، ALPHA و ROMAN برای سه سطح اول تودرتوی لیست، و پس از آن نقطه.

درخواست جایگزینی همه شکل‌ها با تصویر

تمام شکل‌هایی که با معیارهای داده شده مطابقت دارند را با تصویر ارائه شده جایگزین می‌کند.

تصاویر جایگزین اشکال، پس از قرار گرفتن در ارائه، مستطیل شکل هستند و فرم اشکال را به خود نمی‌گیرند.

نمایش 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

اگر خالی نباشد، تطابق‌ها را فقط به عناصر صفحه در صفحات داده شده محدود می‌کند.

اگر شناسه شیء صفحه مربوط به یک notes page یا یک notes master داده شود، یا اگر صفحه‌ای با آن شناسه شیء در ارائه وجود نداشته باشد، خطای درخواست نادرست ۴۰۰ را برمی‌گرداند.

criteria فیلد مشترک. معیارهایی که شکل‌ها باید برای جایگزینی با آنها مطابقت داشته باشند. criteria فقط می‌توانند یکی از موارد زیر باشند:
containsText

object ( SubstringMatchCriteria )

در صورت تنظیم، این درخواست تمام شکل‌هایی را که حاوی متن داده شده هستند، جایگزین می‌کند.

فیلد یونیونی image_source . نوع منبع تصویر. image_source فقط می‌تواند یکی از موارد زیر باشد:
imageUrl

string

آدرس اینترنتی تصویر.

تصویر یک بار در زمان درج دریافت می‌شود و یک کپی برای نمایش در داخل ارائه ذخیره می‌شود. حجم تصاویر باید کمتر از ۵۰ مگابایت باشد، نمی‌تواند از ۲۵ مگاپیکسل بیشتر باشد و باید در یکی از قالب‌های PNG، JPEG یا GIF باشد.

URL ارائه شده می‌تواند حداکثر ۲ کیلوبایت طول داشته باشد. خود URL به همراه تصویر ذخیره می‌شود و از طریق فیلد Image.source_url نمایش داده می‌شود.

روش جایگزینی

روش جایگزین کردن.

انوم‌ها
CENTER_INSIDE تصویر را مقیاس‌بندی و مرکز می‌دهد تا در محدوده شکل اصلی قرار گیرد و نسبت ابعاد تصویر را حفظ می‌کند. اندازه رندر شده تصویر ممکن است کوچکتر از اندازه شکل باشد. این روش پیش‌فرض است وقتی که یکی مشخص نشده باشد.
CENTER_CROP تصویر را مقیاس‌بندی و در مرکز قرار می‌دهد تا مرزهای شکل اصلی را پر کند. تصویر را می‌توان برای پر کردن شکل، برش داد. اندازه رندر شده تصویر همان اندازه شکل اصلی خواهد بود.

متد جایگزینی تصویر

روش جایگزینی تصویر

انوم‌ها
IMAGE_REPLACE_METHOD_UNSPECIFIED روش جایگزینی تصویر نامشخص است. این مقدار نباید استفاده شود.
CENTER_INSIDE Scales and centers the image to fit within the bounds of the original shape and maintains the image's aspect ratio. The rendered size of the image may be smaller than the size of the shape. This is the default method when one is not specified.
CENTER_CROP Scales and centers the image to fill the bounds of the original shape. The image may be cropped in order to fill the shape. The rendered size of the image will be the same as the original shape.

DuplicateObjectRequest

Duplicates a slide or page element.

When duplicating a slide, the duplicate slide will be created immediately following the specified slide. When duplicating a page element, the duplicate will be placed on the same page at the same position as the original.

نمایش JSON
{
  "objectId": string,
  "objectIds": {
    string: string,
    ...
  }
}
فیلدها
objectId

string

The ID of the object to duplicate.

objectIds

map (key: string, value: string)

The object being duplicated may contain other objects, for example when duplicating a slide or a group page element. This map defines how the IDs of duplicated objects are generated: the keys are the IDs of the original objects and its values are the IDs that will be assigned to the corresponding duplicate object. The ID of the source object's duplicate may be specified in this map as well, using the same value of the objectId field as a key and the newly desired ID as the value.

All keys must correspond to existing IDs in the presentation. All values must be unique in the presentation and must start with an alphanumeric character or an underscore (matches regex [a-zA-Z0-9_] ); remaining characters may include those as well as a hyphen or colon (matches regex [a-zA-Z0-9_-:] ). The length of the new ID must not be less than 5 or greater than 50.

If any IDs of source objects are omitted from the map, a new random ID will be assigned. If the map is empty or unset, all duplicate objects will receive a new random ID.

UpdateTextStyleRequest

Update the styling of text in a Shape or Table .

نمایش JSON
{
  "objectId": string,
  "cellLocation": {
    object (TableCellLocation)
  },
  "style": {
    object (TextStyle)
  },
  "textRange": {
    object (Range)
  },
  "fields": string
}
فیلدها
objectId

string

The object ID of the shape or table with the text to be styled.

cellLocation

object ( TableCellLocation )

The location of the cell in the table containing the text to style. If objectId refers to a table, cellLocation must have a value. Otherwise, it must not.

style

object ( TextStyle )

The style(s) to set on the text.

If the value for a particular style matches that of the parent, that style will be set to inherit.

Certain text style changes may cause other changes meant to mirror the behavior of the Slides editor. See the documentation of TextStyle for more information.

textRange

object ( Range )

The range of text to style.

The range may be extended to include adjacent newlines.

If the range fully contains a paragraph belonging to a list, the paragraph's bullet is also updated with the matching text style.

fields

string ( FieldMask format)

The fields that should be updated.

At least one field must be specified. The root style is implied and should not be specified. A single "*" can be used as short-hand for listing every field.

For example, to update the text style to bold, set fields to "bold" .

To reset a property to its default value, include its field name in the field mask but leave the field itself unset.

ReplaceAllShapesWithSheetsChartRequest

Replaces all shapes that match the given criteria with the provided Google Sheets chart. The chart will be scaled and centered to fit within the bounds of the original shape.

NOTE: Replacing shapes with a chart requires at least one of the spreadsheets.readonly, spreadsheets, drive.readonly, or drive OAuth scopes.

نمایش JSON
{
  "containsText": {
    object (SubstringMatchCriteria)
  },
  "spreadsheetId": string,
  "chartId": integer,
  "linkingMode": enum (LinkingMode),
  "pageObjectIds": [
    string
  ]
}
فیلدها
containsText

object ( SubstringMatchCriteria )

The criteria that the shapes must match in order to be replaced. The request will replace all of the shapes that contain the given text.

spreadsheetId

string

The ID of the Google Sheets spreadsheet that contains the chart.

chartId

integer

The ID of the specific chart in the Google Sheets spreadsheet.

linkingMode

enum ( LinkingMode )

The mode with which the chart is linked to the source spreadsheet. When not specified, the chart will be an image that is not linked.

pageObjectIds[]

string

If non-empty, limits the matches to page elements only on the given pages.

Returns a 400 bad request error if given the page object ID of a notes page or a notes master , or if a page with that object ID doesn't exist in the presentation.

LinkingMode

The mode with which the chart is linked to the source spreadsheet.

انوم‌ها
NOT_LINKED_IMAGE The chart is not associated with the source spreadsheet and cannot be updated. A chart that is not linked will be inserted as an image.
LINKED Linking the chart allows it to be updated, and other collaborators will see a link to the spreadsheet.

DeleteParagraphBulletsRequest

Deletes bullets from all of the paragraphs that overlap with the given text index range .

The nesting level of each paragraph will be visually preserved by adding indent to the start of the corresponding paragraph.

نمایش JSON
{
  "objectId": string,
  "cellLocation": {
    object (TableCellLocation)
  },
  "textRange": {
    object (Range)
  }
}
فیلدها
objectId

string

The object ID of the shape or table containing the text to delete bullets from.

cellLocation

object ( TableCellLocation )

The optional table cell location if the text to be modified is in a table cell. If present, the objectId must refer to a table.

textRange

object ( Range )

The range of text to delete bullets from, based on TextElement indexes.

UpdateParagraphStyleRequest

Updates the styling for all of the paragraphs within a Shape or Table that overlap with the given text index range.

نمایش JSON
{
  "objectId": string,
  "cellLocation": {
    object (TableCellLocation)
  },
  "style": {
    object (ParagraphStyle)
  },
  "textRange": {
    object (Range)
  },
  "fields": string
}
فیلدها
objectId

string

The object ID of the shape or table with the text to be styled.

cellLocation

object ( TableCellLocation )

The location of the cell in the table containing the paragraph(s) to style. If objectId refers to a table, cellLocation must have a value. Otherwise, it must not.

style

object ( ParagraphStyle )

The paragraph's style.

textRange

object ( Range )

The range of text containing the paragraph(s) to style.

fields

string ( FieldMask format)

The fields that should be updated.

At least one field must be specified. The root style is implied and should not be specified. A single "*" can be used as short-hand for listing every field.

For example, to update the paragraph alignment, set fields to "alignment" .

To reset a property to its default value, include its field name in the field mask but leave the field itself unset.

UpdateTableBorderPropertiesRequest

Updates the properties of the table borders in a Table .

نمایش JSON
{
  "objectId": string,
  "tableRange": {
    object (TableRange)
  },
  "borderPosition": enum (BorderPosition),
  "tableBorderProperties": {
    object (TableBorderProperties)
  },
  "fields": string
}
فیلدها
objectId

string

The object ID of the table.

tableRange

object ( TableRange )

The table range representing the subset of the table to which the updates are applied. If a table range is not specified, the updates will apply to the entire table.

borderPosition

enum ( BorderPosition )

The border position in the table range the updates should apply to. If a border position is not specified, the updates will apply to all borders in the table range.

tableBorderProperties

object ( TableBorderProperties )

The table border properties to update.

fields

string ( FieldMask format)

The fields that should be updated.

At least one field must be specified. The root tableBorderProperties is implied and should not be specified. A single "*" can be used as short-hand for listing every field.

For example to update the table border solid fill color, set fields to "tableBorderFill.solidFill.color" .

To reset a property to its default value, include its field name in the field mask but leave the field itself unset.

BorderPosition

The table border position.

انوم‌ها
ALL All borders in the range.
BOTTOM Borders at the bottom of the range.
INNER Borders on the inside of the range.
INNER_HORIZONTAL Horizontal borders on the inside of the range.
INNER_VERTICAL Vertical borders on the inside of the range.
LEFT Borders at the left of the range.
OUTER Borders along the outside of the range.
RIGHT Borders at the right of the range.
TOP Borders at the top of the range.

UpdateTableColumnPropertiesRequest

Updates the properties of a Table column.

نمایش JSON
{
  "objectId": string,
  "columnIndices": [
    integer
  ],
  "tableColumnProperties": {
    object (TableColumnProperties)
  },
  "fields": string
}
فیلدها
objectId

string

The object ID of the table.

columnIndices[]

integer

The list of zero-based indices specifying which columns to update. If no indices are provided, all columns in the table will be updated.

tableColumnProperties

object ( TableColumnProperties )

The table column properties to update.

If the value of tableColumnProperties#columnWidth in the request is less than 406,400 EMU (32 points), a 400 bad request error is returned.

fields

string ( FieldMask format)

The fields that should be updated.

At least one field must be specified. The root tableColumnProperties is implied and should not be specified. A single "*" can be used as short-hand for listing every field.

For example to update the column width, set fields to "columnWidth" .

If '"columnWidth"' is included in the field mask but the property is left unset, the column width will default to 406,400 EMU (32 points).

UpdateTableRowPropertiesRequest

Updates the properties of a Table row.

نمایش JSON
{
  "objectId": string,
  "rowIndices": [
    integer
  ],
  "tableRowProperties": {
    object (TableRowProperties)
  },
  "fields": string
}
فیلدها
objectId

string

The object ID of the table.

rowIndices[]

integer

The list of zero-based indices specifying which rows to update. If no indices are provided, all rows in the table will be updated.

tableRowProperties

object ( TableRowProperties )

The table row properties to update.

fields

string ( FieldMask format)

The fields that should be updated.

At least one field must be specified. The root tableRowProperties is implied and should not be specified. A single "*" can be used as short-hand for listing every field.

For example to update the minimum row height, set fields to "minRowHeight" .

If '"minRowHeight"' is included in the field mask but the property is left unset, the minimum row height will default to 0.

MergeTableCellsRequest

Merges cells in a Table .

نمایش JSON
{
  "objectId": string,
  "tableRange": {
    object (TableRange)
  }
}
فیلدها
objectId

string

The object ID of the table.

tableRange

object ( TableRange )

The table range specifying which cells of the table to merge.

Any text in the cells being merged will be concatenated and stored in the upper-left ("head") cell of the range. If the range is non-rectangular (which can occur in some cases where the range covers cells that are already merged), a 400 bad request error is returned.

UnmergeTableCellsRequest

Unmerges cells in a Table .

نمایش JSON
{
  "objectId": string,
  "tableRange": {
    object (TableRange)
  }
}
فیلدها
objectId

string

The object ID of the table.

tableRange

object ( TableRange )

The table range specifying which cells of the table to unmerge.

All merged cells in this range will be unmerged, and cells that are already unmerged will not be affected. If the range has no merged cells, the request will do nothing. If there is text in any of the merged cells, the text will remain in the upper-left ("head") cell of the resulting block of unmerged cells.

GroupObjectsRequest

Groups objects to create an object group. For example, groups PageElements to create a Group on the same page as all the children.

نمایش JSON
{
  "groupObjectId": string,
  "childrenObjectIds": [
    string
  ]
}
فیلدها
groupObjectId

string

A user-supplied object ID for the group to be created.

If you specify an ID, it must be unique among all pages and page elements in the presentation. The ID must start with an alphanumeric character or an underscore (matches regex [a-zA-Z0-9_] ); remaining characters may include those as well as a hyphen or colon (matches regex [a-zA-Z0-9_-:] ). The length of the ID must not be less than 5 or greater than 50.

If you don't specify an ID, a unique one is generated.

childrenObjectIds[]

string

The object IDs of the objects to group.

Only page elements can be grouped. There should be at least two page elements on the same page that are not already in another group. Some page elements, such as videos , tables and placeholders cannot be grouped.

UngroupObjectsRequest

Ungroups objects, such as groups .

نمایش JSON
{
  "objectIds": [
    string
  ]
}
فیلدها
objectIds[]

string

The object IDs of the objects to ungroup.

Only groups that are not inside other groups can be ungrouped. All the groups should be on the same page. The group itself is deleted. The visual sizes and positions of all the children are preserved.

UpdatePageElementAltTextRequest

Updates the alt text title and/or description of a page element .

نمایش JSON
{
  "objectId": string,
  "title": string,
  "description": string
}
فیلدها
objectId

string

The object ID of the page element the updates are applied to.

title

string

The updated alt text title of the page element. If unset the existing value will be maintained. The title is exposed to screen readers and other accessibility interfaces. Only use human readable values related to the content of the page element.

description

string

The updated alt text description of the page element. If unset the existing value will be maintained. The description is exposed to screen readers and other accessibility interfaces. Only use human readable values related to the content of the page element.

ReplaceImageRequest

Replaces an existing image with a new image.

Replacing an image removes some image effects from the existing image.

نمایش 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

The ID of the existing image that will be replaced. The ID can be retrieved from the response of a get request.

imageReplaceMethod

enum ( ImageReplaceMethod )

The replacement method.

Union field image_source . The kind of image source. image_source can be only one of the following:
url

string

The image URL.

The image is fetched once at insertion time and a copy is stored for display inside the presentation. Images must be less than 50MB, cannot exceed 25 megapixels, and must be in PNG, JPEG, or GIF format.

The provided URL can't surpass 2 KB in length. The URL is saved with the image, and exposed through the Image.source_url field.

UpdateSlidePropertiesRequest

Updates the properties of a Slide.

نمایش JSON
{
  "objectId": string,
  "slideProperties": {
    object (SlideProperties)
  },
  "fields": string
}
فیلدها
objectId

string

The object ID of the slide the update is applied to.

slideProperties

object ( SlideProperties )

The slide properties to update.

fields

string ( FieldMask format)

The fields that should be updated.

At least one field must be specified. The root 'slideProperties' is implied and should not be specified. A single "*" can be used as short-hand for listing every field.

For example to update whether a slide is skipped, set fields to "isSkipped" .

To reset a property to its default value, include its field name in the field mask but leave the field itself unset.

UpdatePageElementsZOrderRequest

Updates the Z-order of page elements. Z-order is an ordering of the elements on the page from back to front. The page element in the front may cover the elements that are behind it.

نمایش JSON
{
  "pageElementObjectIds": [
    string
  ],
  "operation": enum (ZOrderOperation)
}
فیلدها
pageElementObjectIds[]

string

The object IDs of the page elements to update.

All the page elements must be on the same page and must not be grouped.

operation

enum ( ZOrderOperation )

The Z-order operation to apply on the page elements.

When applying the operation on multiple page elements, the relative Z-orders within these page elements before the operation is maintained.

ZOrderOperation

The operation to update a page element's Z-order.

انوم‌ها
Z_ORDER_OPERATION_UNSPECIFIED Unspecified operation.
BRING_TO_FRONT Brings the page elements to the front of the page.
BRING_FORWARD Brings the page elements forward on the page by one element relative to the forwardmost one in the specified page elements.
SEND_BACKWARD Sends the page elements backward on the page by one element relative to the furthest behind one in the specified page elements.
SEND_TO_BACK Sends the page elements to the back of the page.

UpdateLineCategoryRequest

Updates the category of a line .

نمایش JSON
{
  "objectId": string,
  "lineCategory": enum (LineCategory)
}
فیلدها
objectId

string

The object ID of the line the update is applied to.

Only a line with a category indicating it is a "connector" can be updated.

The line may be rerouted after updating its category.

lineCategory

enum ( LineCategory )

The line category to update to.

The exact line type is determined based on the category to update to and how it's routed to connect to other page elements.

RerouteLineRequest

Reroutes a line such that it's connected at the two closest connection sites on the connected page elements.

نمایش JSON
{
  "objectId": string
}
فیلدها
objectId

string

The object ID of the line to reroute.

Only a line with a category indicating it is a "connector" can be rerouted. The start and end connections of the line must be on different page elements.