درخواست کنید
یک به روز رسانی واحد برای اعمال بر یک سند.
نمایندگی JSON |
---|
{ // Union field |
فیلدها | |
---|---|
request میدانی اتحادیه درخواست خاص برای درخواست. دقیقاً یک فیلد لازم است. request فقط می تواند یکی از موارد زیر باشد: | |
replaceAllText | همه نمونه های متن مشخص شده را جایگزین می کند. |
insertText | متن را در مکان مشخص شده درج می کند. |
updateTextStyle | سبک متن را در محدوده مشخص شده به روز می کند. |
createParagraphBullets | برای پاراگراف ها گلوله ایجاد می کند. |
deleteParagraphBullets | گلوله ها را از پاراگراف ها حذف می کند. |
createNamedRange | یک محدوده با نام ایجاد می کند. |
deleteNamedRange | محدوده نامگذاری شده را حذف می کند. |
updateParagraphStyle | سبک پاراگراف را در محدوده مشخص شده به روز می کند. |
deleteContentRange | محتوا را از سند حذف می کند. |
insertInlineImage | یک تصویر درون خطی را در مکان مشخص شده درج می کند. |
insertTable | جدولی را در محل مشخص شده درج می کند. |
insertTableRow | یک ردیف خالی را در جدول درج می کند. |
insertTableColumn | یک ستون خالی را در جدول درج می کند. |
deleteTableRow | یک ردیف را از جدول حذف می کند. |
deleteTableColumn | یک ستون را از جدول حذف می کند. |
insertPageBreak | شکست صفحه را در مکان مشخص شده درج می کند. |
deletePositionedObject | یک شی موقعیت یافته را از سند حذف می کند. |
updateTableColumnProperties | ویژگی های ستون ها را در جدول به روز می کند. |
updateTableCellStyle | سبک سلول های جدول را به روز می کند. |
updateTableRowStyle | سبک ردیف را در جدول به روز می کند. |
replaceImage | یک تصویر را در سند جایگزین می کند. |
updateDocumentStyle | سبک سند را به روز می کند. |
mergeTableCells | سلول ها را در جدول ادغام می کند. |
unmergeTableCells | سلول ها را در جدول از هم ادغام می کند. |
createHeader | یک هدر ایجاد می کند. |
createFooter | پاورقی ایجاد می کند. |
createFootnote | پاورقی ایجاد می کند. |
replaceNamedRangeContent | محتوا را در یک محدوده نامگذاری شده جایگزین می کند. |
updateSectionStyle | سبک بخش محدوده مشخص شده را به روز می کند. |
insertSectionBreak | یک شکست بخش را در مکان مشخص شده درج می کند. |
deleteHeader | هدر را از سند حذف می کند. |
deleteFooter | پاورقی را از سند حذف می کند. |
pinTableHeaderRows | تعداد ردیف های سرصفحه پین شده در جدول را به روز می کند. |
ReplaceAllTextRequest
همه نمونه های متنی را که با یک معیار مطابقت دارند با replace text
جایگزین می کند.
نمایندگی JSON |
---|
{ "replaceText": string, "tabsCriteria": { object ( |
فیلدها | |
---|---|
replaceText | متنی که جایگزین متن منطبق می شود. |
tabsCriteria | اختیاری. معیارهایی که برای تعیین اینکه جایگزینی در کدام زبانه ها استفاده می شود. در صورت حذف، جایگزینی برای همه برگه ها اعمال می شود. در یک سند حاوی یک برگه:
در یک سند حاوی چندین برگه:
|
criteria میدان اتحادیه معیارهای مورد استفاده برای مطابقت با متن جایگزین. criteria فقط می توانند یکی از موارد زیر باشند: | |
containsText | متن مطابق با این زیررشته را در سند پیدا می کند. |
معیارهای SubstringMatch
معیاری که با رشته خاصی از متن در سند مطابقت دارد.
نمایندگی JSON |
---|
{ "text": string, "matchCase": boolean, "searchByRegex": boolean } |
فیلدها | |
---|---|
text | متن مورد جستجو در سند. |
matchCase | نشان می دهد که آیا جستجو باید به حروف مورد توجه باشد یا خیر:
|
searchByRegex | اختیاری. درست است اگر مقدار find باید به عنوان یک عبارت منظم در نظر گرفته شود. از هر گونه بک اسلش در الگو باید فرار کرد.
|
Tabs معیارها
معیاری که مشخص می کند یک درخواست در کدام برگه ها اجرا می شود.
نمایندگی JSON |
---|
{ "tabIds": [ string ] } |
فیلدها | |
---|---|
tabIds[] | لیست شناسه های برگه ای که درخواست در آنها اجرا می شود. |
InsertTextRequest
متن را در مکان مشخص شده درج می کند.
نمایندگی JSON |
---|
{ "text": string, // Union field |
فیلدها | |
---|---|
text | متنی که قرار است درج شود. درج یک کاراکتر خط جدید به طور ضمنی یک سبک های متن برای متن درج شده به طور خودکار تعیین می شود و به طور کلی سبک متن همسایه را حفظ می کند. در بیشتر موارد، سبک متن برای متن درج شده بلافاصله قبل از نمایه درج با متن مطابقت دارد. برخی از نویسههای کنترلی (U+0000-U+0008، U+000C-U+001F) و نویسههای منطقه استفاده خصوصی هواپیمای چند زبانه پایه یونیکد (U+E000-U+F8FF) از متن درجشده حذف میشوند. |
فیلد اتحادیه insertion_location . مکانی که متن در آن درج خواهد شد. insertion_location تنها می تواند یکی از موارد زیر باشد: | |
location | متن را در یک نمایه خاص در سند درج می کند. متن باید در داخل محدوده یک |
endOfSegmentLocation | متن را در انتهای سرصفحه، پاورقی، پاورقی یا بدنه سند درج می کند. |
مکان
یک مکان خاص در سند
نمایندگی JSON |
---|
{ "segmentId": string, "index": integer, "tabId": string } |
فیلدها | |
---|---|
segmentId | شناسه سرصفحه، پاورقی یا پاورقی محل در آن است. شناسه بخش خالی نشان دهنده بدنه سند است. |
index | شاخص مبتنی بر صفر، در واحد کد UTF-16. شاخص نسبت به ابتدای بخش مشخص شده توسط |
tabId | برگه ای که مکان در آن قرار دارد. در صورت حذف، درخواست به اولین تب اعمال می شود. در یک سند حاوی یک برگه:
در یک سند حاوی چندین برگه:
|
EndOfSegmentLocation
مکان در انتهای متن، سرصفحه، پاورقی یا پاورقی. مکان بلافاصله قبل از آخرین خط جدید در بخش سند است.
نمایندگی JSON |
---|
{ "segmentId": string, "tabId": string } |
فیلدها | |
---|---|
segmentId | شناسه سرصفحه، پاورقی یا پاورقی محل در آن است. شناسه بخش خالی نشان دهنده بدنه سند است. |
tabId | برگه ای که مکان در آن قرار دارد. در صورت حذف، درخواست به اولین تب اعمال می شود. در یک سند حاوی یک برگه:
در یک سند حاوی چندین برگه:
|
UpdateTextStyleRequest
استایل متن را به روز کنید.
فیلدها | |
---|---|
textStyle | سبک هایی که باید روی متن تنظیم شوند. اگر مقدار یک سبک خاص با مقدار والد مطابقت داشته باشد، آن سبک به ارث بری تنظیم می شود. برخی از تغییرات سبک متن ممکن است باعث ایجاد تغییرات دیگری به منظور منعکس کردن رفتار ویرایشگر Docs شود. برای اطلاعات بیشتر به مستندات |
fields | فیلدهایی که باید به روز شوند. حداقل یک فیلد باید مشخص شود. root برای مثال، برای بهروزرسانی سبک متن به پررنگ، برای بازنشانی یک ویژگی به مقدار پیشفرض، نام فیلد آن را در ماسک فیلد وارد کنید اما خود فیلد را تنظیم نشده رها کنید. |
فیلد اتحادیه insertion_location . نوع محدوده مورد استفاده که در آن سبک متن به روز می شود. insertion_location تنها می تواند یکی از موارد زیر باشد: | |
range | محدوده متن به سبک. دامنه ممکن است برای شامل خطوط جدید مجاور گسترش یابد. اگر محدوده به طور کامل شامل یک پاراگراف متعلق به یک لیست باشد، گلوله پاراگراف نیز با سبک متن منطبق به روز می شود. محدوده ها را نمی توان در یک UpdateTextStyleRequest نسبی درج کرد. |
CreateParagraphBulletsRequest
گلوله هایی را برای همه پاراگراف هایی که با محدوده داده شده همپوشانی دارند ایجاد می کند.
سطح تودرتوی هر پاراگراف با شمارش زبانه های پیشرو در مقابل هر پاراگراف تعیین می شود. برای جلوگیری از فضای اضافی بین گلوله و پاراگراف مربوطه، این زبانه های پیشرو با این درخواست حذف می شوند. این ممکن است شاخص های بخش هایی از متن را تغییر دهد.
اگر پاراگراف بلافاصله قبل از بهروزرسانی پاراگرافها در فهرستی با پیش تنظیم منطبق باشد، پاراگرافهایی که بهروزرسانی میشوند به فهرست قبلی اضافه میشوند.
نمایندگی JSON |
---|
{ "range": { object ( |
فیلدها | |
---|---|
range | محدوده ای که باید پیش تنظیم گلوله روی آن اعمال شود. |
bulletPreset | انواع گلیف گلوله مورد استفاده. |
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". -
DECIMAL
: عددی مانند "1"، "2" یا "3". -
ZERODECIMAL
: عددی که در آن اعداد تک رقمی با یک پیشوند صفر مانند '01'، '02' یا '03' قرار می گیرند. اعدادی که بیش از یک رقم دارند پیشوند صفر نیستند. -
ROMAN
: یک عدد رومی کوچک، مانند "i"، "ii" یا "iii". -
UPPERROMAN
: یک عدد رومی بزرگ، مانند "I"، "II" یا "III". -
LEFTTRIANGLE
: مثلثی به سمت چپ، مربوط به نقطه کد Unicode U+25c4
Enums | |
---|---|
BULLET_GLYPH_PRESET_UNSPECIFIED | علامت گلوله از پیش تنظیم نشده است. |
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_DECIMAL_ALPHA_ROMAN | یک فهرست شمارهدار با علامتهای عددی DECIMAL ، ALPHA و ROMAN برای 3 سطح تودرتوی فهرست اول، به دنبال نقطه. |
NUMBERED_DECIMAL_ALPHA_ROMAN_PARENS | فهرستی شمارهدار با علامتهای عددی DECIMAL ، ALPHA و ROMAN برای 3 سطح تودرتوی فهرست اول، به دنبال پرانتز. |
NUMBERED_DECIMAL_NESTED | فهرستی شمارهدار با علامتهای عددی DECIMAL که با نقطه از هم جدا شدهاند، که در آن هر سطح تودرتو از علامت علامت قبلی سطح تودرتو به عنوان پیشوند استفاده میکند. به عنوان مثال: «1.»، «1.1.»، «2.»، «2.2.». |
NUMBERED_UPPERALPHA_ALPHA_ROMAN | فهرستی شمارهدار با علامتهای عددی UPPERALPHA ، ALPHA و ROMAN برای 3 سطح تودرتوی فهرست اول، به دنبال نقطهها. |
NUMBERED_UPPERROMAN_UPPERALPHA_DECIMAL | فهرستی شمارهدار با علامتهای اعداد UPPERROMAN ، UPPERALPHA و DECIMAL برای 3 سطح تودرتوی فهرست اول، به دنبال نقطه. |
NUMBERED_ZERODECIMAL_ALPHA_ROMAN | یک فهرست شمارهدار با علامتهای عددی ZERODECIMAL ، ALPHA و ROMAN برای 3 سطح تودرتوی فهرست اول، به دنبال نقطه. |
DeleteParagraphBulletsRequest
گلوله هایی را از تمام پاراگراف هایی که با محدوده داده شده همپوشانی دارند حذف می کند.
سطح تودرتوی هر پاراگراف با افزودن تورفتگی به ابتدای پاراگراف مربوطه به صورت بصری حفظ می شود.
نمایندگی JSON |
---|
{
"range": {
object ( |
فیلدها | |
---|---|
range | محدوده حذف گلوله ها از. |
CreateNamedRangeRequest
یک NamedRange
با ارجاع به محدوده داده شده ایجاد می کند.
نمایندگی JSON |
---|
{
"name": string,
"range": {
object ( |
فیلدها | |
---|---|
name | نام NamedRange. لازم نیست نام ها منحصر به فرد باشند. نامها باید حداقل 1 کاراکتر و بیش از 256 نویسه داشته باشند که در واحد کد UTF-16 اندازهگیری میشوند. |
range | محدوده ای که نام روی آن اعمال می شود. |
DeleteNamedRangeRequest
NamedRange
را حذف می کند.
نمایندگی JSON |
---|
{ "tabsCriteria": { object ( |
فیلدها | |
---|---|
tabsCriteria | اختیاری. معیارهای مورد استفاده برای تعیین اینکه حذف محدوده باید در کدام برگه(ها) انجام شود. وقتی حذف شود، حذف محدوده برای همه برگه ها اعمال می شود. در یک سند حاوی یک برگه:
در یک سند حاوی چندین برگه:
|
فیلد اتحادیه named_range_reference . مقداری که تعیین می کند کدام محدوده یا محدوده حذف شود. دقیقاً یکی باید تنظیم شود. named_range_reference تنها می تواند یکی از موارد زیر باشد: | |
namedRangeId | شناسه محدوده نامگذاری شده برای حذف. |
name | نام محدوده(های) مورد حذف. همه محدوده های نامگذاری شده با نام داده شده حذف خواهند شد. |
UpdateParagraphStyleRequest
سبک تمام پاراگراف هایی را که با محدوده داده شده همپوشانی دارند، به روز کنید.
نمایندگی JSON |
---|
{ "paragraphStyle": { object ( |
فیلدها | |
---|---|
paragraphStyle | سبک هایی که باید روی پاراگراف ها تنظیم شوند. برخی از تغییرات سبک پاراگراف ممکن است تغییرات دیگری را به منظور منعکس کردن رفتار ویرایشگر Docs ایجاد کند. برای اطلاعات بیشتر به مستندات |
fields | فیلدهایی که باید به روز شوند. حداقل یک فیلد باید مشخص شود. ریشه برای مثال، برای بهروزرسانی ویژگی alignment سبک پاراگراف، برای بازنشانی یک ویژگی به مقدار پیشفرض، نام فیلد آن را در ماسک فیلد وارد کنید اما خود فیلد را تنظیم نشده رها کنید. |
فیلد اتحادیه insertion_location . نوع محدوده مورد استفاده که در آن سبک پاراگراف به روز می شود. insertion_location تنها می تواند یکی از موارد زیر باشد: | |
range | محدوده همپوشانی پاراگراف ها تا سبک. |
DeleteContentRangeRequest
محتوا را از سند حذف می کند.
نمایندگی JSON |
---|
{
"range": {
object ( |
فیلدها | |
---|---|
range | محدوده محتوایی که باید حذف شود. حذف متنی که از مرز پاراگراف عبور می کند ممکن است منجر به تغییراتی در سبک های پاراگراف، لیست ها، اشیاء قرار داده شده و نشانک ها با ادغام دو پاراگراف شود. تلاش برای حذف محدوده های خاص می تواند منجر به ساختار سند نامعتبر شود که در این صورت یک خطای درخواست بد 400 برگردانده می شود. چند نمونه از درخواست های حذف نامعتبر عبارتند از:
|
InsertInlineImageRequest
یک InlineObject
حاوی یک تصویر را در مکان داده شده درج می کند.
نمایندگی JSON |
---|
{ "uri": string, "objectSize": { object ( |
فیلدها | |
---|---|
uri | URI تصویر. تصویر یک بار در زمان درج واکشی می شود و یک کپی برای نمایش در داخل سند ذخیره می شود. اندازه تصاویر باید کمتر از 50 مگابایت باشد، نباید بیش از 25 مگاپیکسل باشد و باید در یکی از فرمتهای PNG، JPEG یا GIF باشند. URI ارائه شده باید در دسترس عموم و حداکثر 2 کیلوبایت باشد. خود URI با تصویر ذخیره می شود و از طریق فیلد |
objectSize | اندازه ای که تصویر باید مانند سند ظاهر شود. این ویژگی اختیاری است و اندازه نهایی تصویر در سند با قوانین زیر تعیین می شود: * اگر عرض و ارتفاع مشخص نشده باشد، اندازه پیش فرض تصویر بر اساس وضوح آن محاسبه می شود. * اگر یک بعد مشخص شده باشد، بعد دیگر برای حفظ نسبت ابعاد تصویر محاسبه می شود. * اگر هم عرض و هم ارتفاع مشخص شده باشد، تصویر با حفظ نسبت ابعاد، مقیاس بندی می شود تا در ابعاد ارائه شده قرار گیرد. |
فیلد اتحادیه insertion_location . مکانی که تصویر در آن درج خواهد شد. insertion_location تنها می تواند یکی از موارد زیر باشد: | |
location | تصویر را در یک نمایه خاص در سند درج می کند. تصویر باید در داخل محدوده یک تصاویر درون خطی را نمی توان در پاورقی یا معادله درج کرد. |
endOfSegmentLocation | متن را در انتهای سرصفحه، پاورقی یا بدنه سند درج می کند. تصاویر درون خطی را نمی توان در پاورقی درج کرد. |
InsertTableRequest
جدولی را در محل مشخص شده درج می کند.
یک کاراکتر خط جدید قبل از جدول درج شده درج می شود.
نمایندگی JSON |
---|
{ "rows": integer, "columns": integer, // Union field |
فیلدها | |
---|---|
rows | تعداد ردیف های جدول |
columns | تعداد ستون های جدول |
فیلد اتحادیه insertion_location . مکانی که جدول در آن درج خواهد شد. insertion_location تنها می تواند یکی از موارد زیر باشد: | |
location | جدول را در یک شاخص مدل خاص درج می کند. یک کاراکتر خط جدید قبل از جدول درج شده درج می شود، بنابراین شاخص شروع جدول در نمایه مکان مشخص شده + 1 خواهد بود. جدول باید در داخل محدوده یک جداول را نمی توان در پاورقی یا معادله درج کرد. |
endOfSegmentLocation | جدول را در انتهای سرصفحه، پاورقی یا بدنه سند درج می کند. یک کاراکتر خط جدید قبل از جدول درج شده درج می شود. جداول را نمی توان در پاورقی درج کرد. |
InsertTableRowRequest
یک ردیف خالی را در جدول درج می کند.
نمایندگی JSON |
---|
{
"tableCellLocation": {
object ( |
فیلدها | |
---|---|
tableCellLocation | محل سلول جدول مرجع که سطرها از آن درج خواهند شد. یک ردیف جدید در بالای (یا پایین) ردیفی که سلول مرجع در آن قرار دارد درج می شود. اگر سلول مرجع یک سلول ادغام شده باشد، یک ردیف جدید در بالا (یا زیر) سلول ادغام شده درج می شود. |
insertBelow | ردیف جدید در زیر محل سلول مرجع درج شود یا خیر.
|
TableCellLocation
مکان یک سلول در یک جدول
نمایندگی JSON |
---|
{
"tableStartLocation": {
object ( |
فیلدها | |
---|---|
tableStartLocation | مکانی که جدول در سند شروع می شود. |
rowIndex | شاخص ردیف مبتنی بر صفر. به عنوان مثال، ردیف دوم جدول دارای شاخص ردیف 1 است. |
columnIndex | شاخص ستون مبتنی بر صفر. به عنوان مثال، ستون دوم جدول دارای شاخص ستون 1 است. |
InsertTableColumnRequest
یک ستون خالی را در جدول درج می کند.
نمایندگی JSON |
---|
{
"tableCellLocation": {
object ( |
فیلدها | |
---|---|
tableCellLocation | محل سلول جدول مرجع که ستون ها از آن درج خواهند شد. یک ستون جدید در سمت چپ (یا راست) ستونی که سلول مرجع در آن قرار دارد درج می شود. اگر سلول مرجع یک سلول ادغام شده باشد، یک ستون جدید در سمت چپ (یا راست) سلول ادغام شده درج می شود. |
insertRight | ستون جدید در سمت راست محل سلول مرجع درج شود یا خیر.
|
حذف TableRowRequest
یک ردیف را از جدول حذف می کند.
نمایندگی JSON |
---|
{
"tableCellLocation": {
object ( |
فیلدها | |
---|---|
tableCellLocation | مکان سلول جدول مرجع که ردیف از آن حذف خواهد شد. ردیفی که این سلول در آن قرار دارد حذف خواهد شد. اگر این یک سلول ادغام شده است که چندین ردیف را در بر می گیرد، تمام ردیف هایی که سلول در آن قرار دارد حذف خواهند شد. اگر بعد از این حذف هیچ ردیفی در جدول باقی نماند، کل جدول حذف می شود. |
DeleteTableColumnRequest
یک ستون را از جدول حذف می کند.
نمایندگی JSON |
---|
{
"tableCellLocation": {
object ( |
فیلدها | |
---|---|
tableCellLocation | محل سلول جدول مرجع که ستون از آن حذف خواهد شد. ستونی که این سلول در آن قرار دارد حذف خواهد شد. اگر این یک سلول ادغام شده است که چندین ستون را در بر می گیرد، تمام ستون هایی که سلول در آن قرار دارد حذف می شوند. اگر پس از این حذف هیچ ستونی در جدول باقی نماند، کل جدول حذف می شود. |
InsertPageBreakRequest
یک شکست صفحه و به دنبال آن یک خط جدید در مکان مشخص شده درج می کند.
نمایندگی JSON |
---|
{ // Union field |
فیلدها | |
---|---|
فیلد اتحادیه insertion_location . مکانی که صفحه شکستگی در آن درج خواهد شد. insertion_location تنها می تواند یکی از موارد زیر باشد: | |
location | شکست صفحه را در یک نمایه خاص در سند درج می کند. شکست صفحه باید در داخل محدوده یک جداسازی صفحه را نمی توان در جدول، معادله، پاورقی، سرصفحه یا پاورقی درج کرد. از آنجایی که شکستگی صفحه فقط می تواند در داخل بدنه درج شود، قسمت |
endOfSegmentLocation | شکست صفحه را در انتهای بدنه سند درج می کند. شکستگی صفحه را نمی توان در پاورقی، سرصفحه یا پاورقی درج کرد. از آنجایی که شکستگی صفحه فقط می تواند در داخل بدنه درج شود، قسمت |
DeletePositionedObjectRequest
یک PositionedObject
از سند حذف می کند.
نمایندگی JSON |
---|
{ "objectId": string, "tabId": string } |
فیلدها | |
---|---|
objectId | شناسه شی قرار داده شده برای حذف. |
tabId | برگه ای که شی قرار داده شده برای حذف در آن قرار دارد. وقتی حذف شد، درخواست به اولین تب اعمال می شود. در یک سند حاوی یک برگه:
در یک سند حاوی چندین برگه:
|
UpdateTableColumnPropertiesRequest
TableColumnProperties
ستون ها را در یک جدول به روز می کند.
نمایندگی JSON |
---|
{ "tableStartLocation": { object ( |
فیلدها | |
---|---|
tableStartLocation | مکانی که جدول در سند شروع می شود. |
columnIndices[] | لیستی از شاخص های ستون مبتنی بر صفر که ویژگی آنها باید به روز شود. اگر هیچ شاخصی مشخص نشده باشد، تمام ستون ها به روز می شوند. |
tableColumnProperties | ویژگی های ستون جدول برای به روز رسانی. اگر مقدار |
fields | فیلدهایی که باید به روز شوند. حداقل یک فیلد باید مشخص شود. جدول ریشه برای مثال برای بهروزرسانی عرض ستون، |
UpdateTableCellStyleRequest
سبک طیف وسیعی از سلول های جدول را به روز می کند.
نمایندگی JSON |
---|
{ "tableCellStyle": { object ( |
فیلدها | |
---|---|
tableCellStyle | سبکی که باید در سلول های جدول تنظیم شود. هنگام بهروزرسانی مرزها، اگر یک سلول مرزی را با سلول مجاور به اشتراک بگذارد، ویژگی مرزی مربوط به سلول مجاور نیز بهروزرسانی میشود. حاشیه هایی که ادغام شده و نامرئی هستند به روز نمی شوند. از آنجایی که بهروزرسانی یک مرز مشترک توسط سلولهای مجاور در همان درخواست میتواند باعث بهروزرسانیهای مرزی متناقض شود، بهروزرسانیهای حاشیه به ترتیب زیر اعمال میشوند:
|
fields | فیلدهایی که باید به روز شوند. حداقل یک فیلد باید مشخص شود. جدول ریشه برای مثال برای بهروزرسانی رنگ پسزمینه سلول جدول، برای بازنشانی یک ویژگی به مقدار پیشفرض، نام فیلد آن را در ماسک فیلد وارد کنید اما خود فیلد را تنظیم نشده رها کنید. |
cells میدان اتحادیه سلول هایی که به روز می شوند. cells فقط می توانند یکی از موارد زیر باشند: | |
tableRange | محدوده جدول نشان دهنده زیرمجموعه جدولی است که به روز رسانی ها روی آن اعمال می شود. |
tableStartLocation | مکانی که جدول در سند شروع می شود. در صورت مشخص شدن، به روز رسانی ها برای تمام سلول های جدول اعمال می شود. |
محدوده جدول
محدوده جدول نشان دهنده ارجاع به زیر مجموعه ای از جدول است.
توجه به این نکته مهم است که سلول های مشخص شده توسط یک محدوده جدول لزوما یک مستطیل تشکیل نمی دهند. برای مثال، فرض کنید یک جدول 3×3 داریم که تمام سلول های ردیف آخر با هم ادغام شده اند. جدول به شکل زیر است:
[ ][ ][ ]
[ ][ ][ ]
[ ]
یک محدوده جدول با مکان سلول جدول = (tableStartLocation، ردیف = 0، ستون = 0)، فاصله ردیف = 3 و طول ستون = 2 سلول های زیر را مشخص می کند:
[ x ][ x ][ ]
[ x ][ x ][ ]
[ x x x ]
نمایندگی JSON |
---|
{
"tableCellLocation": {
object ( |
فیلدها | |
---|---|
tableCellLocation | محل سلولی که محدوده جدول از آنجا شروع می شود. |
rowSpan | عرض ردیف محدوده جدول. |
columnSpan | عرض ستون محدوده جدول. |
UpdateTableRowStyleRequest
TableRowStyle
ردیفهای جدول را بهروزرسانی میکند.
نمایندگی JSON |
---|
{ "tableStartLocation": { object ( |
فیلدها | |
---|---|
tableStartLocation | مکانی که جدول در سند شروع می شود. |
rowIndices[] | فهرست شاخصهای ردیف مبتنی بر صفر که سبک آنها باید بهروزرسانی شود. اگر هیچ شاخصی مشخص نشده باشد، تمام ردیف ها به روز می شوند. |
tableRowStyle | سبک هایی که باید روی ردیف ها تنظیم شوند. |
fields | فیلدهایی که باید به روز شوند. حداقل یک فیلد باید مشخص شود. جدول ریشه برای مثال برای بهروزرسانی حداقل ارتفاع ردیف، |
ReplaceImageRequest
یک تصویر موجود را با یک تصویر جدید جایگزین می کند.
جایگزین کردن یک تصویر برخی image effects
از تصویر موجود حذف می کند تا رفتار ویرایشگر Docs را منعکس کند.
نمایندگی JSON |
---|
{
"imageObjectId": string,
"uri": string,
"imageReplaceMethod": enum ( |
فیلدها | |
---|---|
imageObjectId | شناسه تصویر موجود که جایگزین خواهد شد. شناسه را می توان از پاسخ درخواست دریافت بازیابی کرد. |
uri | URI تصویر جدید. تصویر یک بار در زمان درج واکشی می شود و یک کپی برای نمایش در داخل سند ذخیره می شود. تصاویر باید کمتر از 50 مگابایت باشند، نباید بیش از 25 مگاپیکسل باشند و باید در فرمت PNG، JPEG یا GIF باشند. طول URI ارائه شده نمی تواند از 2 کیلوبایت بیشتر باشد. URI همراه با تصویر ذخیره می شود و از طریق فیلد |
imageReplaceMethod | روش جایگزینی |
tabId | برگه ای که تصویری که باید جایگزین شود در آن قرار دارد. در صورت حذف، درخواست به اولین تب اعمال می شود. در یک سند حاوی یک برگه:
در یک سند حاوی چندین برگه:
|
ImageReplaceMethod
روش جایگزینی تصویر
Enums | |
---|---|
IMAGE_REPLACE_METHOD_UNSPECIFIED | روش جایگزینی تصویر نامشخص این مقدار نباید استفاده شود. |
CENTER_CROP | تصویر را مقیاس و مرکز می کند تا مرزهای تصویر اصلی پر شود. ممکن است تصویر برای پر کردن محدوده های تصویر اصلی برش داده شود. اندازه رندر شده تصویر با تصویر اصلی یکسان خواهد بود. |
UpdateDocumentStyleRequest
DocumentStyle
به روز می کند.
نمایندگی JSON |
---|
{
"documentStyle": {
object ( |
فیلدها | |
---|---|
documentStyle | سبک هایی که باید روی سند تنظیم شوند. برخی از تغییرات سبک سند ممکن است باعث ایجاد تغییرات دیگری به منظور منعکس کردن رفتار ویرایشگر Docs شود. برای اطلاعات بیشتر به مستندات |
fields | فیلدهایی که باید به روز شوند. حداقل یک فیلد باید مشخص شود. root برای مثال برای بهروزرسانی پسزمینه، |
tabId | برگه ای که حاوی سبکی برای به روز رسانی است. در صورت حذف شدن، درخواست در اولین تب اعمال می شود. در یک سند حاوی یک برگه:
در یک سند حاوی چندین برگه:
|
MergeTableCellsRequest
سلول ها را در یک Table
ادغام می کند.
نمایندگی JSON |
---|
{
"tableRange": {
object ( |
فیلدها | |
---|---|
tableRange | محدوده جدول که مشخص می کند کدام سلول های جدول ادغام شوند. هر متنی در سلولهایی که ادغام میشوند، به هم پیوسته و در سلول "سر" محدوده ذخیره میشوند. هنگامی که جهت محتوا از چپ به راست است، این سلول بالای سمت چپ محدوده است و در غیر این صورت سلول سمت راست بالای محدوده است. اگر محدوده غیر مستطیلی باشد (که می تواند در برخی موارد رخ دهد که در آن محدوده سلول هایی را پوشش می دهد که قبلاً ادغام شده اند یا جایی که جدول غیر مستطیلی است)، یک خطای درخواست بد 400 برگردانده می شود. |
UnmergeTableCellsRequest
سلول ها را در Table
از هم ادغام می کند.
نمایندگی JSON |
---|
{
"tableRange": {
object ( |
فیلدها | |
---|---|
tableRange | محدوده جدول که مشخص می کند کدام سلول های جدول از ادغام خارج شوند. تمام سلولهای ادغامشده در این محدوده لغو ادغام میشوند و سلولهایی که قبلاً ادغام نشدهاند تحت تأثیر قرار نمیگیرند. اگر محدوده فاقد سلول های ادغام شده باشد، درخواست کاری انجام نمی دهد. اگر متنی در هر یک از سلول های ادغام شده وجود داشته باشد، متن در سلول "سر" بلوک سلول های ادغام نشده به دست می آید. هنگامی که جهت محتوا از چپ به راست است، سلول "سر" سلول سمت چپ بالا است و در غیر این صورت سلول بالا سمت راست است. |
CreateHeaderRequest
یک Header
ایجاد می کند. هدر جدید در صورت مشخص شدن روی SectionStyle
در محل SectionBreak
اعمال می شود، در غیر این صورت روی DocumentStyle
اعمال می شود.
اگر هدر از نوع مشخص شده از قبل وجود داشته باشد، یک خطای درخواست بد 400 برگردانده می شود.
نمایندگی JSON |
---|
{ "type": enum ( |
فیلدها | |
---|---|
type | نوع هدر برای ایجاد |
sectionBreakLocation | محل |
CreateFootnoteRequest
یک بخش Footnote
ایجاد می کند و یک FootnoteReference
جدید را در محل مشخص شده درج می کند.
بخش Footnote
جدید حاوی یک فاصله خواهد بود که با یک کاراکتر خط جدید همراه است.
نمایندگی JSON |
---|
{ // Union field |
فیلدها | |
---|---|
فیلد اتحادیه footnote_reference_location . محل درج مرجع پاورقی. footnote_reference_location تنها می تواند یکی از موارد زیر باشد: | |
location | مرجع پاورقی را در یک نمایه خاص در سند درج می کند. مرجع پاورقی باید در داخل محدوده یک مراجع پاورقی را نمی توان در معادله، سرصفحه، پاورقی یا پاورقی درج کرد. از آنجایی که مراجع پاورقی را فقط می توان در بدنه درج کرد، قسمت |
endOfSegmentLocation | مرجع پاورقی را در انتهای متن سند درج می کند. ارجاعات پاورقی را نمی توان داخل سرصفحه، پاورقی یا پاورقی درج کرد. از آنجایی که مراجع پاورقی را فقط می توان در بدنه درج کرد، قسمت |
ReplaceNamedRangeContentRequest
محتویات NamedRange
یا NamedRanges
مشخص شده را با محتوای جایگزین داده شده جایگزین می کند.
توجه داشته باشید که یک NamedRange
فردی ممکن است از چندین ranges
ناپیوسته تشکیل شده باشد. در این صورت فقط محتوای محدوده اول جایگزین می شود. محدوده های دیگر و محتوای آنها حذف خواهد شد.
در مواردی که جایگزینی یا حذف هر محدوده ای منجر به ساختار سند نامعتبر شود، یک خطای درخواست بد 400 برگردانده می شود.
نمایندگی JSON |
---|
{ "tabsCriteria": { object ( |
فیلدها | |
---|---|
tabsCriteria | اختیاری. معیارهایی که برای تعیین اینکه جایگزینی در کدام زبانه ها استفاده می شود. در صورت حذف، جایگزینی برای همه برگه ها اعمال می شود. در یک سند حاوی یک برگه:
در یک سند حاوی چندین برگه:
|
فیلد اتحادیه replacement_content . محتوایی که باید جایگزین محتوای موجود محدوده نامگذاری شده شود. replacement_content تنها می تواند یکی از موارد زیر باشد: | |
text | محتوای محدوده (های) نامگذاری شده مشخص شده را با متن داده شده جایگزین می کند. |
فیلد اتحادیه named_range_reference . ارجاع به محدوده(های) نامگذاری شده که محتوای آنها جایگزین خواهد شد. named_range_reference تنها می تواند یکی از موارد زیر باشد: | |
namedRangeId | شناسه محدوده نامگذاری شده که محتوای آن جایگزین خواهد شد. اگر محدوده نامگذاریشدهای با شناسه دادهشده وجود نداشته باشد، خطای درخواست بد 400 برگردانده میشود. |
namedRangeName | نام اگر چندین |
UpdateSectionStyleRequest
SectionStyle
به روز می کند.
نمایندگی JSON |
---|
{ "range": { object ( |
فیلدها | |
---|---|
range | محدوده همپوشانی بخش ها به سبک. از آنجایی که شکست های بخش فقط در داخل بدنه قابل درج هستند، قسمت |
sectionStyle | سبک هایی که باید در بخش تنظیم شوند. برخی از تغییرات سبک بخش ممکن است تغییرات دیگری را به منظور منعکس کردن رفتار ویرایشگر Docs ایجاد کند. برای اطلاعات بیشتر به مستندات |
fields | فیلدهایی که باید به روز شوند. حداقل یک فیلد باید مشخص شود. root برای مثال برای بهروزرسانی حاشیه سمت چپ، |
InsertSectionBreakRequest
یک شکست بخش را در مکان داده شده درج می کند.
یک کاراکتر خط جدید قبل از شکست بخش درج خواهد شد.
نمایندگی JSON |
---|
{ "sectionType": enum ( |
فیلدها | |
---|---|
sectionType | نوع بخش برای درج. |
فیلد اتحادیه insertion_location . مکانی که شکستگی درج خواهد شد. insertion_location تنها می تواند یکی از موارد زیر باشد: | |
location | یک خط جدید و یک بخش را در یک شاخص خاص در سند درج می کند. بخش شکست باید در داخل مرزهای یک شکست های بخش را نمی توان در یک جدول، معادله، پاورقی، سرصفحه یا پاورقی درج کرد. از آنجایی که شکست های بخش فقط می توانند در داخل بدنه درج شوند، قسمت |
endOfSegmentLocation | یک خط جدید و یک برش بخش در انتهای بدنه سند درج می کند. شکست های بخش را نمی توان در پاورقی، سرصفحه یا پاورقی درج کرد. از آنجایی که شکست های بخش فقط در داخل بدنه قابل درج هستند، قسمت |
DeleteHeaderRequest
یک Header
از سند حذف می کند.
نمایندگی JSON |
---|
{ "headerId": string, "tabId": string } |
فیلدها | |
---|---|
headerId | شناسه هدر برای حذف. اگر این هدر در |
tabId | برگه حاوی هدر برای حذف. در صورت حذف ، درخواست در برگه اول اعمال می شود. در سندی که حاوی یک برگه واحد است:
در سندی که حاوی چندین برگه است:
|
pinableheaderrowsequest
تعداد ردیف های هدر جدول پین شده را در یک جدول به روز می کند.
نمایندگی JSON |
---|
{
"tableStartLocation": {
object ( |
فیلدها | |
---|---|
tableStartLocation | مکانی که جدول در سند شروع می شود. |
pinnedHeaderRowsCount | تعداد ردیف های جدول به پین ، جایی که 0 به معنای آن است که همه ردیف ها از بین رفته اند. |