金山文档开放平台

主题

回到顶部
本页内容

更新单元格选区数据

更新指定工作表内的单元格选区数据

基本信息

请求方法：POST

请求路径：/api/v1/openapi/ksheet/:file_token/sheets/:sheet_idx/cells

请求主机：developer.kdocs.cn

限流频次

应用类型限额
测试应用
10,000 次/天
正式应用
10,000,000 次/天

权限

要调用此 API，需要以下权限

权限值显示名称权限说明
user_basic
用户基本信息
访问用户 openid 昵称和头像
access_personal_files
访问个人文档
访问用户个人文档列表
edit_personal_files
编辑文档内容
编辑文档内容
download_personal_files
下载文档
下载文档

Path 参数

参数位置必须类型说明
file_token
path
是
string
文件 ID
sheet_idx
path
是
integer
sheet 索引

Query 参数

参数必须类型说明
access_token
是
string
访问令牌

Body 参数

参数必须类型说明
+
ranges
是
ranges[]
单元格选区数据

op_type 类型说明

op_type 可用值说明
merge
单元格操作
formula
单元格公式
format
单元格格式（暂时只有 numfmt）
picture
单元格图片

提示

row_from, row_to, col_from, col_to 四元组确定选区，值从 0 开始，例如 A1 单元格的坐标为 (row: 0, col: 0)

警告

每次请求更新的单元格数量不允许超过 2000

返回参数

参数类型说明
code
integer
错误码
data
data {}
-

示例

请求示例 

curl --request POST \
	--url 'https://developer.kdocs.cn/api/v1/openapi/ksheet/123/sheets/0/cells?access_token=xxxx' \
	--header 'Content-Type: application/json' \
	--data '{"ranges":[{"op_type":"formula","row_from":0,"row_to":1,"col_from":0,"col_to":1,"formula":"2222"}]}'

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"ranges\":[{\"op_type\":\"formula\",\"row_from\":0,\"row_to\":1,\"col_from\":0,\"col_to\":1,\"formula\":\"2222\"}]}");
Request request = new Request.Builder()
	.url("https://developer.kdocs.cn/api/v1/openapi/ksheet/123/sheets/0/cells?access_token=xxxx")
	.post(body)
	.addHeader("Content-Type", "application/json")
	.build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://developer.kdocs.cn/api/v1/openapi/ksheet/123/sheets/0/cells?access_token=xxxx"

	payload := strings.NewReader("{\"ranges\":[{\"op_type\":\"formula\",\"row_from\":0,\"row_to\":1,\"col_from\":0,\"col_to\":1,\"formula\":\"2222\"}]}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

import http.client

conn = http.client.HTTPSConnection("developer.kdocs.cn")

payload = "{\"ranges\":[{\"op_type\":\"formula\",\"row_from\":0,\"row_to\":1,\"col_from\":0,\"col_to\":1,\"formula\":\"2222\"}]}"

headers = { 'Content-Type': "application/json" }

conn.request("POST", "/api/v1/openapi/ksheet/123/sheets/0/cells?access_token=xxxx", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
	CURLOPT_URL => "https://developer.kdocs.cn/api/v1/openapi/ksheet/123/sheets/0/cells?access_token=xxxx",
	CURLOPT_RETURNTRANSFER => true,
	CURLOPT_ENCODING => "",
	CURLOPT_MAXREDIRS => 10,
	CURLOPT_TIMEOUT => 30,
	CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
	CURLOPT_CUSTOMREQUEST => "POST",
	CURLOPT_POSTFIELDS => "{\"ranges\":[{\"op_type\":\"formula\",\"row_from\":0,\"row_to\":1,\"col_from\":0,\"col_to\":1,\"formula\":\"2222\"}]}",
	CURLOPT_HTTPHEADER => [
		"Content-Type: application/json"
	],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
	echo "cURL Error #:" . $err;
} else {
	echo $response;
}

const data = JSON.stringify({
	"ranges": [
		{
			"op_type": "formula",
			"row_from": 0,
			"row_to": 1,
			"col_from": 0,
			"col_to": 1,
			"formula": "2222"
		}
	]
});

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
	if (this.readyState === this.DONE) {
		console.log(this.responseText);
	}
});

xhr.open("POST", "https://developer.kdocs.cn/api/v1/openapi/ksheet/123/sheets/0/cells?access_token=xxxx");
xhr.setRequestHeader("Content-Type", "application/json");

xhr.send(data);

const http = require("https");

const options = {
	"method": "POST",
	"hostname": "developer.kdocs.cn",
	"port": null,
	"path": "/api/v1/openapi/ksheet/123/sheets/0/cells?access_token=xxxx",
	"headers": {
		"Content-Type": "application/json"
	}
};

const req = http.request(options, function (res) {
	const chunks = [];

	res.on("data", function (chunk) {
		chunks.push(chunk);
	});

	res.on("end", function () {
		const body = Buffer.concat(chunks);
		console.log(body.toString());
	});
});

req.write(JSON.stringify({
  ranges: [
    {
      op_type: 'formula',
      row_from: 0,
      row_to: 1,
      col_from: 0,
      col_to: 1,
      formula: '2222'
    }
  ]
}));
req.end();

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "https://developer.kdocs.cn/api/v1/openapi/ksheet/123/sheets/0/cells?access_token=xxxx");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Content-Type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\"ranges\":[{\"op_type\":\"formula\",\"row_from\":0,\"row_to\":1,\"col_from\":0,\"col_to\":1,\"formula\":\"2222\"}]}");

CURLcode ret = curl_easy_perform(hnd);

var client = new RestClient("https://developer.kdocs.cn/api/v1/openapi/ksheet/123/sheets/0/cells?access_token=xxxx");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\"ranges\":[{\"op_type\":\"formula\",\"row_from\":0,\"row_to\":1,\"col_from\":0,\"col_to\":1,\"formula\":\"2222\"}]}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

返回示例 

{
  "code": 0,
  "data": {}
}

错误码

请参考错误码说明