列幅の一括設定

本インターフェースを呼び出すことで、スプレッドシート内の指定した列から連続する複数列の幅（単位：ピクセル）を一度に設定できます。コンテンツ表示や印刷レイアウトに合わせて列幅を一括調整するシーンに適しており、幅の値は自動的に正の整数に丸められます。インターフェースは操作後のワークシート情報を返します。

リクエスト

基本情報

フィールド	値
HTTP URL	`https://api.dingtalk.io/v1.0/doc/workbooks/{workbookId}/sheets/{sheetId}/setColumnsWidth`
HTTP Method	POST
サポートするアプリタイプ	appType-社内アプリ
権限要件	permission-Document.Workbook.Write-スプレッドシート書き込み権限

リクエストヘッダー

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

パスパラメータ

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

クエリパラメータ

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

リクエストボディ

名前	タイプ	必須	説明
column	Integer	はい	列幅を変更する最初の列のカーソル。0から始まります。
width	Integer	はい	幅。単位：ピクセル。
columnCount	Integer	はい	列幅を変更する連続列数。

リクエスト例

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>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.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 には 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()
        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 には code と message の属性が含まれており、開発者の問題特定に役立ちます
                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 には 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\SetColumnsWidthHeaders;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\SetColumnsWidthRequest;
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();
        $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 には 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
  }

  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 には 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 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 には 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.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 には 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 の属性が含まれており、開発者の問題特定に役立ちます
                }
            }
        }

    }
}

レスポンス

レスポンスボディ

名前	タイプ	説明
sheetId	String	ワークシートID。
sheetName	String	ワークシート名。

レスポンスボディ例

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

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

エラーコード

本インターフェースの呼び出しでエラーが発生した場合、エラーメッセージをもとにグローバルエラーコードドキュメントで解決方法を検索してください。

HttpCode	エラーコード	エラーメッセージ	説明
400	invalidRequest.inputArgs.invalid	%s	リクエストパラメータが不正です。エラーメッセージをご確認ください。
400	invalidRequest.inputArgs.workbookIdIllegal	The workbookId is illegal.	workbookIdが不正です。
400	invalidRequest.resource.notWorkbook	%s	サポートされていないドキュメントタイプです。workbookIdをご確認ください。
400	invalidRequest.document.stillInitializing	The document is still initializing. Please try again later.	ドキュメントを初期化中です。後で再試行してください。
400	invalidRequest.inputArgs.unionIdIllegal	The operatorId is illegal.	operatorIdが不正です。
403	forbidden.accessDenied	The operator has no permission.	現在のユーザーには本操作の権限がありません。
403	forbidden.acrossOrg	%s	リクエストが不正です。アクセスするドキュメントが、accessTokenで指定された組織に所属しているかご確認ください。
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

リクエスト

基本情報

リクエストヘッダー

パスパラメータ

クエリパラメータ

リクエストボディ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード

​リクエスト

​基本情報

​リクエストヘッダー

​パスパラメータ

​クエリパラメータ

​リクエストボディ

​リクエスト例

​レスポンス

​レスポンスボディ

​レスポンスボディ例

​エラーコード

リクエスト

基本情報

リクエストヘッダー

パスパラメータ

クエリパラメータ

リクエストボディ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード