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

همه نمونه های متنی را که با یک معیار مطابقت دارند با