ワークシートを更新する

このインターフェースを呼び出すことで、DingTalk スプレッドシート内の指定されたワークシートのメタ属性（ワークシート名、表示・非表示状態、固定行列数など）を変更できます。プログラムからワークシート設定を管理するシナリオに適しており、1 回のリクエストで複数の属性を同時に更新できます。更新後、ワークシートの id を返します。

リクエスト

基本情報

フィールド	値
HTTP URL	`https://api.dingtalk.io/v1.0/doc/workbooks/{workbookId}/sheets/{sheetId}`
HTTP Method	PUT
対応アプリタイプ	appType-社内アプリ
必要な権限	permission-Document.Workbook.Write-DingTalk スプレッドシートの書き込み権限

リクエストヘッダー

名前	タイプ	必須	説明
x-acs-dingtalk-access-token	String	必須	このインターフェースを呼び出すためのアクセス認証情報です。社内アプリの access_token を取得するインターフェースを呼び出して取得できます。

パスパラメータ

名前	タイプ	必須	説明
workbookId	String	必須	スプレッドシートファイルの ID です。ナレッジベース API で返される `nodeId(dentryUuid)` がスプレッドシートの `workbookId` です。ノードを取得するおよびナレッジベースドキュメントを作成するインターフェースを呼び出して取得できます。
sheetId	String	必須	ワークシートの ID または見出しです。すべてのワークシートを取得するインターフェースを呼び出して、id とワークシートの見出しを取得できます。

クエリパラメータ

名前	タイプ	必須	説明
operatorId	String	必須	操作者の unionId です。ユーザー詳細を取得するインターフェースを呼び出して取得できます。操作者に権限がない場合、インターフェースは `The operator has no permission` エラーを返します。

リクエストボディ

名前	タイプ	必須	説明
frozenRowCount	Long	任意	固定する行のインデックスです。1 から始まり、0 は固定しないことを表します。3 を指定した場合、1 行目から 3 行目までを固定します。
frozenColumnCount	Long	任意	固定する列のインデックスです。1 から始まり、0 は固定しないことを表します。3 を指定した場合、1 列目から 3 列目までを固定します。
visibility	String	任意	ワークシートを非表示にするかどうかを指定します。指定可能な値： - visible：表示 - hidden：非表示
name	String	任意	新しいワークシート名です。

リクエスト例

HTTP

PUT /v1.0/doc/workbooks/e54Lq3xxx/sheets/Sheet1?operatorId=ppgAxxx HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:f86e0bxxx
Content-Type:application/json

{
  "frozenRowCount" : 1,
  "frozenColumnCount" : 1,
  "visibility" : "hidden",
  "name" : "Sheet2"
}

Java

package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * <b>description</b> :
     * <p>Token を使用してアカウント Client を初期化します</p>
     * @return Client
     * 
     * @throws Exception
     */
    public static com.aliyun.dingtalkdoc_1_0.Client createClient() throws Exception {
        com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.Config();
        config.protocol = "https";
        config.regionId = "central";
        return new com.aliyun.dingtalkdoc_1_0.Client(config);
    }

    public static void main(String[] args_) throws Exception {
        
        com.aliyun.dingtalkdoc_1_0.Client client = Sample.createClient();
        com.aliyun.dingtalkdoc_1_0.models.UpdateSheetHeaders updateSheetHeaders = new com.aliyun.dingtalkdoc_1_0.models.UpdateSheetHeaders();
        updateSheetHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkdoc_1_0.models.UpdateSheetRequest updateSheetRequest = new com.aliyun.dingtalkdoc_1_0.models.UpdateSheetRequest()
                .setOperatorId("ppgAxxx")
                .setFrozenRowCount(1L)
                .setFrozenColumnCount(1L)
                .setVisibility("hidden")
                .setName("Sheet2");
        try {
            client.updateSheetWithOptions("e54Lq3xxx", "Sheet1", updateSheetRequest, updateSheetHeaders, new com.aliyun.teautil.models.RuntimeOptions());
        } catch (TeaException err) {
            if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
                // err には code と message 属性が含まれており、開発者の問題特定に役立ちます
            }

        } catch (Exception _err) {
            TeaException err = new TeaException(_err.getMessage(), _err);
            if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
                // err には code と message 属性が含まれており、開発者の問題特定に役立ちます
            }

        }        
    }
}

Python

# -*- coding: utf-8 -*-
# This file is auto-generated, don't edit it. Thanks.
import os
import sys
import json

from typing import List

from alibabacloud_dingtalk.doc_1_0.client import Client as dingtalkdoc_1_0Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_dingtalk.doc_1_0 import models as dingtalkdoc__1__0_models
from alibabacloud_tea_util import models as util_models
from alibabacloud_tea_util.client import Client as UtilClient

class Sample:
    def __init__(self):
        pass

    @staticmethod
    def create_client() -> dingtalkdoc_1_0Client:
        """
        Token を使用してアカウント Client を初期化します
        @return: Client
        @throws Exception
        """
        config = open_api_models.Config()
        config.protocol = 'https'
        config.region_id = 'central'
        return dingtalkdoc_1_0Client(config)

    @staticmethod
    def main(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        update_sheet_headers = dingtalkdoc__1__0_models.UpdateSheetHeaders()
        update_sheet_headers.x_acs_dingtalk_access_token = '<your access token>'
        update_sheet_request = dingtalkdoc__1__0_models.UpdateSheetRequest(
            operator_id='ppgAxxx',
            frozen_row_count=1,
            frozen_column_count=1,
            visibility='hidden',
            name='Sheet2'
        )
        try:
            client.update_sheet_with_options('e54Lq3xxx', 'Sheet1', update_sheet_request, update_sheet_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err には code と message 属性が含まれており、開発者の問題特定に役立ちます
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        update_sheet_headers = dingtalkdoc__1__0_models.UpdateSheetHeaders()
        update_sheet_headers.x_acs_dingtalk_access_token = '<your access token>'
        update_sheet_request = dingtalkdoc__1__0_models.UpdateSheetRequest(
            operator_id='ppgAxxx',
            frozen_row_count=1,
            frozen_column_count=1,
            visibility='hidden',
            name='Sheet2'
        )
        try:
            await client.update_sheet_with_options_async('e54Lq3xxx', 'Sheet1', update_sheet_request, update_sheet_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err には code と message 属性が含まれており、開発者の問題特定に役立ちます
                pass

if __name__ == '__main__':
    Sample.main(sys.argv[1:])

PHP

<?php

// This file is auto-generated, don't edit it. Thanks.
namespace AlibabaCloud\SDK\Sample;

use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Dingtalk;
use \Exception;
use AlibabaCloud\Tea\Exception\TeaError;
use AlibabaCloud\Tea\Utils\Utils;

use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\UpdateSheetHeaders;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\UpdateSheetRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * Token を使用してアカウント Client を初期化します
     * @return Dingtalk Client
     */
    public static function createClient(){
        $config = new Config([]);
        $config->protocol = "https";
        $config->regionId = "central";
        return new Dingtalk($config);
    }

    /**
     * @param string[] $args
     * @return void
     */
    public static function main($args){
        $client = self::createClient();
        $updateSheetHeaders = new UpdateSheetHeaders([]);
        $updateSheetHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $updateSheetRequest = new UpdateSheetRequest([
            "operatorId" => "ppgAxxx",
            "frozenRowCount" => 1,
            "frozenColumnCount" => 1,
            "visibility" => "hidden",
            "name" => "Sheet2"
        ]);
        try {
            $client->updateSheetWithOptions("e54Lq3xxx", "Sheet1", $updateSheetRequest, $updateSheetHeaders, new RuntimeOptions([]));
        }
        catch (Exception $err) {
            if (!($err instanceof TeaError)) {
                $err = new TeaError([], $err->getMessage(), $err->getCode(), $err);
            }
            if (!Utils::empty_($err->code) && !Utils::empty_($err->message)) {
                // err には code と message 属性が含まれており、開発者の問題特定に役立ちます
            }
        }
    }
}
$path = __DIR__ . \DIRECTORY_SEPARATOR . '..' . \DIRECTORY_SEPARATOR . 'vendor' . \DIRECTORY_SEPARATOR . 'autoload.php';
if (file_exists($path)) {
    require_once $path;
}
Sample::main(array_slice($argv, 1));

package main

import (
  "encoding/json"
  "strings"
  "fmt"
  "os"
  util  "github.com/alibabacloud-go/tea-utils/v2/service"
  dingtalkdoc_1_0  "github.com/alibabacloud-go/dingtalk/doc_1_0"
  openapi  "github.com/alibabacloud-go/darabonba-openapi/v2/client"
  "github.com/alibabacloud-go/tea/tea"
)

// Description:
// 
// Token を使用してアカウント Client を初期化します
// 
// @return Client
// 
// @throws Exception
func CreateClient () (_result *dingtalkdoc_1_0.Client, _err error) {
  config := &openapi.Config{}
  config.Protocol = tea.String("https")
  config.RegionId = tea.String("central")
  _result = &dingtalkdoc_1_0.Client{}
  _result, _err = dingtalkdoc_1_0.NewClient(config)
  return _result, _err
}

func _main (args []*string) (_err error) {
  client, _err := CreateClient()
  if _err != nil {
    return _err
  }

  updateSheetHeaders := &dingtalkdoc_1_0.UpdateSheetHeaders{}
  updateSheetHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  updateSheetRequest := &dingtalkdoc_1_0.UpdateSheetRequest{
    OperatorId: tea.String("ppgAxxx"),
    FrozenRowCount: tea.Int64(1),
    FrozenColumnCount: tea.Int64(1),
    Visibility: tea.String("hidden"),
    Name: tea.String("Sheet2"),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.UpdateSheetWithOptions(tea.String("e54Lq3xxx"), tea.String("Sheet1"), updateSheetRequest, updateSheetHeaders, &util.RuntimeOptions{})
    if _err != nil {
      return _err
    }

    return nil
  }()

  if tryErr != nil {
    var err = &tea.SDKError{}
    if _t, ok := tryErr.(*tea.SDKError); ok {
      err = _t
    } else {
      err.Message = tea.String(tryErr.Error())
    }
    if !tea.BoolValue(util.Empty(err.Code)) && !tea.BoolValue(util.Empty(err.Message)) {
      // err には code と message 属性が含まれており、開発者の問題特定に役立ちます
    }

  }
  return _err
}

func main() {
  err := _main(tea.StringSlice(os.Args[1:]))
  if err != nil {
    panic(err)
  }
}

Node.js

'use strict';
// This file is auto-generated, don't edit it
const Util = require('@alicloud/tea-util');
const dingtalkdoc_1_0 = require('@alicloud/dingtalk/doc_1_0');
const OpenApi = require('@alicloud/openapi-client');
const Tea = require('@alicloud/tea-typescript');

class Client {

  /**
   * Token を使用してアカウント Client を初期化します
   * @return Client
   * @throws Exception
   */
  static createClient() {
    let config = new OpenApi.Config({ });
    config.protocol = 'https';
    config.regionId = 'central';
    return new dingtalkdoc_1_0.default(config);
  }

  static async main(args) {
    let client = Client.createClient();
    let updateSheetHeaders = new dingtalkdoc_1_0.UpdateSheetHeaders({ });
    updateSheetHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let updateSheetRequest = new dingtalkdoc_1_0.UpdateSheetRequest({
      operatorId: 'ppgAxxx',
      frozenRowCount: 1,
      frozenColumnCount: 1,
      visibility: 'hidden',
      name: 'Sheet2',
    });
    try {
      await client.updateSheetWithOptions('e54Lq3xxx', 'Sheet1', updateSheetRequest, updateSheetHeaders, new Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
        // err には code と message 属性が含まれており、開発者の問題特定に役立ちます
      }

    }    
  }

}

exports.Client = Client;
Client.main(process.argv.slice(2));

using Newtonsoft.Json;
using System;
using System.Collections;
using System.Collections.Generic;
using System.IO;
using System.Threading.Tasks;

using Tea;
using Tea.Utils;

namespace AlibabaCloud.SDK.Sample
{
    public class Sample 
    {

        /// <term><b>Description:</b></term>
        /// <description>
        /// <para>Token を使用してアカウント Client を初期化します</para>
        /// </description>
        /// 
        /// <returns>
        /// Client
        /// </returns>
        /// 
        /// <term><b>Exception:</b></term>
        /// Exception
        public static AlibabaCloud.SDK.Dingtalkdoc_1_0.Client CreateClient()
        {
            AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config();
            config.Protocol = "https";
            config.RegionId = "central";
            return new AlibabaCloud.SDK.Dingtalkdoc_1_0.Client(config);
        }

        public static void Main(string[] args)
        {
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Client client = CreateClient();
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.UpdateSheetHeaders updateSheetHeaders = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.UpdateSheetHeaders();
            updateSheetHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.UpdateSheetRequest updateSheetRequest = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.UpdateSheetRequest
            {
                OperatorId = "ppgAxxx",
                FrozenRowCount = 1,
                FrozenColumnCount = 1,
                Visibility = "hidden",
                Name = "Sheet2",
            };
            try
            {
                client.UpdateSheetWithOptions("e54Lq3xxx", "Sheet1", updateSheetRequest, updateSheetHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
            }
            catch (TeaException err)
            {
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // err には code と message 属性が含まれており、開発者の問題特定に役立ちます
                }
            }
            catch (Exception _err)
            {
                TeaException err = new TeaException(new Dictionary<string, object>
                {
                    { "message", _err.Message }
                });
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // err には code と message 属性が含まれており、開発者の問題特定に役立ちます
                }
            }
        }

    }
}

レスポンス

レスポンスボディ

名前	タイプ	説明
id	String	ワークシートの id です。

レスポンスボディ例

HTTP/1.1 200 OK
Content-Type:application/json

{
  "id" : "sheet_id"
}

エラーコード

このインターフェース呼び出しでエラーが発生した場合は、エラーメッセージをもとにグローバルエラーコードドキュメントで解決策をご確認ください。

HttpCode	エラーコード	エラーメッセージ	説明
400	invalidRequest.inputArgs.invalid	%s	リクエストパラメータが不正です。エラーメッセージをご確認ください。
400	invalidRequest.inputArgs.workbookIdIllegal	The workbookId is illegal.	workbookId が不正です。
400	invalidRequest.resource.notWorkbook	%s	サポートされていないドキュメントタイプです。workbookId をご確認ください。
400	invalidRequest.inputArgs.unionIdIllegal	The operatorId is illegal.	operatorId が不正です。
403	forbidden.accessDenied	The operator has no permission.	現在のユーザーにこの操作の権限がありません。
403	forbidden.acrossOrg	%s	リクエストが不正です。アクセス対象のドキュメントが access_token で指定された組織に所属しているかご確認ください。
403	forbidden.operationIllegal	%s	リクエスト操作が不正です。エラーメッセージをご確認ください。
403	forbidden.document.sizeOverLimit	The document size is over limit and the server is unable to complete your request. Retry is unlikely to work unless the document size is decreased.	スプレッドシートのコンテンツが大きすぎます。コンテンツの縮減をお試しください。
404	invalidRequest.resource.notFound	%s	リクエストに失敗しました。アクセス対象のリソースが見つかりません。
500	serviceBusy	The server is busy and unable to complete your request. Please try again later.	サービスが混雑しています。後で再試行してください。
500	internalError	The server encountered an internal error and was unable to complete your request. Please try again later.	サービス内部エラーです。後で再試行してください。

API 呼び出しガイド

認証と認可

連絡先

カレンダー

会議

AI Table

Docs とファイル

IM

リクエスト

基本情報

リクエストヘッダー

パスパラメータ

クエリパラメータ

リクエストボディ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード

​リクエスト

​基本情報

​リクエストヘッダー

​パスパラメータ

​クエリパラメータ

​リクエストボディ

​リクエスト例

​レスポンス

​レスポンスボディ

​レスポンスボディ例

​エラーコード

リクエスト

基本情報

リクエストヘッダー

パスパラメータ

クエリパラメータ

リクエストボディ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード