Responses

پاسخ

یک پاسخ از یک به روز رسانی.

نمایندگی JSON 
{

  // Union field kind can be only one of the following:
  "addNamedRange": {
    object (AddNamedRangeResponse)
  },
  "addSheet": {
    object (AddSheetResponse)
  },
  "addFilterView": {
    object (AddFilterViewResponse)
  },
  "duplicateFilterView": {
    object (DuplicateFilterViewResponse)
  },
  "duplicateSheet": {
    object (DuplicateSheetResponse)
  },
  "findReplace": {
    object (FindReplaceResponse)
  },
  "updateEmbeddedObjectPosition": {
    object (UpdateEmbeddedObjectPositionResponse)
  },
  "updateConditionalFormatRule": {
    object (UpdateConditionalFormatRuleResponse)
  },
  "deleteConditionalFormatRule": {
    object (DeleteConditionalFormatRuleResponse)
  },
  "addProtectedRange": {
    object (AddProtectedRangeResponse)
  },
  "addChart": {
    object (AddChartResponse)
  },
  "addBanding": {
    object (AddBandingResponse)
  },
  "createDeveloperMetadata": {
    object (CreateDeveloperMetadataResponse)
  },
  "updateDeveloperMetadata": {
    object (UpdateDeveloperMetadataResponse)
  },
  "deleteDeveloperMetadata": {
    object (DeleteDeveloperMetadataResponse)
  },
  "addDimensionGroup": {
    object (AddDimensionGroupResponse)
  },
  "deleteDimensionGroup": {
    object (DeleteDimensionGroupResponse)
  },
  "trimWhitespace": {
    object (TrimWhitespaceResponse)
  },
  "deleteDuplicates": {
    object (DeleteDuplicatesResponse)
  },
  "addSlicer": {
    object (AddSlicerResponse)
  },
  "addDataSource": {
    object (AddDataSourceResponse)
  },
  "updateDataSource": {
    object (UpdateDataSourceResponse)
  },
  "refreshDataSource": {
    object (RefreshDataSourceResponse)
  },
  "cancelDataSourceRefresh": {
    object (CancelDataSourceRefreshResponse)
  }
  // End of list of possible types for union field kind.
}
فیلدها
kind میدان اتحادیه . نوع پاسخ. اگر درخواست پاسخی نداشت، ممکن است هیچ فیلدی تنظیم نشده باشد. kind می تواند تنها یکی از موارد زیر باشد:
addNamedRange

object ( AddNamedRangeResponse )

پاسخی از افزودن یک محدوده با نام.

addSheet

object ( AddSheetResponse )

پاسخی از افزودن یک برگه.

addFilterView

object ( AddFilterViewResponse )

پاسخی از افزودن نمای فیلتر.

duplicateFilterView

object ( DuplicateFilterViewResponse )

پاسخی از کپی کردن نمای فیلتر.

duplicateSheet

object ( DuplicateSheetResponse )

پاسخی از کپی کردن یک برگه.

findReplace

object ( FindReplaceResponse )

پاسخی از انجام یافتن/جایگزینی.

updateEmbeddedObjectPosition

object ( UpdateEmbeddedObjectPositionResponse )

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

updateConditionalFormatRule

object ( UpdateConditionalFormatRuleResponse )

پاسخی از به‌روزرسانی یک قانون قالب مشروط.

deleteConditionalFormatRule

object ( DeleteConditionalFormatRuleResponse )

پاسخی از حذف یک قانون قالب مشروط.

addProtectedRange

object ( AddProtectedRangeResponse )

پاسخی از افزودن یک محدوده محافظت شده.

addChart

object ( AddChartResponse )

پاسخی از افزودن نمودار.

addBanding

object ( AddBandingResponse )

پاسخی از افزودن یک محدوده نواری.

createDeveloperMetadata

object ( CreateDeveloperMetadataResponse )

پاسخی از ایجاد یک ورودی فراداده توسعه‌دهنده.

updateDeveloperMetadata

object ( UpdateDeveloperMetadataResponse )

پاسخی از به‌روزرسانی ورودی فراداده برنامه‌نویس.

deleteDeveloperMetadata

object ( DeleteDeveloperMetadataResponse )

پاسخی از حذف یک ورودی فراداده برنامه‌نویس.

addDimensionGroup

object ( AddDimensionGroupResponse )

پاسخی از افزودن یک گروه بعد.

deleteDimensionGroup

object ( DeleteDimensionGroupResponse )

پاسخی از حذف یک گروه بعد.

trimWhitespace

object ( TrimWhitespaceResponse )

پاسخی از کوتاه کردن فضای خالی.

deleteDuplicates

object ( DeleteDuplicatesResponse )

پاسخی از حذف ردیف های حاوی مقادیر تکراری.

addSlicer

object ( AddSlicerResponse )

پاسخی از افزودن اسلایسر.

addDataSource

object ( AddDataSourceResponse )

پاسخی از افزودن منبع داده.

updateDataSource

object ( UpdateDataSourceResponse )

پاسخی از به‌روزرسانی منبع داده.

refreshDataSource

object ( RefreshDataSourceResponse )

پاسخی از تازه کردن اشیاء منبع داده.

cancelDataSourceRefresh

object ( CancelDataSourceRefreshResponse )

یک پاسخ از لغو شی منبع داده بازخوانی می شود.

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 .

AddNamedRangeResponse

نتیجه اضافه کردن یک محدوده نامگذاری شده.

نمایندگی JSON 
{
  "namedRange": {
    object (NamedRange)
  }
}
فیلدها
namedRange

object ( NamedRange )

محدوده نامگذاری شده برای افزودن.

AddSheetResponse

نتیجه اضافه کردن یک ورق.

نمایندگی JSON 
{
  "properties": {
    object (SheetProperties)
  }
}
فیلدها
properties

object ( SheetProperties )

خواص ورق تازه اضافه شده.

AddFilterViewResponse

نتیجه افزودن نمای فیلتر.

نمایندگی JSON 
{
  "filter": {
    object (FilterView)
  }
}
فیلدها
filter

object ( FilterView )

نمای فیلتر جدید اضافه شده

DuplicateFilterViewResponse

نتیجه یک نمای فیلتر تکراری است.

نمایندگی JSON 
{
  "filter": {
    object (FilterView)
  }
}
فیلدها
filter

object ( FilterView )

فیلتر جدید ایجاد شده

DuplicateSheetResponse

نتیجه کپی کردن یک برگه.

نمایندگی JSON 
{
  "properties": {
    object (SheetProperties)
  }
}
فیلدها
properties

object ( SheetProperties )

ویژگی های برگه تکراری

FindReplaceResponse

نتیجه یافتن/جایگزینی

نمایندگی JSON 
{
  "valuesChanged": integer,
  "formulasChanged": integer,
  "rowsChanged": integer,
  "sheetsChanged": integer,
  "occurrencesChanged": integer
}
فیلدها
valuesChanged

integer

تعداد سلول های غیر فرمول تغییر کرد.

formulasChanged

integer

تعداد سلول های فرمول تغییر کرد.

rowsChanged

integer

تعداد ردیف ها تغییر کرد.

sheetsChanged

integer

تعداد برگه ها تغییر کرد.

occurrencesChanged

integer

تعداد رخدادها (احتمالاً چندگانه در یک سلول) تغییر کرد. برای مثال، اگر در "Google Sheets" "e" با "o" جایگزین کنید، این "3" خواهد بود، زیرا "Google Sheets" -> "Googlo Shoots" .

UpdateEmbeddedObjectPositionResponse

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

نمایندگی JSON 
{
  "position": {
    object (EmbeddedObjectPosition)
  }
}
فیلدها
position

object ( EmbeddedObjectPosition )

موقعیت جدید شی جاسازی شده

UpdateConditionalFormatRuleResponse

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

نمایندگی JSON 
{
  "newRule": {
    object (ConditionalFormatRule)
  },
  "newIndex": integer,

  // Union field old_info can be only one of the following:
  "oldRule": {
    object (ConditionalFormatRule)
  },
  "oldIndex": integer
  // End of list of possible types for union field old_info.
}
فیلدها
newRule

object ( ConditionalFormatRule )

قانون جدیدی که جایگزین قانون قدیمی شد (در صورت جایگزینی)، یا قانونی که جابجا شد (در صورت جابجایی)

newIndex

integer

شاخص قانون جدید.

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

object ( ConditionalFormatRule )

قانون قدیمی (حذف شده). در صورت جابجایی قانون تنظیم نمی شود (زیرا همان newRule است).

oldIndex

integer

شاخص قدیمی قاعده. اگر قانون جایگزین شود تنظیم نمی شود (زیرا همان newIndex است).

DeleteConditionalFormatRuleResponse

نتیجه حذف یک قانون قالب شرطی.

نمایندگی JSON 
{
  "rule": {
    object (ConditionalFormatRule)
  }
}
فیلدها
rule

object ( ConditionalFormatRule )

قانونی که حذف شد.

AddProtectedRangeResponse

نتیجه اضافه کردن یک محدوده محافظت شده جدید.

نمایندگی JSON 
{
  "protectedRange": {
    object (ProtectedRange)
  }
}
فیلدها
protectedRange

object ( ProtectedRange )

محدوده حفاظت شده جدید اضافه شده

AddChartResponse

نتیجه اضافه کردن نمودار به صفحه گسترده.

نمایندگی JSON 
{
  "chart": {
    object (EmbeddedChart)
  }
}
فیلدها
chart

object ( EmbeddedChart )

نمودار جدید اضافه شده

AddBandingResponse

نتیجه اضافه کردن یک محدوده نواری.

نمایندگی JSON 
{
  "bandedRange": {
    object (BandedRange)
  }
}
فیلدها
bandedRange

object ( BandedRange )

محدوده نواری که اضافه شد.

CreateDeveloperMetadataResponse

پاسخ از ایجاد ابرداده توسعه دهنده.

نمایندگی JSON 
{
  "developerMetadata": {
    object (DeveloperMetadata)
  }
}
فیلدها
developerMetadata

object ( DeveloperMetadata )

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

UpdateDeveloperMetadataResponse

پاسخ از به‌روزرسانی ابرداده توسعه‌دهنده.

نمایندگی JSON 
{
  "developerMetadata": [
    {
      object (DeveloperMetadata)
    }
  ]
}
فیلدها
developerMetadata[]

object ( DeveloperMetadata )

ابرداده توسعه‌دهنده به‌روزرسانی شده

DeleteDeveloperMetadataResponse

پاسخ حذف ابرداده برنامه‌نویس.

نمایندگی JSON 
{
  "deletedDeveloperMetadata": [
    {
      object (DeveloperMetadata)
    }
  ]
}
فیلدها
deletedDeveloperMetadata[]

object ( DeveloperMetadata )

ابرداده ای که حذف شد.

AddDimensionGroupResponse

نتیجه اضافه کردن یک گروه

نمایندگی JSON 
{
  "dimensionGroups": [
    {
      object (DimensionGroup)
    }
  ]
}
فیلدها
dimensionGroups[]

object ( DimensionGroup )

همه گروه های یک بعد پس از افزودن یک گروه به آن بعد.

DeleteDimensionGroupResponse

نتیجه حذف یک گروه

نمایندگی JSON 
{
  "dimensionGroups": [
    {
      object (DimensionGroup)
    }
  ]
}
فیلدها
dimensionGroups[]

object ( DimensionGroup )

همه گروه های یک بعد پس از حذف یک گروه از آن بعد.

TrimWhitespaceResponse

نتیجه کوتاه کردن فضای سفید در سلول ها.

نمایندگی JSON 
{
  "cellsChangedCount": integer
}
فیلدها
cellsChangedCount

integer

تعداد سلول هایی که از فضای خالی بریده شده اند.

DeleteDuplicatesResponse

نتیجه حذف موارد تکراری در یک محدوده.

نمایندگی JSON 
{
  "duplicatesRemovedCount": integer
}
فیلدها
duplicatesRemovedCount

integer

تعداد ردیف های تکراری حذف شده است.

AddSlicerResponse

نتیجه اضافه کردن یک برش دهنده به صفحه گسترده.

نمایندگی JSON 
{
  "slicer": {
    object (Slicer)
  }
}
فیلدها
slicer

object ( Slicer )

اسلایسر تازه اضافه شده

AddDataSourceResponse

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

نمایندگی JSON 
{
  "dataSource": {
    object (DataSource)
  },
  "dataExecutionStatus": {
    object (DataExecutionStatus)
  }
}
فیلدها
dataSource

object ( DataSource )

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

dataExecutionStatus

object ( DataExecutionStatus )

وضعیت اجرای داده ها

UpdateDataSourceResponse

پاسخ از به روز رسانی منبع داده.

نمایندگی JSON 
{
  "dataSource": {
    object (DataSource)
  },
  "dataExecutionStatus": {
    object (DataExecutionStatus)
  }
}
فیلدها
dataSource

object ( DataSource )

منبع داده به روز شده

dataExecutionStatus

object ( DataExecutionStatus )

وضعیت اجرای داده ها

RefreshDataSourceResponse

پاسخ از تازه کردن یک یا چند شی منبع داده.

نمایندگی JSON 
{
  "statuses": [
    {
      object (RefreshDataSourceObjectExecutionStatus)
    }
  ]
}
فیلدها
statuses[]

object ( RefreshDataSourceObjectExecutionStatus )

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

RefreshDataSourceObjectExecutionStatus

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

نمایندگی JSON 
{
  "reference": {
    object (DataSourceObjectReference)
  },
  "dataExecutionStatus": {
    object (DataExecutionStatus)
  }
}
فیلدها
reference

object ( DataSourceObjectReference )

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

dataExecutionStatus

object ( DataExecutionStatus )

وضعیت اجرای داده ها

CancelDataSourceRefreshResponse

پاسخ از لغو یک یا چند شی منبع داده بازخوانی می شود.

نمایندگی JSON 
{
  "statuses": [
    {
      object (CancelDataSourceRefreshStatus)
    }
  ]
}
فیلدها
statuses[]

object ( CancelDataSourceRefreshStatus )

وضعیت‌های لغو تازه‌سازی همه اشیاء منبع داده مشخص‌شده در درخواست. اگر isAll مشخص شده باشد، فیلد فقط شامل مواردی است که در وضعیت خرابی هستند. بازخوانی و لغو بازخوانی همان شی منبع داده نیز در همان batchUpdate مجاز نیست.

CancelDataSourceRefreshStatus

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

نمایندگی JSON 
{
  "reference": {
    object (DataSourceObjectReference)
  },
  "refreshCancellationStatus": {
    object (RefreshCancellationStatus)
  }
}
فیلدها
reference

object ( DataSourceObjectReference )

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

refreshCancellationStatus

object ( RefreshCancellationStatus )

وضعیت لغو

Refresh Cancellation Status

وضعیت لغو تجدید.

می‌توانید یک cancel request برای لغو صریح یک یا چند رفرش شی منبع داده ارسال کنید.

نمایندگی JSON 
{
  "state": enum (RefreshCancellationState),
  "errorCode": enum (RefreshCancellationErrorCode)
}
فیلدها
state

enum ( RefreshCancellationState )

وضعیت تماس برای لغو بازخوانی در کاربرگ‌نگار.

errorCode

enum ( RefreshCancellationErrorCode )

کد خطا

RefreshCancellationState

شمارشی از حالات لغو تجدید.

Enums
REFRESH_CANCELLATION_STATE_UNSPECIFIED مقدار پیش فرض، استفاده نکنید.
CANCEL_SUCCEEDED فراخوانی API به کاربرگ‌نگار برای لغو بازخوانی با موفقیت انجام شد. این بدان معنا نیست که لغو با موفقیت انجام شده است، بلکه به این معنی است که تماس با موفقیت انجام شده است.
CANCEL_FAILED تماس API به کاربرگ‌نگار برای لغو یک بازخوانی انجام نشد.

RefreshCancellationErrorCode

شمارشی از کدهای خطای لغو بازخوانی.

Enums
REFRESH_CANCELLATION_ERROR_CODE_UNSPECIFIED مقدار پیش فرض، استفاده نکنید.
EXECUTION_NOT_FOUND اجرای برای لغو در موتور جستجو یا در برگه‌ها یافت نشد.
CANCEL_PERMISSION_DENIED کاربر اجازه لغو درخواست را ندارد.
QUERY_EXECUTION_COMPLETED اجرای پرس و جو قبلاً تکمیل شده است و بنابراین نمی توان آن را لغو کرد.
CONCURRENT_CANCELLATION در حال حاضر لغو دیگری در حال انجام است.
CANCEL_OTHER_ERROR تمام خطاهای دیگر