Requests

طلب

نوع واحد من التعديلات التي يمكن تطبيقها على جدول بيانات

تمثيل JSON
{

  "updateSpreadsheetProperties": {
    object (UpdateSpreadsheetPropertiesRequest)
  },
  "updateSheetProperties": {
    object (UpdateSheetPropertiesRequest)
  },
  "updateDimensionProperties": {
    object (UpdateDimensionPropertiesRequest)
  },
  "updateNamedRange": {
    object (UpdateNamedRangeRequest)
  },
  "repeatCell": {
    object (RepeatCellRequest)
  },
  "addNamedRange": {
    object (AddNamedRangeRequest)
  },
  "deleteNamedRange": {
    object (DeleteNamedRangeRequest)
  },
  "addSheet": {
    object (AddSheetRequest)
  },
  "deleteSheet": {
    object (DeleteSheetRequest)
  },
  "autoFill": {
    object (AutoFillRequest)
  },
  "cutPaste": {
    object (CutPasteRequest)
  },
  "copyPaste": {
    object (CopyPasteRequest)
  },
  "mergeCells": {
    object (MergeCellsRequest)
  },
  "unmergeCells": {
    object (UnmergeCellsRequest)
  },
  "updateBorders": {
    object (UpdateBordersRequest)
  },
  "updateCells": {
    object (UpdateCellsRequest)
  },
  "addFilterView": {
    object (AddFilterViewRequest)
  },
  "appendCells": {
    object (AppendCellsRequest)
  },
  "clearBasicFilter": {
    object (ClearBasicFilterRequest)
  },
  "deleteDimension": {
    object (DeleteDimensionRequest)
  },
  "deleteEmbeddedObject": {
    object (DeleteEmbeddedObjectRequest)
  },
  "deleteFilterView": {
    object (DeleteFilterViewRequest)
  },
  "duplicateFilterView": {
    object (DuplicateFilterViewRequest)
  },
  "duplicateSheet": {
    object (DuplicateSheetRequest)
  },
  "findReplace": {
    object (FindReplaceRequest)
  },
  "insertDimension": {
    object (InsertDimensionRequest)
  },
  "insertRange": {
    object (InsertRangeRequest)
  },
  "moveDimension": {
    object (MoveDimensionRequest)
  },
  "updateEmbeddedObjectPosition": {
    object (UpdateEmbeddedObjectPositionRequest)
  },
  "pasteData": {
    object (PasteDataRequest)
  },
  "textToColumns": {
    object (TextToColumnsRequest)
  },
  "updateFilterView": {
    object (UpdateFilterViewRequest)
  },
  "deleteRange": {
    object (DeleteRangeRequest)
  },
  "appendDimension": {
    object (AppendDimensionRequest)
  },
  "addConditionalFormatRule": {
    object (AddConditionalFormatRuleRequest)
  },
  "updateConditionalFormatRule": {
    object (UpdateConditionalFormatRuleRequest)
  },
  "deleteConditionalFormatRule": {
    object (DeleteConditionalFormatRuleRequest)
  },
  "sortRange": {
    object (SortRangeRequest)
  },
  "setDataValidation": {
    object (SetDataValidationRequest)
  },
  "setBasicFilter": {
    object (SetBasicFilterRequest)
  },
  "addProtectedRange": {
    object (AddProtectedRangeRequest)
  },
  "updateProtectedRange": {
    object (UpdateProtectedRangeRequest)
  },
  "deleteProtectedRange": {
    object (DeleteProtectedRangeRequest)
  },
  "autoResizeDimensions": {
    object (AutoResizeDimensionsRequest)
  },
  "addChart": {
    object (AddChartRequest)
  },
  "updateChartSpec": {
    object (UpdateChartSpecRequest)
  },
  "updateBanding": {
    object (UpdateBandingRequest)
  },
  "addBanding": {
    object (AddBandingRequest)
  },
  "deleteBanding": {
    object (DeleteBandingRequest)
  },
  "createDeveloperMetadata": {
    object (CreateDeveloperMetadataRequest)
  },
  "updateDeveloperMetadata": {
    object (UpdateDeveloperMetadataRequest)
  },
  "deleteDeveloperMetadata": {
    object (DeleteDeveloperMetadataRequest)
  },
  "randomizeRange": {
    object (RandomizeRangeRequest)
  },
  "addDimensionGroup": {
    object (AddDimensionGroupRequest)
  },
  "deleteDimensionGroup": {
    object (DeleteDimensionGroupRequest)
  },
  "updateDimensionGroup": {
    object (UpdateDimensionGroupRequest)
  },
  "trimWhitespace": {
    object (TrimWhitespaceRequest)
  },
  "deleteDuplicates": {
    object (DeleteDuplicatesRequest)
  },
  "updateEmbeddedObjectBorder": {
    object (UpdateEmbeddedObjectBorderRequest)
  },
  "addSlicer": {
    object (AddSlicerRequest)
  },
  "updateSlicerSpec": {
    object (UpdateSlicerSpecRequest)
  },
  "addDataSource": {
    object (AddDataSourceRequest)
  },
  "updateDataSource": {
    object (UpdateDataSourceRequest)
  },
  "deleteDataSource": {
    object (DeleteDataSourceRequest)
  },
  "refreshDataSource": {
    object (RefreshDataSourceRequest)
  },
  "cancelDataSourceRefresh": {
    object (CancelDataSourceRefreshRequest)
  },
  "addTable": {
    object (AddTableRequest)
  },
  "updateTable": {
    object (UpdateTableRequest)
  },
  "deleteTable": {
    object (DeleteTableRequest)
  },
  "insertComment": {
    object (InsertCommentRequest)
  },
  "addCommentReply": {
    object (AddCommentReplyRequest)
  },
  "updateCommentPost": {
    object (UpdateCommentPostRequest)
  },
  "deleteComment": {
    object (DeleteCommentRequest)
  },
  "deleteCommentReply": {
    object (DeleteCommentReplyRequest)
  }
}
الحقول
حقل الربط kind نوع التعديل. يجب ملء حقل واحد بالضبط. يمكن أن يكون kind إحدى القيم التالية فقط:
updateSpreadsheetProperties

object (UpdateSpreadsheetPropertiesRequest)

تعدّل هذه الطريقة خصائص جدول البيانات.

updateSheetProperties

object (UpdateSheetPropertiesRequest)

تعدّل هذه الطريقة خصائص ورقة جدول بيانات.

updateDimensionProperties

object (UpdateDimensionPropertiesRequest)

تعدّل هذه الطريقة خصائص السمات.

updateNamedRange

object (UpdateNamedRangeRequest)

تعديل نطاق مُعنون

repeatCell

object (RepeatCellRequest)

تكرّر هذه الدالة خلية واحدة في نطاق معيّن.

addNamedRange

object (AddNamedRangeRequest)

تضيف هذه الدالة نطاقًا مُعنوَنًا.

deleteNamedRange

object (DeleteNamedRangeRequest)

لحذف نطاق مُعنوَن

addSheet

object (AddSheetRequest)

تضيف هذه الطريقة ورقة.

deleteSheet

object (DeleteSheetRequest)

تحذف هذه الطريقة ورقة.

autoFill

object (AutoFillRequest)

تعبئة المزيد من البيانات تلقائيًا استنادًا إلى البيانات الحالية

cutPaste

object (CutPasteRequest)

يتم قص البيانات من منطقة ولصقها في منطقة أخرى.

copyPaste

object (CopyPasteRequest)

تنسخ هذه الدالة البيانات من منطقة وتلصقها في منطقة أخرى.

mergeCells

object (MergeCellsRequest)

يدمج الخلايا معًا.

unmergeCells

object (UnmergeCellsRequest)

لإلغاء دمج الخلايا المدمجة

updateBorders

object (UpdateBordersRequest)

تعدّل هذه الدالة الحدود في نطاق من الخلايا.

updateCells

object (UpdateCellsRequest)

تعديل العديد من الخلايا في آنٍ واحد

addFilterView

object (AddFilterViewRequest)

تضيف هذه الطريقة عرض فلتر.

appendCells

object (AppendCellsRequest)

تُلحق هذه الطريقة الخلايا بعد آخر صف يتضمّن بيانات في ورقة.

clearBasicFilter

object (ClearBasicFilterRequest)

يمحو الفلتر الأساسي في ورقة.

deleteDimension

object (DeleteDimensionRequest)

تحذف هذه الدالة الصفوف أو الأعمدة في ورقة.

deleteEmbeddedObject

object (DeleteEmbeddedObjectRequest)

تحذف عنصرًا مضمَّنًا (مثل رسم بياني أو صورة) في ورقة بيانات.

deleteFilterView

object (DeleteFilterViewRequest)

تحذف هذه الطريقة عرض فلتر من ورقة بيانات.

duplicateFilterView

object (DuplicateFilterViewRequest)

تكرِّر هذه الطريقة عرض فلتر.

duplicateSheet

object (DuplicateSheetRequest)

تكرار ورقة

findReplace

object (FindReplaceRequest)

للبحث عن بعض النصوص واستبدالها بنصوص أخرى

insertDimension

object (InsertDimensionRequest)

تُدرِج هذه الدالة صفوفًا أو أعمدة جديدة في ورقة.

insertRange

object (InsertRangeRequest)

تُدرِج هذه الدالة خلايا جديدة في ورقة، مع نقل الخلايا الحالية.

moveDimension

object (MoveDimensionRequest)

تنقل هذه الدالة الصفوف أو الأعمدة إلى موقع آخر في ورقة.

updateEmbeddedObjectPosition

object (UpdateEmbeddedObjectPositionRequest)

تعدّل هذه الطريقة موضع عنصر مضمّن (مثل رسم بياني أو صورة).

pasteData

object (PasteDataRequest)

لصق البيانات (HTML أو البيانات المحدّدة) في ورقة بيانات

textToColumns

object (TextToColumnsRequest)

تحويل عمود نصي إلى عدة أعمدة نصية

updateFilterView

object (UpdateFilterViewRequest)

تعدّل هذه الطريقة خصائص عرض فلتر.

deleteRange

object (DeleteRangeRequest)

تحذف هذه الدالة نطاقًا من الخلايا من ورقة، مع نقل الخلايا المتبقية.

appendDimension

object (AppendDimensionRequest)

تضيف هذه الطريقة سمات إلى نهاية ورقة.

addConditionalFormatRule

object (AddConditionalFormatRuleRequest)

تضيف هذه الدالة قاعدة تنسيق شرطي جديدة.

updateConditionalFormatRule

object (UpdateConditionalFormatRuleRequest)

تعدّل هذه الطريقة قاعدة تنسيق شرطي حالية.

deleteConditionalFormatRule

object (DeleteConditionalFormatRuleRequest)

يحذف قاعدة تنسيق شرطي حالية.

sortRange

object (SortRangeRequest)

تفرز هذه الدالة البيانات في نطاق.

setDataValidation

object (SetDataValidationRequest)

تضبط هذه الدالة التحقّق من صحة البيانات لخلية واحدة أو أكثر.

setBasicFilter

object (SetBasicFilterRequest)

تضبط هذه السمة الفلتر الأساسي في ورقة.

addProtectedRange

object (AddProtectedRangeRequest)

تضيف هذه الدالة نطاقًا محميًا.

updateProtectedRange

object (UpdateProtectedRangeRequest)

تعديل نطاق محمي

deleteProtectedRange

object (DeleteProtectedRangeRequest)

يحذف هذا الإجراء نطاقًا محميًا.

autoResizeDimensions

object (AutoResizeDimensionsRequest)

يتم تغيير حجم سمة واحدة أو أكثر تلقائيًا استنادًا إلى محتوى الخلايا في تلك السمة.

addChart

object (AddChartRequest)

تضيف هذه الطريقة رسمًا بيانيًا.

updateChartSpec

object (UpdateChartSpecRequest)

تعدّل هذه الطريقة مواصفات الرسم البياني.

updateBanding

object (UpdateBandingRequest)

تعديل نطاق ذي فئات

addBanding

object (AddBandingRequest)

تضيف هذه الدالة نطاقًا جديدًا مقسّمًا إلى شرائح

deleteBanding

object (DeleteBandingRequest)

إزالة نطاق ذي تباين

createDeveloperMetadata

object (CreateDeveloperMetadataRequest)

تُنشئ هذه الطريقة بيانات وصفية جديدة للمطوّرين.

updateDeveloperMetadata

object (UpdateDeveloperMetadataRequest)

تعديل إدخال حالي لبيانات المطوّر الوصفية

deleteDeveloperMetadata

object (DeleteDeveloperMetadataRequest)

حذف البيانات الوصفية للمطوِّر

randomizeRange

object (RandomizeRangeRequest)

لترتيب الصفوف في نطاق بشكل عشوائي.

addDimensionGroup

object (AddDimensionGroupRequest)

تنشئ هذه الدالة مجموعة على النطاق المحدّد.

deleteDimensionGroup

object (DeleteDimensionGroupRequest)

لحذف مجموعة ضمن النطاق المحدّد

updateDimensionGroup

object (UpdateDimensionGroupRequest)

تعدّل هذه الطريقة حالة المجموعة المحدّدة.

trimWhitespace

object (TrimWhitespaceRequest)

تزيل هذه الدالة المسافة البيضاء (مثل المسافات أو علامات التبويب أو الأسطر الجديدة) من الخلايا.

deleteDuplicates

object (DeleteDuplicatesRequest)

تزيل هذه الدالة الصفوف التي تحتوي على قيم مكرّرة في أعمدة محدّدة من نطاق خلايا.

updateEmbeddedObjectBorder

object (UpdateEmbeddedObjectBorderRequest)

تعدّل هذه السمة حدود كائن مضمّن.

addSlicer

object (AddSlicerRequest)

تضيف هذه الدالة فلتر نطاق بيانات.

updateSlicerSpec

object (UpdateSlicerSpecRequest)

تعديل مواصفات أداة التقطيع

addDataSource

object (AddDataSourceRequest)

تضيف هذه الطريقة مصدر بيانات.

updateDataSource

object (UpdateDataSourceRequest)

تعديل مصدر بيانات

deleteDataSource

object (DeleteDataSourceRequest)

تحذف هذه الطريقة مصدر بيانات.

refreshDataSource

object (RefreshDataSourceRequest)

تعيد تحميل مصدر بيانات واحد أو أكثر وكائنات قاعدة البيانات المرتبطة.

cancelDataSourceRefresh

object (CancelDataSourceRefreshRequest)

تلغي هذه الطريقة عمليات إعادة تحميل مصدر بيانات واحد أو أكثر وكائنات قاعدة البيانات المرتبطة.

addTable

object (AddTableRequest)

تضيف هذه الطريقة جدولاً.

updateTable

object (UpdateTableRequest)

تعديل جدول

deleteTable

object (DeleteTableRequest)

طلب حذف جدول

insertComment

object (InsertCommentRequest)

تُدرج هذه الدالة CommentThread في جدول البيانات.

addCommentReply

object (AddCommentReplyRequest)

تضيف هذه الطريقة ردًا على CommentThread.

updateCommentPost

object (UpdateCommentPostRequest)

تعديل مشاركة حالية (مشاركة رئيسية أو رد) ضمن CommentThread

deleteComment

object (DeleteCommentRequest)

يحذف CommentThread.

deleteCommentReply

object (DeleteCommentReplyRequest)

يحذف هذا الإجراء ردًا Post من CommentThread

UpdateSpreadsheetPropertiesRequest

تعدّل هذه الطريقة خصائص جدول بيانات.

تمثيل JSON
{
  "properties": {
    object (SpreadsheetProperties)
  },
  "fields": string
}
الحقول
properties

object (SpreadsheetProperties)

الخصائص المطلوب تعديلها

fields

string (FieldMask format)

الحقول التي يجب تعديلها يجب تحديد حقل واحد على الأقل. يتم تضمين "السمات" الجذرية ضِمنيًا ويجب عدم تحديدها. يمكن استخدام "*" واحدة كاختصار لإدراج كل حقل.

UpdateSheetPropertiesRequest

تعدّل هذه الطريقة خصائص ورقة البيانات التي تحمل المعرّف sheetId المحدّد.

تمثيل JSON
{
  "properties": {
    object (SheetProperties)
  },
  "fields": string
}
الحقول
properties

object (SheetProperties)

الخصائص المطلوب تعديلها

fields

string (FieldMask format)

الحقول التي يجب تعديلها يجب تحديد حقل واحد على الأقل. يتم تضمين الجذر properties ضمنيًا ويجب عدم تحديده. يمكن استخدام "*" واحدة كاختصار لإدراج كل حقل.

UpdateDimensionPropertiesRequest

تعدِّل هذه الطريقة خصائص السمات ضمن النطاق المحدّد.

تمثيل JSON
{
  "properties": {
    object (DimensionProperties)
  },
  "fields": string,

  "range": {
    object (DimensionRange)
  },
  "dataSourceSheetRange": {
    object (DataSourceSheetDimensionRange)
  }
}
الحقول
properties

object (DimensionProperties)

الخصائص المطلوب تعديلها

fields

string (FieldMask format)

الحقول التي يجب تعديلها يجب تحديد حقل واحد على الأقل. يتم تضمين الجذر properties ضمنيًا ويجب عدم تحديده. يمكن استخدام "*" واحدة كاختصار لإدراج كل حقل.

حقل الربط dimension_range نطاق السمة يمكن أن يكون dimension_range إحدى القيم التالية فقط:
range

object (DimensionRange)

صفوف أو أعمدة لتعديلها

dataSourceSheetRange

object (DataSourceSheetDimensionRange)

أعمدة ورقة مصدر البيانات التي سيتم تعديلها

DataSourceSheetDimensionRange

نطاق على طول بُعد واحد في ورقة DATA_SOURCE

تمثيل JSON
{
  "sheetId": integer,
  "columnReferences": [
    {
      object (DataSourceColumnReference)
    }
  ]
}
الحقول
sheetId

integer

رقم تعريف ورقة مصدر البيانات التي يقع فيها النطاق

columnReferences[]

object (DataSourceColumnReference)

الأعمدة في ورقة مصدر البيانات

UpdateNamedRangeRequest

تعدّل هذه الطريقة خصائص النطاق المُعنون باستخدام namedRangeId المحدّد.

تمثيل JSON
{
  "namedRange": {
    object (NamedRange)
  },
  "fields": string
}
الحقول
namedRange

object (NamedRange)

النطاق المُعنوَن المطلوب تعديله بالخصائص الجديدة.

fields

string (FieldMask format)

الحقول التي يجب تعديلها يجب تحديد حقل واحد على الأقل. يتم تضمين الجذر namedRange ضمنيًا ويجب عدم تحديده. يمكن استخدام "*" واحدة كاختصار لإدراج كل حقل.

RepeatCellRequest

تعدّل جميع الخلايا في النطاق إلى القيم الموجودة في عنصر الخلية المحدّد. يتم تعديل الحقول المدرَجة في حقل fields فقط، وتبقى الحقول الأخرى بدون تغيير.

في حال كتابة صيغة في خلية، ستتم زيادة نطاقات الصيغة تلقائيًا لكل حقل في النطاق. على سبيل المثال، إذا كنت تكتب في خلية تحتوي على الصيغة =A1 في النطاق B2:C4، ستكون قيمة B2 هي =A1، وقيمة B3 هي =A2، وقيمة B4 هي =A3، وقيمة C2 هي =B1، وقيمة C3 هي =B2، وقيمة C4 هي =B3.

لإبقاء نطاقات الصيغة ثابتة، استخدِم المؤشر $. على سبيل المثال، استخدِم الصيغة =$A$1 لمنع زيادة كل من الصف والعمود.

تمثيل JSON
{
  "range": {
    object (GridRange)
  },
  "cell": {
    object (CellData)
  },
  "fields": string
}
الحقول
range

object (GridRange)

النطاق المطلوب تكرار الخلية فيه

cell

object (CellData)

البيانات المطلوب كتابتها

fields

string (FieldMask format)

الحقول التي يجب تعديلها يجب تحديد حقل واحد على الأقل. يتم تضمين الجذر cell ضمنيًا ويجب عدم تحديده. يمكن استخدام "*" واحدة كاختصار لإدراج كل حقل.

AddNamedRangeRequest

تضيف هذه الدالة نطاقًا مُعنوَنًا إلى جدول البيانات.

تمثيل JSON
{
  "namedRange": {
    object (NamedRange)
  }
}
الحقول
namedRange

object (NamedRange)

النطاق المُعنوَن المطلوب إضافته الحقل namedRangeId اختياري، وفي حال عدم ضبطه، سيتم إنشاء معرّف عشوائيًا. (يُعدّ تحديد رقم تعريف نطاق متوفّر من قبل خطأً).

DeleteNamedRangeRequest

يزيل هذا الإجراء النطاق المُعنون الذي يحمل رقم التعريف المحدّد من جدول البيانات.

تمثيل JSON
{
  "namedRangeId": string
}
الحقول
namedRangeId

string

رقم تعريف النطاق المُعنوَن المطلوب حذفه.

AddSheetRequest

تضيف هذه الدالة ورقة بيانات جديدة. عند إضافة ورقة بيانات في فهرس معيّن، تتم زيادة فهارس جميع أوراق البيانات اللاحقة. لإضافة ورقة كائنات، استخدِم AddChartRequest بدلاً من ذلك وحدِّد EmbeddedObjectPosition.sheetId أو EmbeddedObjectPosition.newSheet.

تمثيل JSON
{
  "properties": {
    object (SheetProperties)
  }
}
الحقول
properties

object (SheetProperties)

الخصائص التي يجب أن تتضمّنها الورقة الجديدة جميع السمات اختيارية. الحقل sheetId اختياري، وفي حال عدم ضبطه، سيتم إنشاء معرّف عشوائيًا. (يُعدّ تحديد معرّف ورقة بيانات موجودة من قبل خطأً).

DeleteSheetRequest

يحذف ورقة البيانات المطلوبة.

تمثيل JSON
{
  "sheetId": integer
}
الحقول
sheetId

integer

رقم تعريف ورقة البيانات المطلوب حذفها.

إذا كانت ورقة البيانات من النوع DATA_SOURCE، سيتم أيضًا حذف DataSource المرتبط بها.

AutoFillRequest

يملأ المزيد من البيانات استنادًا إلى البيانات الحالية.

تمثيل JSON
{
  "useAlternateSeries": boolean,

  "range": {
    object (GridRange)
  },
  "sourceAndDestination": {
    object (SourceAndDestination)
  }
}
الحقول
useAlternateSeries

boolean

تكون القيمة صحيحة إذا كان يجب إنشاء بيانات باستخدام السلسلة "البديلة". يختلف ذلك استنادًا إلى نوع بيانات المصدر وكميتها.

حقل الربط area المنطقة التي سيتم ملؤها تلقائيًا يمكن أن يكون area إحدى القيم التالية فقط:
range

object (GridRange)

النطاق المطلوب ملؤه تلقائيًا. سيتم فحص النطاق ورصد الموقع الجغرافي الذي يتضمّن بيانات وملء هذه البيانات تلقائيًا في بقية النطاق.

sourceAndDestination

object (SourceAndDestination)

تمثّل هذه السمة مناطق المصدر والوجهة التي سيتم ملؤها تلقائيًا. تسرد هذه السمة بشكل صريح مصدر التعبئة التلقائية والمكان الذي يمكن فيه توسيع نطاق هذه البيانات.

SourceAndDestination

مزيج من نطاق المصدر وطريقة توسيعه

تمثيل JSON
{
  "source": {
    object (GridRange)
  },
  "dimension": enum (Dimension),
  "fillLength": integer
}
الحقول
source

object (GridRange)

الموقع الجغرافي للبيانات التي سيتم استخدامها كمصدر للملء التلقائي

dimension

enum (Dimension)

السمة التي يجب ملء البيانات فيها

fillLength

integer

عدد الصفوف أو الأعمدة التي يجب ملء البيانات فيها تتوسّع الأرقام الموجبة إلى ما بعد الصف الأخير أو العمود الأخير في المصدر. تتوسّع الأرقام السالبة قبل الصف الأول أو العمود الأول للمصدر.

CutPasteRequest

تنقل البيانات من المصدر إلى الوجهة.

تمثيل JSON
{
  "source": {
    object (GridRange)
  },
  "destination": {
    object (GridCoordinate)
  },
  "pasteType": enum (PasteType)
}
الحقول
source

object (GridRange)

تمثّل هذه السمة بيانات المصدر المطلوب قصّها.

destination

object (GridCoordinate)

الإحداثي العلوي الأيسر الذي يجب لصق البيانات فيه

pasteType

enum (PasteType)

نوع البيانات التي تريد لصقها سيتم قطع جميع بيانات المصدر، بغض النظر عن المحتوى الذي تم لصقه.

PasteType

نوع البيانات التي يجب لصقها

عمليات التعداد
PASTE_NORMAL لصق القيم والصيغ والتنسيقات وعمليات الدمج
PASTE_VALUES ألصِق القيم فقط بدون تنسيقات أو صِيَغ أو عمليات دمج.
PASTE_FORMAT لصق التنسيق فقط، باستثناء التحقّق من صحة البيانات
PASTE_NO_BORDERS مثل PASTE_NORMAL ولكن بدون حدود.
PASTE_FORMULA لصق الصيغ فقط
PASTE_DATA_VALIDATION لصق التحقّق من صحة البيانات فقط
PASTE_CONDITIONAL_FORMATTING لصق قواعد التنسيق الشرطي فقط

CopyPasteRequest

تنسخ هذه السمة البيانات من المصدر إلى الوجهة.

تمثيل JSON
{
  "source": {
    object (GridRange)
  },
  "destination": {
    object (GridRange)
  },
  "pasteType": enum (PasteType),
  "pasteOrientation": enum (PasteOrientation)
}
الحقول
source

object (GridRange)

نطاق المصدر المطلوب نسخه

destination

object (GridRange)

الموقع الجغرافي المطلوب اللصق فيه إذا كان النطاق يغطّي مدىً يمثّل مضاعفًا لارتفاع المصدر أو عرضه، سيتم تكرار البيانات لملء نطاق الوجهة. إذا كان النطاق أصغر من النطاق المصدر، سيتم نسخ بيانات المصدر بالكامل (خارج نهاية النطاق الوجهة).

pasteType

enum (PasteType)

نوع البيانات التي تريد لصقها

pasteOrientation

enum (PasteOrientation)

تحديد كيفية توجيه البيانات عند لصقها

PasteOrientation

كيفية تنفيذ عملية لصق

عمليات التعداد
NORMAL اللصق بشكل عادي
TRANSPOSE ألصِق البيانات بعد تبديل الصفوف بالأعمدة والعكس.

MergeCellsRequest

يدمج جميع الخلايا في النطاق.

تمثيل JSON
{
  "range": {
    object (GridRange)
  },
  "mergeType": enum (MergeType)
}
الحقول
range

object (GridRange)

نطاق الخلايا المطلوب دمجه.

mergeType

enum (MergeType)

كيفية دمج الخلايا

MergeType

نوع الدمج المطلوب إنشاؤه.

عمليات التعداد
MERGE_ALL إنشاء عملية دمج واحدة من النطاق
MERGE_COLUMNS إنشاء عملية دمج لكل عمود في النطاق
MERGE_ROWS إنشاء عملية دمج لكل صف في النطاق

UnmergeCellsRequest

لإلغاء دمج الخلايا في النطاق المحدّد

تمثيل JSON
{
  "range": {
    object (GridRange)
  }
}
الحقول
range

object (GridRange)

النطاق الذي يجب إلغاء دمج جميع الخلايا فيه إذا كان النطاق يمتد على عمليات دمج متعددة، سيتم إلغاء دمجها كلها. يجب ألا يمتد النطاق جزئيًا على أي عملية دمج.

UpdateBordersRequest

تعدّل هذه السمة حدود نطاق. إذا لم يتم ضبط حقل في الطلب، يعني ذلك أنّ الحدود ستبقى كما هي. على سبيل المثال، مع طلبَين متتاليَين من UpdateBordersRequest:

  1. النطاق: A1:A5 { top: RED, bottom: WHITE }
  2. النطاق: A1:A5 { left: BLUE }

سيؤدي ذلك إلى أن يكون للنطاق A1:A5 حدود { top: RED, bottom: WHITE, left: BLUE }. إذا أردت محو حدود، اضبط النمط على NONE بشكل صريح.

تمثيل JSON
{
  "range": {
    object (GridRange)
  },
  "top": {
    object (Border)
  },
  "bottom": {
    object (Border)
  },
  "left": {
    object (Border)
  },
  "right": {
    object (Border)
  },
  "innerHorizontal": {
    object (Border)
  },
  "innerVertical": {
    object (Border)
  }
}
الحقول
range

object (GridRange)

النطاق الذي يجب تعديل حدوده.

top

object (Border)

الحدّ المطلوب وضعه في أعلى النطاق.

bottom

object (Border)

الحدّ الذي سيتم وضعه في أسفل النطاق.

left

object (Border)

الحدّ الذي سيتم وضعه على يسار النطاق

right

object (Border)

الحدّ الذي سيتم وضعه على يسار النطاق

innerHorizontal

object (Border)

الحدود الأفقية التي سيتم وضعها ضمن النطاق

innerVertical

object (Border)

الحد العمودي الذي سيتم وضعه ضمن النطاق

UpdateCellsRequest

تعدّل هذه الدالة جميع الخلايا في نطاق ببيانات جديدة.

تمثيل JSON
{
  "rows": [
    {
      object (RowData)
    }
  ],
  "fields": string,

  "start": {
    object (GridCoordinate)
  },
  "range": {
    object (GridRange)
  }
}
الحقول
rows[]

object (RowData)

البيانات المطلوب كتابتها

fields

string (FieldMask format)

حقول CellData التي يجب تعديلها. يجب تحديد حقل واحد على الأقل. الجذر هو CellData، ويجب عدم تحديد "row.values". يمكن استخدام "*" واحدة كاختصار لإدراج كل حقل.

حقل الربط area يجب كتابة بيانات الموقع الجغرافي. يجب ضبط قيمة واحدة بالضبط. يمكن أن يكون area إحدى القيم التالية فقط:
start

object (GridCoordinate)

الإحداثي الذي سيتم بدء كتابة البيانات عنده. يمكن كتابة أي عدد من الصفوف والأعمدة (بما في ذلك عدد مختلف من الأعمدة لكل صف).

range

object (GridRange)

النطاق المطلوب كتابة البيانات فيه.

إذا لم تغطِّ البيانات في الصفوف النطاق المطلوب بالكامل، سيتم محو الحقول المطابقة لتلك المحدّدة في fields.

AddFilterViewRequest

تضيف هذه الطريقة عرض فلتر.

تمثيل JSON
{
  "filter": {
    object (FilterView)
  }
}
الحقول
filter

object (FilterView)

الفلتر المطلوب إضافته الحقل filterViewId اختياري. إذا لم يتم ضبط معرّف، سيتم إنشاؤه بشكل عشوائي. (يُعدّ تحديد رقم تعريف فلتر متوفّرًا من قبل خطأً).

AppendCellsRequest

تضيف هذه الطريقة خلايا جديدة بعد الصف الأخير الذي يتضمّن بيانات في ورقة، مع إدراج صفوف جديدة في الورقة إذا لزم الأمر.

تمثيل JSON
{
  "sheetId": integer,
  "rows": [
    {
      object (RowData)
    }
  ],
  "fields": string,

  "tableId": string
}
الحقول
sheetId

integer

معرّف ورقة البيانات التي سيتم إلحاق البيانات بها.

rows[]

object (RowData)

البيانات المطلوب إلحاقها

fields

string (FieldMask format)

حقول CellData التي يجب تعديلها. يجب تحديد حقل واحد على الأقل. الجذر هو CellData، ويجب عدم تحديد "row.values". يمكن استخدام "*" واحدة كاختصار لإدراج كل حقل.

حقل الربط area يجب كتابة بيانات الموقع الجغرافي. يمكن أن يكون area إحدى القيم التالية فقط:
tableId

string

رقم تعريف الجدول الذي سيتم إلحاق البيانات به سيتم إلحاق البيانات بنص الجدول فقط.

ويكون لهذا الحقل أيضًا الأولوية على الحقل sheetId.

ClearBasicFilterRequest

يمحو الفلتر الأساسي، إذا كان متوفّرًا في ورقة البيانات.

تمثيل JSON
{
  "sheetId": integer
}
الحقول
sheetId

integer

معرّف ورقة البيانات التي يجب محو الفلتر الأساسي فيها.

DeleteDimensionRequest

يحذف السمات من ورقة البيانات.

تمثيل JSON
{
  "range": {
    object (DimensionRange)
  }
}
الحقول
range

object (DimensionRange)

السمات المطلوب حذفها من ورقة البيانات

DeleteEmbeddedObjectRequest

يحذف هذا الإجراء الكائن المضمّن الذي يحمل المعرّف المحدّد.

تمثيل JSON
{
  "objectId": integer
}
الحقول
objectId

integer

معرّف العنصر المضمّن المطلوب حذفه.

DeleteFilterViewRequest

لحذف عرض فلتر معيّن

تمثيل JSON
{
  "filterId": integer
}
الحقول
filterId

integer

رقم تعريف الفلتر المطلوب حذفه.

DuplicateFilterViewRequest

تكرّر هذه الدالة عرض فلتر معيّنًا.

تمثيل JSON
{
  "filterId": integer
}
الحقول
filterId

integer

رقم تعريف الفلتر الذي يتم تكراره

DuplicateSheetRequest

تكرِّر هذه الدالة محتوى ورقة.

تمثيل JSON
{
  "sourceSheetId": integer,
  "insertSheetIndex": integer,
  "newSheetId": integer,
  "newSheetName": string
}
الحقول
sourceSheetId

integer

ورقة البيانات المطلوب تكرارها

إذا كان مصدر ورقة البيانات من النوع DATA_SOURCE ، يتم أيضًا تكرار DataSource النسخة الاحتياطية وربطها بالنسخة الجديدة من ورقة البيانات. لا يتم تشغيل أي تنفيذ للبيانات، ويتم أيضًا نسخ بيانات الشبكة من ورقة البيانات هذه، ولكن لا تتوفّر إلا بعد اكتمال طلب الدفعة.

insertSheetIndex

integer

الفهرس الذي يبدأ من 0 والمطلوب إدراج ورقة البيانات الجديدة فيه. يتم زيادة فهرس جميع الأوراق بعد ذلك.

newSheetId

integer

إذا تم ضبطه، يكون رقم تعريف الورقة الجديدة. إذا لم يتم ضبطه، سيتم اختيار معرّف. في حال ضبطه، يجب ألا يتعارض رقم التعريف مع أي رقم تعريف حالي لورقة بيانات. إذا تم ضبطها، يجب ألا تكون سالبة.

newSheetName

string

اسم الورقة الجديدة إذا كانت فارغة، سيتم اختيار اسم جديد لك.

FindReplaceRequest

للبحث عن البيانات واستبدالها في الخلايا ضمن نطاق أو ورقة أو جميع الأوراق

تمثيل JSON
{
  "find": string,
  "replacement": string,
  "matchCase": boolean,
  "matchEntireCell": boolean,
  "searchByRegex": boolean,
  "includeFormulas": boolean,

  "range": {
    object (GridRange)
  },
  "sheetId": integer,
  "allSheets": boolean
}
الحقول
find

string

القيمة المطلوب البحث عنها.

replacement

string

القيمة المطلوب استخدامها كبديل

matchCase

boolean

صحيح إذا كانت عملية البحث حساسة لحالة الأحرف.

matchEntireCell

boolean

صحيح إذا كان يجب أن تتطابق قيمة البحث مع الخلية بأكملها.

searchByRegex

boolean

تكون القيمة صحيحة إذا كانت قيمة البحث تعبيرًا عاديًا. يجب أن يتّبع التعبير العادي والاستبدال قواعد Java regex على الرابط https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html. يُسمح لسلسلة الاستبدال بالإشارة إلى مجموعات الالتقاط. على سبيل المثال، إذا كانت إحدى الخلايا تتضمّن "Google Sheets" وكانت خلية أخرى تتضمّن "Google Docs"، سيؤدي البحث عن "o.* (.*)" واستبداله بـ "$1 Rocks" إلى تغيير محتوى الخلايا إلى "GSheets Rocks" و "GDocs Rocks" على التوالي.

includeFormulas

boolean

قيمة منطقية تحدّد ما إذا كان يجب أن يشمل البحث الخلايا التي تحتوي على صيغ. يتم ضبط القيمة على "خطأ" لتخطّي الخلايا التي تحتوي على صيغ.

حقل الربط scope النطاق الذي سيتم البحث فيه عن النص واستبداله، ويجب ضبط نطاق واحد فقط. يمكن أن يكون scope إحدى القيم التالية فقط:
range

object (GridRange)

النطاق المطلوب إجراء البحث والاستبدال فيه.

sheetId

integer

ورقة البيانات المطلوب إجراء البحث والاستبدال فيها.

allSheets

boolean

قيمة منطقية تحدّد ما إذا كان سيتم البحث عن النص واستبداله في جميع أوراق البيانات.

InsertDimensionRequest

تُدرِج هذه الدالة صفوفًا أو أعمدة في ورقة في فهرس معيّن.

تمثيل JSON
{
  "range": {
    object (DimensionRange)
  },
  "inheritFromBefore": boolean
}
الحقول
range

object (DimensionRange)

السمات المطلوب إدراجها. يجب أن يكون كلّ من فهرسَي البداية والنهاية ضمن الحدود.

inheritFromBefore

boolean

تحديد ما إذا كان يجب توسيع نطاق خصائص السمة من السمات قبل السمات المُدرَجة حديثًا أو بعدها يتم ضبط القيمة على "صحيح" للاستفادة من الأبعاد السابقة (في هذه الحالة، يجب أن يكون فهرس البدء أكبر من 0)، ويتم ضبط القيمة على "خطأ" للاستفادة من الأبعاد اللاحقة.

على سبيل المثال، إذا كان الصف ذو الفهرس 0 يحتوي على خلفية حمراء وكان الصف ذو الفهرس 1 يحتوي على خلفية خضراء، يمكن أن يرث إدراج صفَّين في الفهرس 1 الخلفية الخضراء أو الحمراء. إذا كانت قيمة inheritFromBefore صحيحة، سيكون الصفان الجديدان باللون الأحمر (لأنّ الصف الذي يسبق نقطة الإدراج كان باللون الأحمر)، أما إذا كانت قيمة inheritFromBefore خاطئة، فسيكون الصفان الجديدان باللون الأخضر (لأنّ الصف الذي يلي نقطة الإدراج كان باللون الأخضر).

InsertRangeRequest

تُدرِج هذه الدالة خلايا في نطاق، مع نقل الخلايا الحالية إلى اليسار أو الأسفل.

تمثيل JSON
{
  "range": {
    object (GridRange)
  },
  "shiftDimension": enum (Dimension)
}
الحقول
range

object (GridRange)

النطاق الذي سيتم إدراج الخلايا الجديدة فيه يقتصر النطاق على حدود الورقة الحالية.

shiftDimension

enum (Dimension)

السمة التي سيتم إزاحتها عند إدراج الخلايا. إذا كانت القيمة ROWS، سيتم نقل الخلايا الحالية إلى الأسفل. إذا كانت القيمة أقل من 0x0A، سيتم نقل الخلايا الحالية إلى اليمين.COLUMNS

MoveDimensionRequest

تنقل هذه الدالة صفًا واحدًا أو أكثر أو عمودًا واحدًا أو أكثر.

تمثيل JSON
{
  "source": {
    object (DimensionRange)
  },
  "destinationIndex": integer
}
الحقول
source

object (DimensionRange)

سمات المصدر المطلوب نقلها

destinationIndex

integer

الفهرس الأساسي الذي يبدأ من الصفر والذي يشير إلى المكان الذي سيتم نقل بيانات المصدر إليه، استنادًا إلى الإحداثيات قبل إزالة بيانات المصدر من الشبكة سيتم نقل البيانات الحالية إلى الأسفل أو اليسار (حسب السمة) لإفساح المجال للسمات التي تم نقلها. تتم إزالة سمات المصدر من الشبكة، لذا قد ينتهي الأمر بالبيانات في فهرس مختلف عن الفهرس المحدّد.

على سبيل المثال، إذا كان لديك A1..A5 من 0, 1, 2, 3, 4 وأردت نقل "1" و "2" إلى ما بين "3" و "4"، سيكون المصدر ROWS [1..3)، وسيكون فهرس الوجهة "4" (الفهرس المستند إلى الصفر للصف 5). ستكون النتيجة النهائية A1..A5 من 0, 3, 1, 2, 4.

UpdateEmbeddedObjectPositionRequest

تعديل موضع عنصر مضمَّن (مثل تحريك رسم بياني أو صورة أو تغيير حجمهما)

تمثيل JSON
{
  "objectId": integer,
  "newPosition": {
    object (EmbeddedObjectPosition)
  },
  "fields": string
}
الحقول
objectId

integer

معرّف العنصر المطلوب نقله

newPosition

object (EmbeddedObjectPosition)

موضع صريح لنقل العنصر المضمّن إليه. إذا تم ضبط newPosition.sheetId ، سيتم إنشاء ورقة بيانات جديدة بهذا المعرّف. إذا تم ضبط newPosition.newSheet على "صحيح"، سيتم إنشاء ورقة بيانات جديدة بمعرّف سيتم اختياره لك.

fields

string (FieldMask format)

حقول OverlayPosition التي يجب تعديلها عند ضبط موضع جديد. يتم استخدام هذه السمة فقط في حال ضبط قيمة newPosition.overlayPosition، وفي هذه الحالة يجب تحديد حقل واحد على الأقل. يتم تضمين الجذر newPosition.overlayPosition ضمنيًا ويجب عدم تحديده. يمكن استخدام "*" واحدة كاختصار لإدراج كل حقل.

PasteDataRequest

تُدرِج هذه الطريقة البيانات في جدول البيانات بدءًا من الإحداثيات المحدّدة.

تمثيل JSON
{
  "coordinate": {
    object (GridCoordinate)
  },
  "data": string,
  "type": enum (PasteType),

  "delimiter": string,
  "html": boolean
}
الحقول
coordinate

object (GridCoordinate)

الإحداثي الذي يجب أن يبدأ إدراج البيانات عنده.

data

string

البيانات المطلوب إدراجها

type

enum (PasteType)

كيفية لصق البيانات

حقل الربط kind كيفية تفسير البيانات، يجب ضبط قيمة واحدة بالضبط. يمكن أن يكون kind إحدى القيم التالية فقط:
delimiter

string

المُحدِّد في البيانات

html

boolean

تكون القيمة "صحيح" إذا كانت البيانات بتنسيق HTML.

TextToColumnsRequest

تقسّم هذه الدالة عمودًا من النص إلى عدة أعمدة استنادًا إلى محدّد في كل خلية.

تمثيل JSON
{
  "source": {
    object (GridRange)
  },
  "delimiter": string,
  "delimiterType": enum (DelimiterType)
}
الحقول
source

object (GridRange)

نطاق البيانات المصدر يجب أن يمتد هذا النطاق إلى عمود واحد بالضبط.

delimiter

string

المُحدِّد المطلوب استخدامه. يُستخدَم هذا الحقل فقط إذا كانت قيمة delimiterType هي CUSTOM.

delimiterType

enum (DelimiterType)

نوع المُحدِّد المطلوب استخدامه.

DelimiterType

المُحدِّد المطلوب التقسيم عنده.

عمليات التعداد
DELIMITER_TYPE_UNSPECIFIED القيمة التلقائية يجب عدم استخدام هذه القيمة.
COMMA ","
SEMICOLON ";"
PERIOD "."
SPACE " "
CUSTOM قيمة مخصّصة كما هو محدّد في المُحدِّد
AUTODETECT رصد الأعمدة تلقائيًا

UpdateFilterViewRequest

تعدّل هذه الطريقة خصائص عرض الفلتر.

تمثيل JSON
{
  "filter": {
    object (FilterView)
  },
  "fields": string
}
الحقول
filter

object (FilterView)

الخصائص الجديدة لعرض الفلتر

fields

string (FieldMask format)

الحقول التي يجب تعديلها يجب تحديد حقل واحد على الأقل. يتم تضمين الجذر filter ضمنيًا ويجب عدم تحديده. يمكن استخدام "*" واحدة كاختصار لإدراج كل حقل.

DeleteRangeRequest

تحذف هذه الدالة نطاقًا من الخلايا، وتنقل الخلايا الأخرى إلى المنطقة المحذوفة.

تمثيل JSON
{
  "range": {
    object (GridRange)
  },
  "shiftDimension": enum (Dimension)
}
الحقول
range

object (GridRange)

نطاق الخلايا المطلوب حذفه

shiftDimension

enum (Dimension)

البُعد الذي سيتم استبدال الخلايا المحذوفة به. إذا كانت القيمة ROWS، سيتم نقل الخلايا الحالية إلى الأعلى لاستبدال الخلايا المحذوفة. إذا كانت القيمة COLUMNS، سيتم نقل الخلايا الحالية إلى اليسار لاستبدال الخلايا المحذوفة.

AppendDimensionRequest

تضيف هذه الدالة صفوفًا أو أعمدة إلى نهاية ورقة.

تمثيل JSON
{
  "sheetId": integer,
  "dimension": enum (Dimension),
  "length": integer
}
الحقول
sheetId

integer

ورقة البيانات التي سيتم إلحاق الصفوف أو الأعمدة بها.

dimension

enum (Dimension)

تحديد ما إذا كان يجب إلحاق الصفوف أو الأعمدة.

length

integer

عدد الصفوف أو الأعمدة المطلوب إلحاقها.

AddConditionalFormatRuleRequest

تضيف هذه الدالة قاعدة تنسيق شرطي جديدة في الفهرس المحدّد. تتم زيادة فهارس جميع القواعد اللاحقة.

تمثيل JSON
{
  "rule": {
    object (ConditionalFormatRule)
  },
  "index": integer
}
الحقول
rule

object (ConditionalFormatRule)

القاعدة المطلوب إضافتها

index

integer

الفهرس الذي يبدأ من 0 والمطلوب إدراج القاعدة فيه.

UpdateConditionalFormatRuleRequest

تعدّل هذه الطريقة قاعدة تنسيق شرطي في الفهرس المحدّد، أو تنقل قاعدة تنسيق شرطي إلى فهرس آخر.

تمثيل JSON
{
  "index": integer,
  "sheetId": integer,

  "rule": {
    object (ConditionalFormatRule)
  },
  "newIndex": integer
}
الحقول
index

integer

الفهرس الصفري للقاعدة التي يجب استبدالها أو نقلها.

sheetId

integer

ورقة القاعدة المطلوب نقلها هذه السمة مطلوبة في حال ضبط السمة newIndex، ويتم تجاهلها في الحالات الأخرى.

حقل الربط instruction نوع التحديث الذي يجب إجراؤه. يمكن أن يكون instruction إحدى القيم التالية فقط:
rule

object (ConditionalFormatRule)

القاعدة التي يجب أن تحلّ محل القاعدة في الفهرس المحدّد

newIndex

integer

الفهرس الجديد المستند إلى الصفر الذي يجب أن تنتهي عنده القاعدة.

DeleteConditionalFormatRuleRequest

تحذف هذه الدالة قاعدة تنسيق شرطي في الفهرس المحدّد. يتم إنقاص فهارس جميع القواعد اللاحقة.

تمثيل JSON
{
  "index": integer,
  "sheetId": integer
}
الحقول
index

integer

الفهرس الصفري للقاعدة المطلوب حذفها.

sheetId

integer

ورقة البيانات التي يتم حذف القاعدة منها

SortRangeRequest

يتم فرز البيانات في الصفوف استنادًا إلى ترتيب الفرز لكل عمود.

تمثيل JSON
{
  "range": {
    object (GridRange)
  },
  "sortSpecs": [
    {
      object (SortSpec)
    }
  ]
}
الحقول
range

object (GridRange)

النطاق المطلوب ترتيبه.

sortSpecs[]

object (SortSpec)

ترتيب الفرز لكل عمود يتم استخدام المواصفات اللاحقة عندما تكون القيم متساوية في المواصفات السابقة.

SetDataValidationRequest

تضبط هذه السمة قاعدة التحقّق من صحة البيانات لكل خلية في النطاق. لمحو عملية التحقّق من الصحة في نطاق، استخدِم هذه الطريقة بدون تحديد أي قاعدة.

تمثيل JSON
{
  "range": {
    object (GridRange)
  },
  "rule": {
    object (DataValidationRule)
  },
  "filteredRowsIncluded": boolean
}
الحقول
range

object (GridRange)

النطاق الذي يجب تطبيق قاعدة التحقّق من صحة البيانات عليه

rule

object (DataValidationRule)

قاعدة التحقّق من صحة البيانات التي سيتم ضبطها على كل خلية في النطاق، أو فارغة لمحو التحقّق من صحة البيانات في النطاق

filteredRowsIncluded

boolean

اختياريّ. في حال ضبطها على "صحيح"، سيتم تطبيق قاعدة التحقّق من صحة البيانات على الصفوف التي تمّت فلترتها أيضًا.

SetBasicFilterRequest

تضبط هذه السمة الفلتر الأساسي المرتبط بورقة.

تمثيل JSON
{
  "filter": {
    object (BasicFilter)
  }
}
الحقول
filter

object (BasicFilter)

الفلتر المطلوب ضبطه.

AddProtectedRangeRequest

تضيف هذه الطريقة نطاقًا محميًا جديدًا.

تمثيل JSON
{
  "protectedRange": {
    object (ProtectedRange)
  }
}
الحقول
protectedRange

object (ProtectedRange)

النطاق المحميّ الذي سيتمّ إضافته الحقل protectedRangeId اختياري، وفي حال عدم ضبطه، سيتم إنشاء معرّف عشوائيًا. (يُعدّ تحديد رقم تعريف نطاق متوفّر من قبل خطأً).

UpdateProtectedRangeRequest

تعدّل هذه الطريقة نطاقًا محميًا حاليًا باستخدام protectedRangeId المحدّد.

تمثيل JSON
{
  "protectedRange": {
    object (ProtectedRange)
  },
  "fields": string
}
الحقول
protectedRange

object (ProtectedRange)

النطاق المحمي الذي سيتم تعديله باستخدام السمات الجديدة.

fields

string (FieldMask format)

الحقول التي يجب تعديلها يجب تحديد حقل واحد على الأقل. يتم تضمين الجذر protectedRange ضمنيًا ويجب عدم تحديده. يمكن استخدام "*" واحدة كاختصار لإدراج كل حقل.

DeleteProtectedRangeRequest

يحذف هذا الإجراء النطاق المحميّ الذي يحمل رقم التعريف المحدّد.

تمثيل JSON
{
  "protectedRangeId": integer
}
الحقول
protectedRangeId

integer

رقم تعريف النطاق المحمي المطلوب حذفه.

AutoResizeDimensionsRequest

يتم تغيير حجم سمة واحدة أو أكثر تلقائيًا استنادًا إلى محتوى الخلايا في تلك السمة.

تمثيل JSON
{

  "dimensions": {
    object (DimensionRange)
  },
  "dataSourceSheetDimensions": {
    object (DataSourceSheetDimensionRange)
  }
}
الحقول
حقل الربط dimension_range نطاق السمة يمكن أن يكون dimension_range إحدى القيم التالية فقط:
dimensions

object (DimensionRange)

السمات التي سيتم تغيير حجمها تلقائيًا.

dataSourceSheetDimensions

object (DataSourceSheetDimensionRange)

سمات ورقة مصدر البيانات التي سيتم تغيير حجمها تلقائيًا

AddChartRequest

تضيف هذه الدالة رسمًا بيانيًا إلى ورقة في جدول البيانات.

تمثيل JSON
{
  "chart": {
    object (EmbeddedChart)
  }
}
الحقول
chart

object (EmbeddedChart)

الرسم البياني الذي يجب إضافته إلى جدول البيانات، بما في ذلك الموضع الذي يجب وضعه فيه الحقل chartId اختياري، وفي حال عدم ضبطه، سيتم إنشاء معرّف عشوائيًا. (من الخطأ تحديد معرّف كائن مضمّن موجود من قبل).

UpdateChartSpecRequest

تعدّل هذه الطريقة مواصفات الرسم البياني. (لا يؤدي ذلك إلى نقل رسم بياني أو تغيير حجمه. لنقل رسم بياني أو تغيير حجمه، استخدِم UpdateEmbeddedObjectPositionRequest.)

تمثيل JSON
{
  "chartId": integer,
  "spec": {
    object (ChartSpec)
  }
}
الحقول
chartId

integer

رقم تعريف الرسم البياني المطلوب تعديله.

spec

object (ChartSpec)

تمثّل مواصفات الرسم البياني.

UpdateBandingRequest

تعدّل هذه الطريقة خصائص النطاق المحدود المقدَّم.

تمثيل JSON
{
  "bandedRange": {
    object (BandedRange)
  },
  "fields": string
}
الحقول
bandedRange

object (BandedRange)

النطاق المصنّف الذي سيتم تعديله بالخصائص الجديدة

fields

string (FieldMask format)

الحقول التي يجب تعديلها يجب تحديد حقل واحد على الأقل. يتم تضمين الجذر bandedRange ضمنيًا ويجب عدم تحديده. يمكن استخدام "*" واحدة كاختصار لإدراج كل حقل.

AddBandingRequest

تضيف هذه الدالة نطاقًا جديدًا من الألوان المتناوبة إلى جدول البيانات.

تمثيل JSON
{
  "bandedRange": {
    object (BandedRange)
  }
}
الحقول
bandedRange

object (BandedRange)

نطاق الصفوف أو الأعمدة المتناوبة المطلوب إضافته. الحقل bandedRangeId اختياري، وفي حال عدم ضبطه، سيتم إنشاء معرّف عشوائيًا. (يُعدّ تحديد رقم تعريف نطاق متوفّر من قبل خطأً).

DeleteBandingRequest

يزيل النطاق المحدود الذي يحمل رقم التعريف المحدّد من جدول البيانات.

تمثيل JSON
{
  "bandedRangeId": integer
}
الحقول
bandedRangeId

integer

تمثّل هذه السمة رقم تعريف النطاق المحدود الذي سيتم حذفه.

CreateDeveloperMetadataRequest

طلب لإنشاء بيانات وصفية للمطوّرين

تمثيل JSON
{
  "developerMetadata": {
    object (DeveloperMetadata)
  }
}
الحقول
developerMetadata

object (DeveloperMetadata)

البيانات الوصفية للمطوّر المطلوب إنشاؤها

UpdateDeveloperMetadataRequest

طلب لتعديل خصائص البيانات الوصفية للمطوّر تعدّل هذه الطريقة خصائص البيانات الوصفية للمطوّرين التي اختارتها الفلاتر إلى القيم المقدَّمة في المورد DeveloperMetadata. على المتصلين تحديد الخصائص التي يريدون تعديلها في مَعلمة الحقول، بالإضافة إلى تحديد DataFilter واحد على الأقل يتطابق مع البيانات الوصفية التي يريدون تعديلها.

تمثيل JSON
{
  "dataFilters": [
    {
      object (DataFilter)
    }
  ],
  "developerMetadata": {
    object (DeveloperMetadata)
  },
  "fields": string
}
الحقول
dataFilters[]

object (DataFilter)

الفلاتر التي تتطابق مع إدخالات البيانات الوصفية للمطوّر المطلوب تعديلها

developerMetadata

object (DeveloperMetadata)

القيمة التي سيتم تعديل جميع البيانات الوصفية المطابقة لفلاتر البيانات إليها

fields

string (FieldMask format)

الحقول التي يجب تعديلها يجب تحديد حقل واحد على الأقل. يتم تضمين الجذر developerMetadata ضمنيًا ويجب عدم تحديده. يمكن استخدام "*" واحدة كاختصار لإدراج كل حقل.

DeleteDeveloperMetadataRequest

طلب حذف البيانات الوصفية للمطوّر

تمثيل JSON
{
  "dataFilter": {
    object (DataFilter)
  }
}
الحقول
dataFilter

object (DataFilter)

فلتر البيانات الذي يصف المعايير المستخدَمة لاختيار إدخال بيانات تعريف المطوِّر الذي سيتم حذفه.

RandomizeRangeRequest

لترتيب الصفوف في نطاق بشكل عشوائي.

تمثيل JSON
{
  "range": {
    object (GridRange)
  }
}
الحقول
range

object (GridRange)

النطاق المطلوب ترتيبه عشوائيًا.

AddDimensionGroupRequest

تنشئ هذه الدالة مجموعة على النطاق المحدّد.

إذا كان النطاق المطلوب مجموعة فرعية من نطاق المجموعة الحالية G، يتم زيادة عمق G وتكون المجموعة الجديدة G' لها عمق تلك المجموعة. على سبيل المثال، تؤدي المجموعة [C:D، العمق 1] + [B:E] إلى المجموعتين [B:E، العمق 1] و[C:D، العمق 2]. إذا كان النطاق المطلوب مجموعة فرعية من نطاق المجموعة الحالية G، يصبح عمق المجموعة الجديدة G' أكبر بمقدار واحد من عمق المجموعة G. على سبيل المثال، تؤدي المجموعة [B:E، العمق 1] + [C:D] إلى المجموعتين [B:E، العمق 1] و[C:D، العمق 2]. إذا كان النطاق المطلوب يبدأ قبل نطاق المجموعة الحالية G وينتهي ضمنه، أو يبدأ ضمنه وينتهي بعده، يصبح نطاق المجموعة الحالية G هو اتحاد النطاقات، ويصبح عمق المجموعة الجديدة G' أكبر من عمق المجموعة G بمقدار واحد، ويصبح نطاقها هو تقاطع النطاقات. على سبيل المثال، تؤدي المجموعة [B:D، العمق 1] + [C:E] إلى المجموعتين [B:E، العمق 1] و[C:D، العمق 2].

تمثيل JSON
{
  "range": {
    object (DimensionRange)
  }
}
الحقول
range

object (DimensionRange)

النطاق الذي سيتم إنشاء مجموعة فيه.

DeleteDimensionGroupRequest

تحذف هذه الدالة مجموعة ضمن النطاق المحدّد عن طريق إنقاص عمق السمات في النطاق.

على سبيل المثال، لنفترض أنّ ورقة البيانات تحتوي على مجموعة بمستوى واحد فوق النطاق B:E ومجموعة بمستويَين فوق النطاق C:D. سيؤدي حذف مجموعة على النطاق D:E إلى ترك ورقة بيانات تحتوي على مجموعة بمستوى عمق 1 على النطاق B:D ومجموعة بمستوى عمق 2 على النطاق C:C.

تمثيل JSON
{
  "range": {
    object (DimensionRange)
  }
}
الحقول
range

object (DimensionRange)

نطاق المجموعة المطلوب حذفها

UpdateDimensionGroupRequest

تعدّل هذه الطريقة حالة المجموعة المحدّدة.

تمثيل JSON
{
  "dimensionGroup": {
    object (DimensionGroup)
  },
  "fields": string
}
الحقول
dimensionGroup

object (DimensionGroup)

المجموعة التي يجب تعديل حالتها يجب أن يحدّد النطاق والعمق للمجموعة مجموعة صالحة في ورقة البيانات، ويجب تعديل جميع الحقول الأخرى.

fields

string (FieldMask format)

الحقول التي يجب تعديلها يجب تحديد حقل واحد على الأقل. يتم تضمين الجذر dimensionGroup ضمنيًا ويجب عدم تحديده. يمكن استخدام "*" واحدة كاختصار لإدراج كل حقل.

TrimWhitespaceRequest

تزيل المسافات البيضاء (مثل المسافات أو علامات التبويب أو الأسطر الجديدة) في كل خلية ضمن النطاق المحدّد. يزيل هذا الطلب كل المسافات البيضاء من بداية ونهاية نص كل خلية، ويقلّل أي تسلسل لاحق من أحرف المسافات البيضاء المتبقية إلى مسافة واحدة. إذا كان النص الذي تم اقتطاعه يبدأ بالحرف "+" أو "="، يظل النص قيمة سلسلة ولا يتم تفسيره كصيغة.

تمثيل JSON
{
  "range": {
    object (GridRange)
  }
}
الحقول
range

object (GridRange)

النطاق الذي سيتم اقتطاع الخلايا منه.

DeleteDuplicatesRequest

تزيل هذه السمة الصفوف ضمن هذا النطاق التي تحتوي على قيم في الأعمدة المحدّدة تكون مكرّرة لقيم في أي صف سابق. يتم اعتبار الصفوف مكررةً إذا كانت تحتوي على قيم متطابقة، حتى وإن كانت بحالات أحرف أو تنسيقات أو صيغ مختلفة.

يزيل هذا الطلب أيضًا الصفوف المكرّرة المخفية عن العرض (على سبيل المثال، بسبب فلتر). عند إزالة الصفوف المكرّرة، يتم الاحتفاظ بالنسخة الأولى من كل صف مكرّر يتم مسحه ضوئيًا من الأعلى إلى الأسفل في النطاق الناتج. لا تتم إزالة المحتوى خارج النطاق المحدّد، ولا يجب أن تكون الصفوف التي تُعتبر مكرّرة متجاورة في النطاق.

تمثيل JSON
{
  "range": {
    object (GridRange)
  },
  "comparisonColumns": [
    {
      object (DimensionRange)
    }
  ]
}
الحقول
range

object (GridRange)

النطاق الذي ستتم إزالة الصفوف المكرّرة منه.

comparisonColumns[]

object (DimensionRange)

الأعمدة في النطاق المطلوب تحليله بحثًا عن القيم المكرّرة. في حال عدم اختيار أي أعمدة، سيتم تحليل جميع الأعمدة بحثًا عن تكرارات.

UpdateEmbeddedObjectBorderRequest

تعدّل هذه الطريقة سمة الحدود الخاصة بكائن مضمّن.

تمثيل JSON
{
  "objectId": integer,
  "border": {
    object (EmbeddedObjectBorder)
  },
  "fields": string
}
الحقول
objectId

integer

معرّف العنصر المضمّن المطلوب تعديله.

border

object (EmbeddedObjectBorder)

تمثّل هذه السمة الحدود التي تنطبق على العنصر المضمّن.

fields

string (FieldMask format)

الحقول التي يجب تعديلها يجب تحديد حقل واحد على الأقل. يتم تضمين الجذر border ضمنيًا ويجب عدم تحديده. يمكن استخدام "*" واحدة كاختصار لإدراج كل حقل.

AddSlicerRequest

تضيف هذه الدالة فلتر نطاق البيانات إلى ورقة بيانات في جدول بيانات.

تمثيل JSON
{
  "slicer": {
    object (Slicer)
  }
}
الحقول
slicer

object (Slicer)

فلتر نطاق البيانات الذي يجب إضافته إلى جدول البيانات، بما في ذلك الموضع الذي يجب وضعه فيه الحقل slicerId اختياري، وفي حال عدم ضبطه، سيتم إنشاء معرّف عشوائيًا. (يُعدّ تحديد معرّف فلتر نطاق البيانات موجودة من قبل خطأً).

UpdateSlicerSpecRequest

تعديل مواصفات أداة التقطيع (لا يؤدي ذلك إلى نقل أداة التقطيع أو تغيير حجمها. لنقل أداة التقطيع أو تغيير حجمها، استخدِم UpdateEmbeddedObjectPositionRequest.

تمثيل JSON
{
  "slicerId": integer,
  "spec": {
    object (SlicerSpec)
  },
  "fields": string
}
الحقول
slicerId

integer

معرّف فلتر نطاق البيانات المطلوب تعديله

spec

object (SlicerSpec)

المواصفات التي سيتم تطبيقها على فلتر نطاق البيانات.

fields

string (FieldMask format)

الحقول التي يجب تعديلها يجب تحديد حقل واحد على الأقل. يتم تضمين الجذر SlicerSpec ضمنيًا ويجب عدم تحديده. يمكن استخدام علامة النجمة الواحدة "*" كاختصار لإدراج كل حقل.

AddDataSourceRequest

تضيف هذه الطريقة مصدر بيانات. بعد إضافة مصدر البيانات بنجاح، يتم إنشاء ورقة بيانات مرتبطة DATA_SOURCE ويتم بدء عملية إعادة تحميل الورقة لقراءة البيانات من مصدر البيانات.

يتطلّب الطلب نطاق OAuth إضافيًا bigquery.readonly إذا كنت تضيف مصدر بيانات BigQuery.

تمثيل JSON
{
  "dataSource": {
    object (DataSource)
  }
}
الحقول
dataSource

object (DataSource)

مصدر البيانات المطلوب إضافته

UpdateDataSourceRequest

تعديل مصدر بيانات بعد تعديل مصدر البيانات بنجاح، يتم تشغيل عملية لتعديل ورقة البيانات المرتبطة DATA_SOURCE من أجل قراءة البيانات من مصدر البيانات المعدَّل.

يتطلّب الطلب نطاق OAuth إضافيًا إذا كنت بصدد تعديل مصدر بيانات BigQuery.bigquery.readonly

تمثيل JSON
{
  "dataSource": {
    object (DataSource)
  },
  "fields": string
}
الحقول
dataSource

object (DataSource)

مصدر البيانات المطلوب تعديله.

fields

string (FieldMask format)

الحقول التي يجب تعديلها يجب تحديد حقل واحد على الأقل. يتم تضمين الجذر dataSource ضمنيًا ويجب عدم تحديده. يمكن استخدام "*" واحدة كاختصار لإدراج كل حقل.

DeleteDataSourceRequest

تحذف هذه الطريقة مصدر بيانات. يؤدي الطلب أيضًا إلى حذف ورقة مصدر البيانات المرتبطة وإلغاء ربط جميع عناصر مصدر البيانات المرتبطة.

تمثيل JSON
{
  "dataSourceId": string
}
الحقول
dataSourceId

string

رقم تعريف مصدر البيانات المطلوب حذفه.

RefreshDataSourceRequest

تعيد هذه الدالة تحميل عنصر واحد أو أكثر من عناصر مصدر البيانات في جدول البيانات حسب المراجع المحدّدة.

يتطلّب الطلب نطاق OAuth إضافيًا إذا كنت بصدد إعادة تحميل مصدر بيانات BigQuery.bigquery.readonly

إذا كانت هناك طلبات إعادة تحميل متعددة تشير إلى عناصر مصدر البيانات نفسها في دفعة واحدة، سيتم تنفيذ طلب إعادة التحميل الأخير فقط، وستتلقّى جميع هذه الطلبات الردّ نفسه وفقًا لذلك.

تمثيل JSON
{
  "force": boolean,

  "references": {
    object (DataSourceObjectReferences)
  },
  "dataSourceId": string,
  "isAll": boolean
}
الحقول
force

boolean

تعيد هذه الطريقة تحميل عناصر مصدر البيانات بغض النظر عن الحالة الحالية. إذا لم يتم ضبطها وكان عنصر مصدر البيانات المُشار إليه في حالة خطأ، ستتعذّر إعادة التحميل على الفور.

حقل الربط target تحدّد هذه السمة المحتوى الذي يجب إعادة تحميله. يمكن أن يكون target إحدى القيم التالية فقط:
references

object (DataSourceObjectReferences)

مراجع لعناصر مصدر البيانات المطلوب إعادة تحميلها

dataSourceId

string

مرجع إلى DataSource في حال تحديدها، تعيد هذه السمة تحميل جميع عناصر مصدر البيانات المرتبطة بمصدر البيانات.

isAll

boolean

تعيد تحميل جميع عناصر مصدر البيانات الحالية في جدول البيانات.

DataSourceObjectReferences

قائمة بمراجع لعناصر مصدر البيانات

تمثيل JSON
{
  "references": [
    {
      object (DataSourceObjectReference)
    }
  ]
}
الحقول
references[]

object (DataSourceObjectReference)

المراجع

CancelDataSourceRefreshRequest

تلغي هذه الدالة عملية إعادة تحميل واحدة أو أكثر لعناصر مصدر البيانات في جدول البيانات حسب المراجع المحدّدة.

يتطلّب الطلب نطاق OAuth إضافيًا إذا كنت تلغي عملية إعادة تحميل مصدر بيانات BigQuery.bigquery.readonly

تمثيل JSON
{

  "references": {
    object (DataSourceObjectReferences)
  },
  "dataSourceId": string,
  "isAll": boolean
}
الحقول
حقل الربط target تحدّد هذه السمة ما يجب إلغاؤه. يمكن أن يكون target إحدى القيم التالية فقط:
references

object (DataSourceObjectReferences)

مراجع لعناصر مصدر البيانات التي سيتم إلغاء عمليات إعادة تحميلها

dataSourceId

string

مرجع إلى DataSource في حال تحديدها، تلغي جميع عمليات إعادة تحميل عناصر مصدر البيانات المرتبطة بمصدر البيانات هذا.

isAll

boolean

تلغي هذه الدالة عمليات إعادة التحميل الحالية لجميع عناصر مصدر البيانات في جدول البيانات.

AddTableRequest

تضيف هذه الدالة جدولاً جديدًا إلى جدول البيانات.

تمثيل JSON
{
  "table": {
    object (Table)
  }
}
الحقول
table

object (Table)

الحقل مطلوب. الجدول المطلوب إضافته

UpdateTableRequest

تعدّل هذه الطريقة جدولاً في جدول البيانات.

تمثيل JSON
{
  "table": {
    object (Table)
  },
  "fields": string
}
الحقول
table

object (Table)

الحقل مطلوب. الجدول المطلوب تعديله

fields

string (FieldMask format)

الحقل مطلوب. الحقول التي يجب تعديلها يجب تحديد حقل واحد على الأقل. يتم تضمين الجذر table ضمنيًا ويجب عدم تحديده. يمكن استخدام "*" واحدة كاختصار لإدراج كل حقل.

DeleteTableRequest

يزيل الجدول الذي يحمل رقم التعريف المحدّد من جدول البيانات.

تمثيل JSON
{
  "tableId": string
}
الحقول
tableId

string

رقم تعريف الجدول المطلوب حذفه.

InsertCommentRequest

تُدرج هذه الدالة CommentThread في جدول البيانات.

تمثيل JSON
{
  "content": string,
  "assigneeEmailAddress": string,

  "coordinate": {
    object (GridCoordinate)
  }
}
الحقول
content

string

تمثّل هذه السمة نص التعليق كنص عادي.

سيتم التعامل مع هذا المحتوى النصي بشكل مشابه للتعليقات التي تم إنشاؤها في محرّر "جداول بيانات Google". وسيكون لها سلوكيات مشابهة للتنسيق والإشعارات وما إلى ذلك.

لا يمكن أن يكون هذا الحقل فارغًا، ويجب ألا يتجاوز 2048 وحدة رموز UTF-8.

assigneeEmailAddress

string

اختياريّ. عنوان البريد الإلكتروني للمستخدم المُسنَد إليه التعليق.

اترك هذا الحقل فارغًا لتعيين تعليق غير مُحدّد.

يجب ألا يتجاوز 2048 وحدة رمز UTF-8.

حقل الربط anchor الموقع الجغرافي في ورقة البيانات المرتبط بهذا التعليق يمكن أن يكون anchor إحدى القيم التالية فقط:
coordinate

object (GridCoordinate)

تمثّل هذه السمة GridCoordinate في ورقة البيانات المرتبطة بهذا التعليق.

AddCommentReplyRequest

تُدرج هذه السمة ردًا Post في CommentThread.

تمثيل JSON
{
  "commentId": string,
  "post": {
    object (Post)
  }
}
الحقول
commentId

string

رقم تعريف CommentThread الذي ستتم إضافة الردّ إليه.

post

object (Post)

تمثّل Post الردّ.

UpdateCommentPostRequest

تعدّل هذه الطريقة Post في CommentThread.

يتم عرض رسالة الخطأ "400: طلب غير صالح" في الحالات التالية:

  • المستخدم الذي يطلب التعديل ليس مؤلف المشاركة.

  • تتوفّر طلبات UpdateCommentPostRequest متعددة في BatchUpdateSpreadsheetRequest نفسه لـ postId نفسه.

تمثيل JSON
{
  "commentId": string,
  "postId": string,
  "content": string
}
الحقول
commentId

string

تمثّل هذه السمة رقم تعريف CommentThread الذي تنتمي إليه المشاركة.

postId

string

معرّف المنشور الذي يتم تعديله.

content

string

تمثّل هذه السمة النص الجديد للتعليق، كنص عادي.

سيتم التعامل مع هذا المحتوى النصي بشكل مشابه للتعليقات التي تم إنشاؤها في محرّر "جداول بيانات Google". وسيكون لها سلوكيات مشابهة للتنسيق والإشعارات وما إلى ذلك.

لا يمكن أن يكون هذا الحقل فارغًا، ويجب ألا يتجاوز 2048 وحدة رموز UTF-8.

DeleteCommentRequest

يحذف هذا الإجراء CommentThread.

تعرض هذه الطريقة الخطأ 400 Bad Request إذا لم يكن المستخدم الذي يرسل الطلب هو مؤلف headPost.

تمثيل JSON
{
  "commentId": string
}
الحقول
commentId

string

تمثّل هذه السمة المعرّف الخاص بـ CommentThread الذي سيتم حذفه.

DeleteCommentReplyRequest

يحذف هذا الإجراء ردًا Post من CommentThread.

يتم عرض رسالة الخطأ "400: طلب غير صالح" في الحالات التالية:

تمثيل JSON
{
  "commentId": string,
  "postId": string
}
الحقول
commentId

string

تمثّل هذه السمة رقم تعريف CommentThread الذي تنتمي إليه المشاركة.

postId

string

معرّف الرد Post الذي سيتم حذفه.