金山文档开放平台

主题

回到顶部
本页内容

同步接口运行脚本

该接口是创建并执行脚本与获取脚本执行状态的两个接口的结合，请求参数同创建并执行脚本接口一致，返回值详情同获取脚本执行状态一致

基本信息

请求方法：POST

请求路径：/api/v1/openapi/personal/files/:file_token/sync_script

请求主机：developer.kdocs.cn

限流频次

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

权限范围

权限值显示名称权限说明
edit_personal_files
编辑个人文档
编辑用户个人文档

Path 参数

参数必须类型说明
file_token
是
string
文档 ID

Query 参数

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

Body 参数

参数必须类型说明
script
是
string
脚本
script_name
否
string
脚本名称，在log中显示,如果没有传则日志显示anonymous
custom_argv
否
object
参数对象,该参数可在脚本中使用,如示例

返回参数

参数类型说明
code
integer
错误码
+
data
queryobject {}
响应数据

示例

请求示例(修改A1单元格的值) 

curl --request POST \
	--url 'https://developer.kdocs.cn/api/v1/openapi/personal/files/G_xvUrobayOMXvA4IJFVq19n6epm0T7PjYphWo-N3cE/script?access_token=kvqxrspxjctdojjqdildjhonzwusaquc' \
	--data '{"script":"Application.Range(\"A1\").Value = \"bar\"","script_name":"test"}'

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"script\":\"Application.Range(\\\"A1\\\").Value = \\\"bar\\\"\",\"script_name\":\"test\"}");
Request request = new Request.Builder()
	.url("https://developer.kdocs.cn/api/v1/openapi/personal/files/G_xvUrobayOMXvA4IJFVq19n6epm0T7PjYphWo-N3cE/script?access_token=kvqxrspxjctdojjqdildjhonzwusaquc")
	.post(body)
	.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/personal/files/G_xvUrobayOMXvA4IJFVq19n6epm0T7PjYphWo-N3cE/script?access_token=kvqxrspxjctdojjqdildjhonzwusaquc"

	payload := strings.NewReader("{\"script\":\"Application.Range(\\\"A1\\\").Value = \\\"bar\\\"\",\"script_name\":\"test\"}")

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

	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 = "{\"script\":\"Application.Range(\\\"A1\\\").Value = \\\"bar\\\"\",\"script_name\":\"test\"}"

conn.request("POST", "/api/v1/openapi/personal/files/G_xvUrobayOMXvA4IJFVq19n6epm0T7PjYphWo-N3cE/script?access_token=kvqxrspxjctdojjqdildjhonzwusaquc", payload)

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/personal/files/G_xvUrobayOMXvA4IJFVq19n6epm0T7PjYphWo-N3cE/script?access_token=kvqxrspxjctdojjqdildjhonzwusaquc",
	CURLOPT_RETURNTRANSFER => true,
	CURLOPT_ENCODING => "",
	CURLOPT_MAXREDIRS => 10,
	CURLOPT_TIMEOUT => 30,
	CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
	CURLOPT_CUSTOMREQUEST => "POST",
	CURLOPT_POSTFIELDS => "{\"script\":\"Application.Range(\\\"A1\\\").Value = \\\"bar\\\"\",\"script_name\":\"test\"}",
]);

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

curl_close($curl);

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

const data = JSON.stringify({
	"script": "Application.Range(\"A1\").Value = \"bar\"",
	"script_name": "test"
});

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/personal/files/G_xvUrobayOMXvA4IJFVq19n6epm0T7PjYphWo-N3cE/script?access_token=kvqxrspxjctdojjqdildjhonzwusaquc");

xhr.send(data);

const http = require("https");

const options = {
	"method": "POST",
	"hostname": "developer.kdocs.cn",
	"port": null,
	"path": "/api/v1/openapi/personal/files/G_xvUrobayOMXvA4IJFVq19n6epm0T7PjYphWo-N3cE/script?access_token=kvqxrspxjctdojjqdildjhonzwusaquc",
	"headers": {}
};

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({script: 'Application.Range("A1").Value = "bar"', script_name: 'test'}));
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/personal/files/G_xvUrobayOMXvA4IJFVq19n6epm0T7PjYphWo-N3cE/script?access_token=kvqxrspxjctdojjqdildjhonzwusaquc");

curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\"script\":\"Application.Range(\\\"A1\\\").Value = \\\"bar\\\"\",\"script_name\":\"test\"}");

CURLcode ret = curl_easy_perform(hnd);

var client = new RestClient("https://developer.kdocs.cn/api/v1/openapi/personal/files/G_xvUrobayOMXvA4IJFVq19n6epm0T7PjYphWo-N3cE/script?access_token=kvqxrspxjctdojjqdildjhonzwusaquc");
var request = new RestRequest(Method.POST);
request.AddParameter("undefined", "{\"script\":\"Application.Range(\\\"A1\\\").Value = \\\"bar\\\"\",\"script_name\":\"test\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

返回示例(修改A1单元格的值)

已忽略脚本开始结束的日志内容

{
  "data": {
    "logs": [
      {
        "filename": "system",
        "timestamp": "16:12:24.069",
        "unix_time": 1667463144,
        "level": "info",
        "args": [
          "脚本环境初始化..."
        ]
      },
      {
        "filename": "system",
        "timestamp": "16:12:24.095",
        "unix_time": 1667463144,
        "level": "info",
        "args": [
          "已开始执行"
        ]
      },
      {
        "filename": "system",
        "timestamp": "16:12:24.136",
        "unix_time": 1667463144,
        "level": "info",
        "args": [
          "执行完毕"
        ]
      }
    ],
    "result": "bar"
  },
  "error": "",
  "status": "finish"
}

错误码

请参考错误码说明