Requests

درخواست

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

نمایندگی JSON
{

  // Union field kind can be only one of the following:
  "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)
  }
  // End of list of possible types for union field kind.
}
زمینه های
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 )

یک یا چند منبع داده و dbobject های مرتبط را تازه می کند.

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,

  // Union field dimension_range can be only one of the following:
  "range": {
    object (DimensionRange)
  },
  "dataSourceSheetRange": {
    object (DataSourceSheetDimensionRange)
  }
  // End of list of possible types for union field dimension_range.
}
زمینه های
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 مرتبط نیز حذف می شود.

درخواست تکمیل خودکار

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

نمایندگی JSON
{
  "useAlternateSeries": boolean,

  // Union field area can be only one of the following:
  "range": {
    object (GridRange)
  },
  "sourceAndDestination": {
    object (SourceAndDestination)
  }
  // End of list of possible types for union field area.
}
زمینه های
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

چه نوع داده هایی باید چسبانده شوند.

Enums
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

عملیات خمیری چگونه باید انجام شود.

Enums
NORMAL به طور معمولی بچسبانید.
TRANSPOSE جابجایی جابجا شده، جایی که همه سطرها تبدیل به ستون می شوند و بالعکس.

MergeCellsRequest

تمام سلول های محدوده را ادغام می کند.

نمایندگی JSON
{
  "range": {
    object (GridRange)
  },
  "mergeType": enum (MergeType)
}
زمینه های
range

object ( GridRange )

محدوده سلول هایی که باید ادغام شوند.

mergeType

enum ( MergeType )

چگونه سلول ها باید ادغام شوند.

MergeType

نوع ادغام برای ایجاد.

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

  // Union field area can be only one of the following:
  "start": {
    object (GridCoordinate)
  },
  "range": {
    object (GridRange)
  }
  // End of list of possible types for union field area.
}
زمینه های
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
}
زمینه های
sheetId

integer

شناسه برگه برای الحاق داده ها به.

rows[]

object ( RowData )

داده ها برای پیوست

fields

string ( FieldMask format)

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

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

شاخص مبتنی بر صفر که در آن صفحه جدید باید درج شود. شاخص تمام برگه ها بعد از این افزایش می یابد.

newSheetId

integer

در صورت تنظیم، شناسه برگه جدید. اگر تنظیم نشود، یک شناسه انتخاب می شود. در صورت تنظیم، شناسه نباید با شناسه برگه موجود تضاد داشته باشد. اگر تنظیم شود، باید غیر منفی باشد.

newSheetName

string

نام برگه جدید. اگر خالی باشد، نام جدیدی برای شما انتخاب می شود.

FindReplaceRequest

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

نمایندگی JSON
{
  "find": string,
  "replacement": string,
  "matchCase": boolean,
  "matchEntireCell": boolean,
  "searchByRegex": boolean,
  "includeFormulas": boolean,

  // Union field scope can be only one of the following:
  "range": {
    object (GridRange)
  },
  "sheetId": integer,
  "allSheets": boolean
  // End of list of possible types for union field scope.
}
زمینه های
find

string

ارزش جستجو

replacement

string

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

matchCase

boolean

اگر جستجو به حروف کوچک و بزرگ حساس باشد درست است.

matchEntireCell

boolean

درست است اگر مقدار find باید با کل سلول مطابقت داشته باشد.

searchByRegex

boolean

اگر مقدار find یک regex باشد درست است. عبارت منظم و جایگزینی باید از قوانین regex جاوا در https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html پیروی کند. رشته جایگزین مجاز است به گروه های ضبط کننده اشاره کند. به عنوان مثال، اگر یک سلول دارای محتوای "Google Sheets" و دیگری دارای "Google Docs" باشد، جستجوی "o.* (.*)" با جایگزینی "$1 Rocks" محتویات سلول‌ها را به "GSheets 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 دارای پس‌زمینه سبز باشد، درج 2 ردیف در نمایه 1 می‌تواند پس‌زمینه سبز یا قرمز را به ارث ببرد. اگر inheritFromBefore درست باشد، دو سطر جدید قرمز خواهند بود (زیرا ردیف قبل از نقطه درج قرمز بود)، در حالی که اگر inheritFromBefore نادرست باشد، دو سطر جدید سبز خواهند بود (زیرا ردیف بعد از نقطه درج سبز بود).

InsertRangeRequest

سلول‌ها را در یک محدوده قرار می‌دهد و سلول‌های موجود را به بالا یا پایین تغییر می‌دهد.

نمایندگی JSON
{
  "range": {
    object (GridRange)
  },
  "shiftDimension": enum (Dimension)
}
زمینه های
range

object ( GridRange )

محدوده برای درج سلول های جدید.

shiftDimension

enum ( Dimension )

ابعادی که هنگام درج سلول ها تغییر می کند. اگر ROWS باشد، سلول‌های موجود به پایین منتقل می‌شوند. اگر 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 روی true تنظیم شود، یک برگه جدید با شناسه ای ایجاد می شود که برای شما انتخاب می شود.

fields

string ( FieldMask format)

فیلدهای OverlayPosition که باید هنگام تنظیم موقعیت جدید به روز شوند. فقط در صورتی استفاده می شود که newPosition.overlayPosition تنظیم شده باشد، در این صورت حداقل یک فیلد باید مشخص شود. ریشه newPosition.overlayPosition ضمنی است و نباید مشخص شود. برای فهرست کردن هر فیلد می توان از یک "*" به عنوان علامت کوتاه استفاده کرد.

PasteDataRequest

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

نمایندگی JSON
{
  "coordinate": {
    object (GridCoordinate)
  },
  "data": string,
  "type": enum (PasteType),

  // Union field kind can be only one of the following:
  "delimiter": string,
  "html": boolean
  // End of list of possible types for union field kind.
}
زمینه های
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

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

Enums
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

شاخص مبتنی بر صفر که در آن قانون باید درج شود.

UpdateConditionalFormatRuleRequest

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

نمایندگی JSON
{
  "index": integer,
  "sheetId": integer,

  // Union field instruction can be only one of the following:
  "rule": {
    object (ConditionalFormatRule)
  },
  "newIndex": integer
  // End of list of possible types for union field instruction.
}
زمینه های
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)
  }
}
زمینه های
range

object ( GridRange )

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

rule

object ( DataValidationRule )

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

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)

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

DeleteProtectedRangeRequest

محدوده محافظت شده را با شناسه داده شده حذف می کند.

نمایندگی JSON
{
  "protectedRangeId": integer
}
زمینه های
protectedRangeId

integer

شناسه محدوده محافظت شده برای حذف.

AutoResizeDimensionsRequest

به طور خودکار اندازه یک یا چند بعد را بر اساس محتویات سلول های آن بعد تغییر می دهد.

نمایندگی JSON
{

  // Union field dimension_range can be only one of the following:
  "dimensions": {
    object (DimensionRange)
  },
  "dataSourceSheetDimensions": {
    object (DataSourceSheetDimensionRange)
  }
  // End of list of possible types for union field dimension_range.
}
زمینه های
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)

فیلدهایی که باید به روز شوند. حداقل یک فیلد باید مشخص شود. root 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

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

به عنوان مثال، فرض کنید ورق دارای یک گروه عمق-1 روی B:E و یک گروه عمق-2 روی 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 اضافی نیاز دارد.

نمایندگی JSON
{
  "dataSource": {
    object (DataSource)
  }
}
زمینه های
dataSource

object ( DataSource )

منبع داده برای اضافه کردن

UpdateDataSourceRequest

یک منبع داده را به روز می کند. پس از به‌روزرسانی موفقیت‌آمیز منبع داده، اجرایی برای بازخوانی برگه DATA_SOURCE مرتبط برای خواندن داده‌ها از منبع داده به‌روزرسانی شده آغاز می‌شود. این درخواست به یک دامنه OAuth 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.readonly اضافی نیاز دارد.

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

نمایندگی JSON
{
  "force": boolean,

  // Union field target can be only one of the following:
  "references": {
    object (DataSourceObjectReferences)
  },
  "dataSourceId": string,
  "isAll": boolean
  // End of list of possible types for union field target.
}
زمینه های
force

boolean

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

target میدانی اتحادیه مشخص می کند چه چیزی باید بازخوانی شود. target فقط می تواند یکی از موارد زیر باشد:
references

object ( DataSourceObjectReferences )

ارجاع به اشیاء منبع داده برای تازه کردن.

dataSourceId

string

ارجاع به یک DataSource اگر مشخص شده باشد، همه اشیاء منبع داده مرتبط را برای منبع داده بازخوانی می کند.

isAll

boolean

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

DataSourceObjectReferences

فهرستی از ارجاعات به اشیاء منبع داده.

نمایندگی JSON
{
  "references": [
    {
      object (DataSourceObjectReference)
    }
  ]
}
زمینه های
references[]

object ( DataSourceObjectReference )

مراجع

DataSourceObjectReference

ارجاع به یک شی منبع داده

نمایندگی JSON
{

  // Union field value can be only one of the following:
  "sheetId": string,
  "chartId": integer,
  "dataSourceTableAnchorCell": {
    object (GridCoordinate)
  },
  "dataSourcePivotTableAnchorCell": {
    object (GridCoordinate)
  },
  "dataSourceFormulaCell": {
    object (GridCoordinate)
  }
  // End of list of possible types for union field value.
}
زمینه های
value فیلد اتحادیه نوع مرجع. value فقط می تواند یکی از موارد زیر باشد:
sheetId

string

ارجاع به برگه DATA_SOURCE .

chartId

integer

ارجاع به نمودار منبع داده

dataSourceTableAnchorCell

object ( GridCoordinate )

ارجاع به DataSourceTable که در سلول لنگر انداخته است.

dataSourcePivotTableAnchorCell

object ( GridCoordinate )

ارجاع به یک منبع داده PivotTable که در سلول لنگر انداخته است.

dataSourceFormulaCell

object ( GridCoordinate )

ارجاع به سلول حاوی DataSourceFormula .