Responses

پاسخ

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

نمایش JSON 
{

  "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)
  },
  "addTable": {
    object (AddTableResponse)
  }
}
فیلدها
فیلد Union 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 )

پاسخی از لغو به‌روزرسانی‌های شیء منبع داده دریافت می‌شود.

addTable

object ( AddTableResponse )

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

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

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

نمایش JSON 
{

  "sheetId": string,
  "chartId": integer,
  "dataSourceTableAnchorCell": {
    object (GridCoordinate)
  },
  "dataSourcePivotTableAnchorCell": {
    object (GridCoordinate)
  },
  "dataSourceFormulaCell": {
    object (GridCoordinate)
  }
}
فیلدها
value فیلد Union. نوع مرجع. value می‌تواند فقط یکی از موارد زیر باشد:
sheetId

string

ارجاعات به یک برگه DATA_SOURCE .

chartId

integer

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

dataSourceTableAnchorCell

object ( GridCoordinate )

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

dataSourcePivotTableAnchorCell

object ( GridCoordinate )

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

dataSourceFormulaCell

object ( GridCoordinate )

ارجاع به سلولی که شامل DataSourceFormula است.

پاسخ AddNamedRange

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

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

object ( NamedRange )

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

پاسخ AddSheet

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

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

object ( SheetProperties )

ویژگی‌های برگه تازه اضافه شده.

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

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

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

object ( FilterView )

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

پاسخ فیلتر تکراری

نتیجه‌ی کپی شدن یک نمای فیلتر.

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

object ( FilterView )

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

پاسخ DuplicateSheet

نتیجه تکثیر یک ورق.

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

object ( SheetProperties )

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

یافتن جایگزین پاسخ

نتیجه‌ی عملیات یافتن/جایگزینی.

نمایش 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 )

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

پاسخ UpdateConditionalFormatRule

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

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

  "oldRule": {
    object (ConditionalFormatRule)
  },
  "oldIndex": integer
}
فیلدها
newRule

object ( ConditionalFormatRule )

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

newIndex

integer

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

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

object ( ConditionalFormatRule )

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

oldIndex

integer

اندیس قدیمیِ قاعده. اگر قاعده‌ای جایگزین شده باشد، تنظیم نمی‌شود (زیرا مشابه newIndex است).

پاسخ DeleteConditionalFormatRule

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

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

object ( ConditionalFormatRule )

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

پاسخ AddProtectedRange

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

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

object ( ProtectedRange )

محدوده حفاظت‌شده‌ای که به تازگی اضافه شده است.

پاسخ AddChart

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

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

object ( EmbeddedChart )

نمودار تازه اضافه شده.

پاسخ AddBanding

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

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

object ( BandedRange )

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

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

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

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

object ( DeveloperMetadata )

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

پاسخ UpdateDeveloperMetadata

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

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

object ( DeveloperMetadata )

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

پاسخ DeleteDeveloperMetadata

پاسخ ناشی از حذف فراداده‌های توسعه‌دهنده.

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

object ( DeveloperMetadata )

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

AddDimensionGroupResponse

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

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

object ( DimensionGroup )

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

پاسخ DeleteDimensionGroup

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

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

object ( DimensionGroup )

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

TrimWhitespaceResponse

نتیجه‌ی حذف فضای خالی در سلول‌ها.

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

integer

تعداد سلول‌هایی که فضای خالی آنها حذف شده است.

حذف پاسخ‌های تکراری

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

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

integer

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

پاسخ AddSlicer

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

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

object ( Slicer )

برش‌دهنده‌ای که تازه اضافه شده.

افزودن منبع داده (AddDataSourceResponse)

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

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

object ( DataSource )

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

dataExecutionStatus

object ( DataExecutionStatus )

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

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

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

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

object ( DataSource )

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

dataExecutionStatus

object ( DataExecutionStatus )

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

RefreshDataSourceResponse

پاسخ حاصل از به‌روزرسانی یک یا چند شیء منبع داده.

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

object ( RefreshDataSourceObjectExecutionStatus )

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

وضعیت اجرای شیء منبع داده (RefreshDataSourceObjectExecutionStatus)

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

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

object ( DataSourceObjectReference )

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

dataExecutionStatus

object ( DataExecutionStatus )

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

لغو منبع داده، تازه کردن پاسخ

پاسخ حاصل از لغو یک یا چند شیء منبع داده، رفرش می‌شود.

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

object ( CancelDataSourceRefreshStatus )

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

لغومنبع دادهبازخوانیوضعیت

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

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

object ( DataSourceObjectReference )

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

refreshCancellationStatus

object ( RefreshCancellationStatus )

وضعیت لغو.

وضعیت لغو به‌روزرسانی

وضعیت لغو به‌روزرسانی.

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

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

enum ( RefreshCancellationState )

وضعیت فراخوانی برای لغو به‌روزرسانی در Sheets.

errorCode

enum ( RefreshCancellationErrorCode )

کد خطا.

وضعیت لغو به‌روزرسانی

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

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

کد خطای لغو به‌روزرسانی

فهرستی از کدهای خطای لغو به‌روزرسانی.

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

پاسخ AddTable

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

نمایش JSON 
{
  "table": {
    object (Table)
  }
}
فیلدها
table

object ( Table )

فقط خروجی. جدولی که اضافه شده است.