Защита и рецензирование

Защита листа и книги, разрешения на диапазоны, аудит защиты, отслеживание изменений, примечания и рукописные пометки. Термины — в глоссарии.

Операции на этой странице — 8

• apply_track_insert_delete
• apply_track_visibility
• protected_ranges_permissions
• protection_inspector_audit
• review_annotations_lifecycle
• review_ink_lifecycle
• set_sheet_protection_bounded
• workbook_protection_lifecycle

apply_track_insert_delete

Применяет track insert delete.

Запрос

Поле	Тип TypeScript	Обяз.
operation	"apply_track_insert_delete"	да
expectedRevision	number | null	нет
subsetId	string	да
sheetKey	string	да
axis	ContractTrackAxis	да
index	number	да
action	ContractTrackStructureAction	да
scope	CellRange | null	нет
count	number	нет
insertedHeaderText	string | null	нет
viewport	ViewportWindow | null	нет
requestedBackend	ComputeBackendKind | null	нет

Ответ при успехе · apply_track_insert_delete

Поле	Тип TypeScript	Обяз.
operation	"apply_track_insert_delete"	да
subsetId	string	да
session	ContractSubsetSessionInfo	да
supportedSubset	string	да
delta	DeltaSummary	да
axis	ContractTrackAxis	да
index	number	да
action	ContractTrackStructureAction	да
scope	CellRange | null	нет
count	number	да
changedRows	number[]	да
changedColumns	number[]	да
shiftedCellCount	number	да
removedCellCount	number	да
trackStructureClaim	"live_verified"	да
structureScope	| “active_visible_value_track_current_sheet” | “active_visible_value_and_simple_formula_insert_current_sheet” | “active_visible_value_and_simple_formula_structure_current_sheet” | “table_scoped_sparse_structure_current_sheet”	да
formulaReferenceRewriteClaim	| “no” | “insert_only_bounded_same_sheet_refs” | “bounded_same_sheet_refs”	да
mergeReferenceRewriteClaim	"no" | “bounded_track_merge_refs”	да
workbookHistory	ContractWorkbookHistoryProjection	да
dirtyCellCount	number	да
currentSourceSaveReadiness	ContractCurrentSourceSaveReadiness | null	нет
activeSheet	ContractActiveSheetMeta	да
geometry	ContractGeometrySubset	да
recalcNeeded	boolean	да
viewport	ViewportWindow	да
previewCells	ContractPreviewCell[]	да
layoutMetrics	ContractLayoutMetricsSubset	да

Минимальный JSON-шаблон

{
  "operation": "apply_track_insert_delete",
  "subsetId": "<subsetId>",
  "sheetKey": "<sheetPath>",
  "axis": "<ContractTrackAxis>",
  "index": 0,
  "action": "<ContractTrackStructureAction>",
  "requestedBackend": "native-desktop"
}

apply_track_visibility

Применяет track visibility.

Запрос

Поле	Тип TypeScript	Обяз.
operation	"apply_track_visibility"	да
subsetId	string	да
sheetKey	string	да
axis	ContractTrackAxis	да
visibilityOwner	ContractTrackVisibilityOwner	нет
index	number | null	нет
indices	number[]	нет
replaceOwnerProjection	boolean	нет
hidden	boolean	да
viewport	ViewportWindow | null	нет
requestedBackend	ComputeBackendKind | null	нет

Ответ при успехе · apply_track_visibility

Поле	Тип TypeScript	Обяз.
operation	"apply_track_visibility"	да
subsetId	string	да
session	ContractSubsetSessionInfo	да
supportedSubset	string	да
delta	DeltaSummary	да
axis	ContractTrackAxis	да
index	number	да
hidden	boolean	да
changedRows	number[]	да
changedColumns	number[]	да
hiddenRows	number[]	да
manualHiddenRows	number[]	да
filterHiddenRows	number[]	да
dirtyCellCount	number	да
currentSourceSaveReadiness	ContractCurrentSourceSaveReadiness | null	нет
activeSheet	ContractActiveSheetMeta	да
geometry	ContractGeometrySubset	да
recalcNeeded	boolean	да
viewport	ViewportWindow	да
previewCells	ContractPreviewCell[]	да
layoutMetrics	ContractLayoutMetricsSubset	да

Минимальный JSON-шаблон

{
  "operation": "apply_track_visibility",
  "subsetId": "<subsetId>",
  "sheetKey": "<sheetPath>",
  "axis": "<ContractTrackAxis>",
  "hidden": false,
  "requestedBackend": "native-desktop"
}

protected_ranges_permissions

Запрос

Поле	Тип TypeScript	Обяз.
operation	"protected_ranges_permissions"	да
subsetId	string	да
intent	ContractProtectedRangesIntent	да
requestedBackend	ComputeBackendKind | null	нет

Ответ при успехе · protected_ranges_permissions

Поле	Тип TypeScript	Обяз.
operation	"protected_ranges_permissions"	да
subsetId	string	да
session	ContractSubsetSessionInfo	да
result	ContractProtectedRangesResult	да

Минимальный JSON-шаблон

{
  "operation": "protected_ranges_permissions",
  "subsetId": "<subsetId>",
  "intent": "<ContractProtectedRangesIntent>",
  "requestedBackend": "native-desktop"
}

protection_inspector_audit

Запрос

Поле	Тип TypeScript	Обяз.
operation	"protection_inspector_audit"	да
subsetId	string	да
requestId	string	да
expectedRevision	number	да
expectedGeneration	number	да
readOnly	boolean	нет
intent	ContractProtectionAuditIntent	да
requestedBackend	ComputeBackendKind | null	нет

Ответ при успехе · protection_inspector_audit

Поле	Тип TypeScript	Обяз.
operation	"protection_inspector_audit"	да
subsetId	string	да
session	ContractSubsetSessionInfo	да
result	ContractProtectionAuditResult	да

Минимальный JSON-шаблон

{
  "operation": "protection_inspector_audit",
  "subsetId": "<subsetId>",
  "requestId": "<string>",
  "expectedRevision": 0,
  "expectedGeneration": 0,
  "intent": "<ContractProtectionAuditIntent>",
  "requestedBackend": "native-desktop"
}

review_annotations_lifecycle

Запрос

Поле	Тип TypeScript	Обяз.
operation	"review_annotations_lifecycle"	да
subsetId	string	да
requestId	string	да
expectedRevision	number	да
expectedGeneration	number	да
nowUtc	string	да
readOnly	boolean	нет
protected	boolean	нет
state	ContractReviewAnnotationsState	да
intent	ContractReviewAnnotationsIntent	да
requestedBackend	ComputeBackendKind | null	нет

Ответ при успехе · review_annotations_lifecycle

Поле	Тип TypeScript	Обяз.
operation	"review_annotations_lifecycle"	да
subsetId	string	да
session	ContractSubsetSessionInfo	да
result	ContractReviewAnnotationsResult	да
workbookHistory	ContractWorkbookHistoryProjection	да

Минимальный JSON-шаблон

{
  "operation": "review_annotations_lifecycle",
  "subsetId": "<subsetId>",
  "requestId": "<string>",
  "expectedRevision": 0,
  "expectedGeneration": 0,
  "nowUtc": "<string>",
  "state": "<ContractReviewAnnotationsState>",
  "intent": "<ContractReviewAnnotationsIntent>",
  "requestedBackend": "native-desktop"
}

review_ink_lifecycle

Запрос

Поле	Тип TypeScript	Обяз.
operation	"review_ink_lifecycle"	да
subsetId	string	да
scope	ContractReviewInkDeleteScope	да
sheetPath	string | null	нет
expectedRevision	number	да
readOnly	boolean	нет
viewport	ViewportWindow | null	нет
requestedBackend	ComputeBackendKind | null	нет

Ответ при успехе · review_ink_lifecycle

Поле	Тип TypeScript	Обяз.
operation	"review_ink_lifecycle"	да
subsetId	string	да
session	ContractSubsetSessionInfo	да
scope	ContractReviewInkDeleteScope	да
deletedCount	number	да
byteCount	number	да
identityLedger	ContractReviewInkIdentityLedgerEntry[]	да
removedPartCount	number	да
removedRelationshipCount	number	да
removedContentTypeOverrideCount	number	да
preservedInkParts	ContractReviewInkPreservedPart[]	да
preexistingOrphanCount	number	да
orphanCount	number	да
newOrphanCount	number	да
objectInventory	ContractWorkbookObjectInventoryEntry[]	да
inkProjection	ContractReviewInkProjectionItem[]	да
workbookHistory	ContractWorkbookHistoryProjection	да
activeSheet	ContractActiveSheetMeta	да
workbookSheets	ContractWorkbookSheetMeta[]	да
geometry	ContractGeometrySubset	да
viewport	ViewportWindow	да
previewCells	ContractPreviewCell[]	да
surfaceObjects	ContractSheetObject[]	да
layoutMetrics	ContractLayoutMetricsSubset	нет

Минимальный JSON-шаблон

{
  "operation": "review_ink_lifecycle",
  "subsetId": "<subsetId>",
  "scope": "<ContractReviewInkDeleteScope>",
  "expectedRevision": 0,
  "requestedBackend": "native-desktop"
}

set_sheet_protection_bounded

Устанавливает sheet protection bounded.

Запрос

Поле	Тип TypeScript	Обяз.
operation	"set_sheet_protection_bounded"	да
subsetId	string	да
sheetKey	string	да
protected	boolean	да
allowedActions	ContractSheetProtectionAllowedAction[] | null	нет
password	string | null	нет
sessionAction	ContractSheetProtectionSessionAction | null	нет
viewport	ViewportWindow | null	нет
requestedBackend	ComputeBackendKind | null	нет

Ответ при успехе · set_sheet_protection_bounded

Поле	Тип TypeScript	Обяз.
operation	"set_sheet_protection_bounded"	да
subsetId	string	да
session	ContractSubsetSessionInfo	да
supportedSubset	string	да
delta	DeltaSummary	да
changedSheet	ContractActiveSheetMeta	да
previousProtected	boolean	да
previousAllowedActions	ContractSheetProtectionAllowedAction[] | null	нет
previousPasswordProtected	boolean	да
protected	boolean	да
allowedActions	ContractSheetProtectionAllowedAction[] | null	нет
passwordProtected	boolean	да
packageProtected	boolean	да
effectiveProtected	boolean	да
sessionUnlocked	boolean	да
sessionAction	ContractSheetProtectionSessionAction | null	нет
activeSheet	ContractActiveSheetMeta	да
sheetCount	number	да
workbookSheets	ContractWorkbookSheetMeta[]	да
geometry	ContractGeometrySubset	да
recalcNeeded	boolean	да
viewport	ViewportWindow	да
previewCells	ContractPreviewCell[]	да
layoutMetrics	ContractLayoutMetricsSubset | null	нет
workbookHistory	ContractWorkbookHistoryProjection	да
sheetProtectionClaim	"live_verified"	да
protectionScope	"same_workbook_sheetProtection_metadata"	да
passwordProtectionClaim	"live_verified"	да

Минимальный JSON-шаблон

{
  "operation": "set_sheet_protection_bounded",
  "subsetId": "<subsetId>",
  "sheetKey": "<sheetPath>",
  "protected": false,
  "requestedBackend": "native-desktop"
}

workbook_protection_lifecycle

Запрос

Поле	Тип TypeScript	Обяз.
operation	"workbook_protection_lifecycle"	да
subsetId	string	да
intent	ContractWorkbookProtectionIntent	да
requestedBackend	ComputeBackendKind | null	нет

Ответ при успехе · workbook_protection_lifecycle

Поле	Тип TypeScript	Обяз.
operation	"workbook_protection_lifecycle"	да
subsetId	string	да
session	ContractSubsetSessionInfo	да
result	ContractWorkbookProtectionResult	да

Минимальный JSON-шаблон

{
  "operation": "workbook_protection_lifecycle",
  "subsetId": "<subsetId>",
  "intent": "<ContractWorkbookProtectionIntent>",
  "requestedBackend": "native-desktop"
}