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 را تازه می‌کند.

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

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

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

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

insertionIndex

integer

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

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

slideLayoutReference

object ( LayoutReference )

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

  • استاد شاخص اسلاید قبلی.
  • اگر InsertionIndex صفر باشد، مستر اسلاید اول.
  • استاد اول در ارائه، در صورت عدم وجود اسلاید.

اگر LayoutReference در اصلی فعلی یافت نشد، یک خطای درخواست بد 400 برگردانده می شود.

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

placeholderIdMappings[]

object ( LayoutPlaceholderIdMapping )

یک لیست اختیاری از نگاشت شناسه شیء از placeholder (ها) در طرح به مکان‌هایی که در اسلاید از طرح‌بندی مشخص شده ایجاد می‌شوند. فقط زمانی قابل استفاده است که 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

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

از پیش تعریف شده Layout

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

Enums
PREDEFINED_LAYOUT_UNSPECIFIED چیدمان نامشخص
BLANK طرح‌بندی خالی، بدون مکان‌نما.
CAPTION_ONLY چیدمان با عنوان در پایین.
TITLE چیدمان با عنوان و زیرنویس.
TITLE_AND_BODY چیدمان با عنوان و بدنه.
TITLE_AND_TWO_COLUMNS طرح بندی با عنوان و دو ستون.
TITLE_ONLY طرح بندی فقط با عنوان.
SECTION_HEADER طرح بندی با عنوان بخش.
SECTION_TITLE_AND_DESCRIPTION طرح بندی با عنوان و زیرنویس در یک طرف و توضیحات در طرف دیگر.
ONE_COLUMN_TEXT طرح بندی با یک عنوان و یک بدنه، مرتب شده در یک ستون.
MAIN_POINT چیدمان با یک نکته اصلی.
BIG_NUMBER چیدمان با عنوان شماره بزرگ.

LayoutPlaceholderIdMapping

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

نمایندگی JSON
{
  "objectId": string,

  // Union field kind can be only one of the following:
  "layoutPlaceholder": {
    object (Placeholder)
  },
  "layoutPlaceholderObjectId": string
  // End of list of possible types for union field kind.
}
زمینه های
objectId

string

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

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

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

kind میدان اتحادیه . نوعی برای شناسایی مکان نگهدار در یک طرح. kind می تواند تنها یکی از موارد زیر باشد:
layoutPlaceholder

object ( Placeholder )

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

layoutPlaceholderObjectId

string

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

CreateShapeRequest

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

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

string

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

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

elementProperties

object ( PageElementProperties )

ویژگی های عنصر برای شکل

shapeType

enum ( Type )

نوع شکل

PageElement Properties

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

توجه: هنگامی که در ابتدا یک 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

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

اگر یک شناسه مشخص کنید، باید در بین تمام صفحات و عناصر صفحه در ارائه منحصر به فرد باشد. شناسه باید با یک نویسه الفبای عددی یا یک زیرخط شروع شود (منطبق با regex [a-zA-Z0-9_] ). نویسه‌های باقی‌مانده ممکن است شامل آن‌ها و همچنین یک خط فاصله یا دو نقطه باشند (با regex [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 )

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

text

string

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

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

سبک های متن برای متن درج شده به طور خودکار تعیین می شود و به طور کلی سبک متن همسایه را حفظ می کند. در بیشتر موارد، متن به TextRun که در نمایه درج وجود دارد اضافه می شود.

برخی از نویسه‌های کنترلی (U+0000-U+0008، U+000C-U+001F) و نویسه‌های منطقه استفاده خصوصی هواپیمای چند زبانه پایه یونیکد (U+E000-U+F8FF) از متن درج‌شده حذف می‌شوند.

insertionIndex

integer

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

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

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 در هر درخواست

حذف TableRowRequest

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

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

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

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

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

object ( SubstringMatchCriteria )

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

معیارهای SubstringMatch

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

نمایندگی JSON
{
  "text": string,
  "matchCase": boolean
}
زمینه های
text

string

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

matchCase

boolean

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

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

DeleteObjectRequest

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

نمایندگی JSON
{
  "objectId": string
}
زمینه های
objectId

string

شناسه شی صفحه یا عنصر صفحه برای حذف.

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

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

UpdatePageElementTransformRequest

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

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

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

string

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

transform

object ( AffineTransform )

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

applyMode

enum ( ApplyMode )

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

ApplyMode

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

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

UpdateSlidesPositionRequest

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

نمایندگی JSON
{
  "slideObjectIds": [
    string
  ],
  "insertionIndex": integer
}
زمینه های
slideObjectIds[]

string

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

insertionIndex

integer

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

DeleteTextRequest

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

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

string

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

cellLocation

object ( TableCellLocation )

مکان اختیاری سلول جدول در صورتی که متن از سلول جدول حذف شود. در صورت وجود، objectId باید به یک جدول ارجاع دهد.

textRange

object ( Range )

محدوده متن برای حذف، بر اساس شاخص های TextElement .

همیشه یک کاراکتر خط جدید ضمنی در انتهای متن یک شکل یا سلول جدول وجود دارد که نمی توان آن را حذف کرد. Range.Type.ALL از کران‌های صحیح استفاده می‌کند، اما هنگام تعیین محدوده‌های صریح برای انواع محدوده FROM_START_INDEX و FIXED_RANGE باید دقت شود. به عنوان مثال، اگر متن "ABC" و به دنبال آن یک خط جدید ضمنی باشد، حداکثر مقدار برای textRange.start_index 2 و برای textRange.end_index 3 است.

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

محدوده هایی که فقط یک واحد کد از یک جفت جایگزین را شامل می شود تا هر دو واحد کد را شامل شود.

دامنه

محدوده پیوسته ای از یک مجموعه نمایه شده، مانند کاراکترهای متن را مشخص می کند.

نمایندگی JSON
{
  "startIndex": integer,
  "endIndex": integer,
  "type": enum (Type)
}
زمینه های
startIndex

integer

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

endIndex

integer

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

type

enum ( Type )

نوع محدوده.

تایپ کنید

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

Enums
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

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

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

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

elementProperties

object ( PageElementProperties )

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

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

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

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

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

string

آدرس تصویر.

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

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

CreateVideoRequest

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

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

نمایندگی JSON
{
  "objectId": string,
  "elementProperties": {
    object (PageElementProperties)
  },
  "source": enum (Source),
  "id": string
}
زمینه های
objectId

string

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

اگر یک شناسه مشخص کنید، باید در بین تمام صفحات و عناصر صفحه در ارائه منحصر به فرد باشد. شناسه باید با یک نویسه الفبای عددی یا یک زیرخط شروع شود (منطبق با regex [a-zA-Z0-9_] ). نویسه‌های باقی‌مانده ممکن است شامل آن‌ها و همچنین یک خط فاصله یا دو نقطه باشند (با regex [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 جاسازی شده ایجاد می کند.

توجه: ایجاد نمودار حداقل به یکی از دامنه‌های 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

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

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

chartId

integer

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

linkingMode

enum ( LinkingMode )

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

LinkingMode

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

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

CreateLineRequest

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

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

string

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

اگر یک شناسه مشخص کنید، باید در بین تمام صفحات و عناصر صفحه در ارائه منحصر به فرد باشد. شناسه باید با یک نویسه الفبای عددی یا یک زیرخط شروع شود (منطبق با regex [a-zA-Z0-9_] ). نویسه‌های باقی‌مانده ممکن است شامل آن‌ها و همچنین یک خط فاصله یا دو نقطه باشند (با regex [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 استفاده می شود.

دسته بندی

دسته بندی خطوط

Enums
STRAIGHT کانکتورهای مستقیم، از جمله کانکتور مستقیم 1. هنگامی که یکی از آنها مشخص نشده باشد، دسته پیش فرض است.
BENT کانکتورهای خمیده، از جمله کانکتور خمیده 2 تا 5.
CURVED کانکتورهای منحنی، از جمله کانکتور منحنی 2 تا 5.

RefreshSheetsChartRequest

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

توجه: برای بازخوانی نمودارها حداقل به یکی از صفحات گسترده، صفحات گسترده، drive.readonly یا درایو OAuth scope نیاز است.

نمایندگی 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" تنظیم کنید.

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

محدوده جدول

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

توجه به این نکته مهم است که سلول های مشخص شده توسط یک محدوده جدول لزوما یک مستطیل تشکیل نمی دهند. برای مثال، فرض کنید یک جدول 3×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)

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

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

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

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

CreateParagraphBulletsRequest

برای همه پاراگراف هایی که با محدوده فهرست متنی داده شده همپوشانی دارند، گلوله ایجاد می کند.

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

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

نمایندگی JSON
{
  "objectId": string,
  "cellLocation": {
    object (TableCellLocation)
  },
  "textRange": {
    object (Range)
  },
  "bulletPreset": enum (BulletGlyphPreset)
}
زمینه های
objectId

string

شناسه شی شکل یا جدول حاوی متن برای افزودن گلوله به آن.

cellLocation

object ( TableCellLocation )

مکان اختیاری سلول جدول اگر متنی که باید اصلاح شود در یک سلول جدول است. در صورت وجود، objectId باید به یک جدول ارجاع دهد.

textRange

object ( Range )

محدوده متنی که باید پیش تنظیم های گلوله را بر اساس شاخص های TextElement اعمال کرد.

bulletPreset

enum ( BulletGlyphPreset )

انواع گلیف گلوله مورد استفاده. پیش‌فرض BULLET_DISC_CIRCLE_SQUARE از پیش تنظیم شده است.

BulletGlyphPreset

الگوهای از پیش تعیین شده حروف گلوله برای لیست ها در متن.

این الگوها از این نوع گلوله ها استفاده می کنند:

  • ARROW : یک فلش، مربوط به نقطه کد Unicode U+2794
  • ARROW3D : یک فلش با سایه زنی سه بعدی، مربوط به نقطه کد Unicode U+27a2
  • CHECKBOX : یک مربع توخالی، مربوط به نقطه کد Unicode U+274f
  • CIRCLE : یک دایره توخالی، مربوط به نقطه کد Unicode U+25cb
  • DIAMOND : الماس جامد، مربوط به نقطه کد Unicode U+25c6
  • DIAMONDX : الماسی با x، مربوط به نقطه کد Unicode U+2756
  • HOLLOWDIAMOND : الماس توخالی، مربوط به نقطه کد Unicode U+25c7
  • DISC : یک دایره جامد، مربوط به نقطه کد Unicode U+25cf
  • SQUARE : یک مربع جامد، مربوط به نقطه کد Unicode U+25a0
  • STAR : یک ستاره، مربوط به نقطه کد Unicode U+2605
  • ALPHA : یک حرف کوچک، مانند "a"، "b" یا "c".
  • UPPERALPHA : یک حرف بزرگ، مانند "A"، "B" یا "C".
  • DIGIT : عددی مانند «1»، «2» یا «3».
  • ZERODIGIT : عددی که در آن اعداد تک رقمی با یک پیشوند صفر مانند '01'، '02' یا '03' قرار می گیرند. اعدادی که بیش از یک رقم دارند پیشوند صفر نیستند.
  • ROMAN : یک عدد رومی کوچک، مانند "i"، "ii" یا "iii".
  • UPPERROMAN : یک عدد رومی بزرگ، مانند "I"، "II" یا "III".
  • LEFTTRIANGLE : مثلثی به سمت چپ، مربوط به نقطه کد Unicode U+25c4
Enums
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 سطح تودرتوی فهرست اول، به دنبال نقطه.

Replace AllShapesWithImageRequest

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

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

نمایندگی 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 داده شود، یا اگر صفحه ای با آن شناسه شی در ارائه وجود نداشته باشد، یک خطای درخواست بد 400 را برمی گرداند.

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

object ( SubstringMatchCriteria )

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

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

string

آدرس تصویر.

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

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

ReplaceMethod

روش جایگزینی

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

ImageReplaceMethod

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

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

DuplicateObjectRequest

یک اسلاید یا عنصر صفحه را کپی می کند.

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.

Enums
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.

Enums
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.

Enums
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.