Auto-fit row height - DingTalk Help Center

Call this API to automatically adjust the height of specified rows in a DingTalk Spreadsheet based on the given font size, ensuring that the content is fully displayed.

API call description

Automatically adjusts the row height for each row within the specified range based on the provided fontWidth (font size), ensuring that content is fully displayed.
Use row (starting row cursor) and rowCount (number of rows) to specify the row range to auto-fit.
Row cursors start from 0. That is, the cursor of the first row is 0.

Request

Basic information

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

Request header

Name	Type	Required	Description
x-acs-dingtalk-access-token	String	Yes	The access credential used to call this API. You can obtain it by calling the Get the access token of an internal app API.

Path parameter

Name	Type	Required	Description
workbookId	String	Yes	The ID of the spreadsheet file. The `nodeId` (dentryUuid) is the `workbookId` of the spreadsheet. You can obtain it by calling the Get node or Create knowledge base document API.
sheetId	String	Yes	The ID or title of the worksheet. You can obtain it by calling the Get all worksheets API, or enter the title of the worksheet.

Query parameter

Name	Type	Required	Description
operatorId	String	Yes	The unionId of the operator. You can obtain it by calling the Query user details API.

Request body

Name	Type	Required	Description
row	Long	Yes	The row number, starting from 0.
rowCount	Long	Yes	The number of rows.
fontWidth	Long	Yes	The font size.

Request example

HTTP

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

{
  "row" : 0,
  "rowCount" : 10,
  "fontWidth" : 10
}

Java

package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * <b>description</b> :
     * <p>Initialize the account Client using a 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.SheetAutofitRowsHeaders sheetAutofitRowsHeaders = new com.aliyun.dingtalkdoc_1_0.models.SheetAutofitRowsHeaders();
        sheetAutofitRowsHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkdoc_1_0.models.SheetAutofitRowsRequest sheetAutofitRowsRequest = new com.aliyun.dingtalkdoc_1_0.models.SheetAutofitRowsRequest()
                .setOperatorId("ppgAxxx")
                .setRow(0L)
                .setRowCount(10L)
                .setFontWidth(10L);
        try {
            client.sheetAutofitRowsWithOptions("e54Lq3xxx", "Sheet1", sheetAutofitRowsRequest, sheetAutofitRowsHeaders, 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 the code and message Attributes, which help developers 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 the code and message Attributes, which help developers 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 using a 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()
        sheet_autofit_rows_headers = dingtalkdoc__1__0_models.SheetAutofitRowsHeaders()
        sheet_autofit_rows_headers.x_acs_dingtalk_access_token = '<your access token>'
        sheet_autofit_rows_request = dingtalkdoc__1__0_models.SheetAutofitRowsRequest(
            operator_id='ppgAxxx',
            row=0,
            row_count=10,
            font_width=10
        )
        try:
            client.sheet_autofit_rows_with_options('e54Lq3xxx', 'Sheet1', sheet_autofit_rows_request, sheet_autofit_rows_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err contains the code and message Attributes, which help developers locate the issue
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        sheet_autofit_rows_headers = dingtalkdoc__1__0_models.SheetAutofitRowsHeaders()
        sheet_autofit_rows_headers.x_acs_dingtalk_access_token = '<your access token>'
        sheet_autofit_rows_request = dingtalkdoc__1__0_models.SheetAutofitRowsRequest(
            operator_id='ppgAxxx',
            row=0,
            row_count=10,
            font_width=10
        )
        try:
            await client.sheet_autofit_rows_with_options_async('e54Lq3xxx', 'Sheet1', sheet_autofit_rows_request, sheet_autofit_rows_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err contains the code and message Attributes, which help developers 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\SheetAutofitRowsHeaders;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\SheetAutofitRowsRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * Initialize the account Client using a 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();
        $sheetAutofitRowsHeaders = new SheetAutofitRowsHeaders([]);
        $sheetAutofitRowsHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $sheetAutofitRowsRequest = new SheetAutofitRowsRequest([
            "operatorId" => "ppgAxxx",
            "row" => 0,
            "rowCount" => 10,
            "fontWidth" => 10
        ]);
        try {
            $client->sheetAutofitRowsWithOptions("e54Lq3xxx", "Sheet1", $sheetAutofitRowsRequest, $sheetAutofitRowsHeaders, 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 the code and message Attributes, which help developers 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 using a 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
  }

  sheetAutofitRowsHeaders := &dingtalkdoc_1_0.SheetAutofitRowsHeaders{}
  sheetAutofitRowsHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  sheetAutofitRowsRequest := &dingtalkdoc_1_0.SheetAutofitRowsRequest{
    OperatorId: tea.String("ppgAxxx"),
    Row: tea.Int64(0),
    RowCount: tea.Int64(10),
    FontWidth: tea.Int64(10),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.SheetAutofitRowsWithOptions(tea.String("e54Lq3xxx"), tea.String("Sheet1"), sheetAutofitRowsRequest, sheetAutofitRowsHeaders, &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 the code and message Attributes, which help developers 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 using a 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 sheetAutofitRowsHeaders = new dingtalkdoc_1_0.SheetAutofitRowsHeaders({ });
    sheetAutofitRowsHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let sheetAutofitRowsRequest = new dingtalkdoc_1_0.SheetAutofitRowsRequest({
      operatorId: 'ppgAxxx',
      row: 0,
      rowCount: 10,
      fontWidth: 10,
    });
    try {
      await client.sheetAutofitRowsWithOptions('e54Lq3xxx', 'Sheet1', sheetAutofitRowsRequest, sheetAutofitRowsHeaders, new Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
        // err contains the code and message Attributes, which help developers 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 using a 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.SheetAutofitRowsHeaders sheetAutofitRowsHeaders = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.SheetAutofitRowsHeaders();
            sheetAutofitRowsHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.SheetAutofitRowsRequest sheetAutofitRowsRequest = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.SheetAutofitRowsRequest
            {
                OperatorId = "ppgAxxx",
                Row = 0,
                RowCount = 10,
                FontWidth = 10,
            };
            try
            {
                client.SheetAutofitRowsWithOptions("e54Lq3xxx", "Sheet1", sheetAutofitRowsRequest, sheetAutofitRowsHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
            }
            catch (TeaException err)
            {
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // err contains the code and message Attributes, which help developers 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 the code and message Attributes, which help developers locate the issue
                }
            }
        }

    }
}

Response

Response body

Name	Type	Description
id	String	The ID of the current worksheet.

Response body example

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

{
  "id" : "stxxxx"
}

Error codes

If an error occurs when calling this API, refer to the Global error codes document to find a solution based on the error message.

HttpCode	Error code	Error message	Description
400	invalidRequest.inputArgs.workbookIdIllegal	The workbookId is illegal.	The workbookId is invalid.
400	invalidRequest.inputArgs.operatorIdIllegal	The operatorId is illegal.	The operatorId is invalid.
400	invalidRequest.inputArgs.invalid	%s	The request parameter is invalid. Check the error message for details.
400	invalidRequest.resource.notWorkbook	%s	Unsupported document type. Check the workbookId.
403	forbidden.operationIllegal	%s	The requested action is invalid. Check the error message for details.
403	forbidden.accessDenied	The operator has no permission.	The current user does not have permission to perform this action.
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 the content.
403	forbidden.acrossOrg	%s	The request is invalid. Verify that the target document belongs to the organization specified by the access token.
404	invalidRequest.resource.notFound	%s	The request failed. The requested resource cannot be found.
500	internalError	The server encountered an internal error and was unable to complete your request. Please try again later.	Internal server error. Try again later.
503	serviceBusy	The server is busy and unable to complete your request. Please try again later.	The server is busy. Try again later.

​API call description

​Request

​Basic information

​Request header

​Path parameter

​Query parameter

​Request body

​Request example

​Response

​Response body

​Response body example

​Error codes