Batch set column widths - DingTalk Help Center

Call this API to set the width (in pixels) of multiple consecutive columns in a DingTalk Spreadsheet, starting from a specified column. This is useful when you need to batch-adjust column widths to fit content display or print layouts. Width values are automatically rounded to positive integers, and the API returns the worksheet information after the operation.

Request

Basic information

Field	Value
HTTP URL	`https://api.dingtalk.io/v1.0/doc/workbooks/{workbookId}/sheets/{sheetId}/setColumnsWidth`
HTTP Method	POST
Supported app type	appType-Internal app
Permissions	permission-Document.Workbook.Write-DingTalk Spreadsheet write permission

Request headers

Name	Type	Required	Description
x-acs-dingtalk-access-token	String	Yes	The access credential for calling this API. To obtain it, call Get the access token of an internal app.

Path parameters

Name	Type	Required	Description
workbookId	String	Yes	The spreadsheet file ID. The `nodeId(dentryUuid)` returned by the Knowledge Base API is the spreadsheet `workbookId`. You can obtain it by calling Get node or Create a Knowledge Base document.
sheetId	String	Yes	The worksheet ID or title. Call Get all worksheets to obtain the ID and title of the worksheet.

Query parameters

Name	Type	Required	Description
operatorId	String	Yes	The unionId of the operator. To obtain it, call Query user details. If the operator does not have permission, the API returns the error `The operator has no permission`.

Request body

Name	Type	Required	Description
column	Integer	Yes	The index of the first column whose width to modify. Starts from 0.
width	Integer	Yes	The width, in pixels.
columnCount	Integer	Yes	The number of consecutive columns whose width to modify.

Request example

HTTP

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

{
  "column" : 0,
  "width" : 50,
  "columnCount" : 10
}

Java

package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * <b>description</b> :
     * <p>Initialize the account Client with the Token</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.SetColumnsWidthHeaders setColumnsWidthHeaders = new com.aliyun.dingtalkdoc_1_0.models.SetColumnsWidthHeaders();
        setColumnsWidthHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkdoc_1_0.models.SetColumnsWidthRequest setColumnsWidthRequest = new com.aliyun.dingtalkdoc_1_0.models.SetColumnsWidthRequest()
                .setOperatorId("ppgAQuHfOoNVpJiStDwWCEgiEiE")
                .setColumn(0)
                .setWidth(50)
                .setColumnCount(10);
        try {
            client.setColumnsWidthWithOptions("e54Lqxxxxx", "Sheet1", setColumnsWidthRequest, setColumnsWidthHeaders, 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 contains code and message attributes that help locate the issue
            }

        } 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 contains code and message attributes that help locate the issue
            }

        }        
    }
}

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:
        """
        Initialize the account Client with the Token
        @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()
        set_columns_width_headers = dingtalkdoc__1__0_models.SetColumnsWidthHeaders()
        set_columns_width_headers.x_acs_dingtalk_access_token = '<your access token>'
        set_columns_width_request = dingtalkdoc__1__0_models.SetColumnsWidthRequest(
            operator_id='ppgAQuHfOoNVpJiStDwWCEgiEiE',
            column=0,
            width=50,
            column_count=10
        )
        try:
            client.set_columns_width_with_options('e54Lqxxxxx', 'Sheet1', set_columns_width_request, set_columns_width_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err contains code and message attributes that help locate the issue
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        set_columns_width_headers = dingtalkdoc__1__0_models.SetColumnsWidthHeaders()
        set_columns_width_headers.x_acs_dingtalk_access_token = '<your access token>'
        set_columns_width_request = dingtalkdoc__1__0_models.SetColumnsWidthRequest(
            operator_id='ppgAQuHfOoNVpJiStDwWCEgiEiE',
            column=0,
            width=50,
            column_count=10
        )
        try:
            await client.set_columns_width_with_options_async('e54Lqxxxxx', 'Sheet1', set_columns_width_request, set_columns_width_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err contains code and message attributes that help locate the issue
                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\SetColumnsWidthHeaders;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\SetColumnsWidthRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * Initialize the account Client with the Token
     * @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();
        $setColumnsWidthHeaders = new SetColumnsWidthHeaders([]);
        $setColumnsWidthHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $setColumnsWidthRequest = new SetColumnsWidthRequest([
            "operatorId" => "ppgAQuHfOoNVpJiStDwWCEgiEiE",
            "column" => 0,
            "width" => 50,
            "columnCount" => 10
        ]);
        try {
            $client->setColumnsWidthWithOptions("e54Lqxxxxx", "Sheet1", $setColumnsWidthRequest, $setColumnsWidthHeaders, 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 contains code and message attributes that help locate the issue
            }
        }
    }
}
$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:
// 
// Initialize the account Client with the Token
// 
// @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
  }

  setColumnsWidthHeaders := &dingtalkdoc_1_0.SetColumnsWidthHeaders{}
  setColumnsWidthHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  setColumnsWidthRequest := &dingtalkdoc_1_0.SetColumnsWidthRequest{
    OperatorId: tea.String("ppgAQuHfOoNVpJiStDwWCEgiEiE"),
    Column: tea.Int32(0),
    Width: tea.Int32(50),
    ColumnCount: tea.Int32(10),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.SetColumnsWidthWithOptions(tea.String("e54Lqxxxxx"), tea.String("Sheet1"), setColumnsWidthRequest, setColumnsWidthHeaders, &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 contains code and message attributes that help locate the issue
    }

  }
  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 {

  /**
   * Initialize the account Client with the Token
   * @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 setColumnsWidthHeaders = new dingtalkdoc_1_0.SetColumnsWidthHeaders({ });
    setColumnsWidthHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let setColumnsWidthRequest = new dingtalkdoc_1_0.SetColumnsWidthRequest({
      operatorId: 'ppgAQuHfOoNVpJiStDwWCEgiEiE',
      column: 0,
      width: 50,
      columnCount: 10,
    });
    try {
      await client.setColumnsWidthWithOptions('e54Lqxxxxx', 'Sheet1', setColumnsWidthRequest, setColumnsWidthHeaders, new Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
        // err contains code and message attributes that help locate the issue
      }

    }    
  }

}

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>Initialize the account Client with the Token</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.SetColumnsWidthHeaders setColumnsWidthHeaders = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.SetColumnsWidthHeaders();
            setColumnsWidthHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.SetColumnsWidthRequest setColumnsWidthRequest = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.SetColumnsWidthRequest
            {
                OperatorId = "ppgAQuHfOoNVpJiStDwWCEgiEiE",
                Column = 0,
                Width = 50,
                ColumnCount = 10,
            };
            try
            {
                client.SetColumnsWidthWithOptions("e54Lqxxxxx", "Sheet1", setColumnsWidthRequest, setColumnsWidthHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
            }
            catch (TeaException err)
            {
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // err contains code and message attributes that help locate the issue
                }
            }
            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 contains code and message attributes that help locate the issue
                }
            }
        }

    }
}

Response

Response body

Name	Type	Description
sheetId	String	The worksheet ID.
sheetName	String	The worksheet name.

Response body example

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

{
  "sheetId" : "s1",
  "sheetName" : "Sheet1"
}

Error codes

If the API returns an error, look up the solution in the Global error codes documentation based on the error message.

HttpCode	Error code	Error message	Description
400	invalidRequest.inputArgs.invalid	%s	The request parameter is invalid. Check the error message.
400	invalidRequest.inputArgs.workbookIdIllegal	The workbookId is illegal.	The workbookId is invalid.
400	invalidRequest.resource.notWorkbook	%s	The document type is not supported. Check the workbookId.
400	invalidRequest.document.stillInitializing	The document is still initializing. Please try again later.	The document is initializing. Try again later.
400	invalidRequest.inputArgs.unionIdIllegal	The operatorId is illegal.	The operatorId is invalid.
403	forbidden.accessDenied	The operator has no permission.	The current user does not have permission for this operation.
403	forbidden.acrossOrg	%s	The request is invalid. Check whether the target document belongs to the organization specified by the access token.
403	forbidden.operationIllegal	%s	The operation is invalid. Check the error message.
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.	The spreadsheet content is too large. Try reducing it.
404	invalidRequest.resource.notFound	%s	The request failed because the target resource cannot be found.
500	serviceBusy	The server is busy and unable to complete your request. Please try again later.	The service is busy. Try again later.
500	internalError	The server encountered an internal error and was unable to complete your request. Please try again later.	An internal server error occurred. Try again later.

​Request

​Basic information

​Request headers

​Path parameters

​Query parameters

​Request body

​Request example

​Response

​Response body

​Response body example

​Error codes