ワークシートの作成

本インターフェースを呼び出して、スプレッドシートドキュメントに新しいワークシートを作成します。

リクエスト

基本情報

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

リクエストヘッダー

名前	タイプ	必須	説明
x-acs-dingtalk-access-token	String	はい	本インターフェースを呼び出すためのアクセス認証情報。以下の方法で取得します。 - 社内アプリの場合は、社内アプリのアクセストークンを取得インターフェースを呼び出して取得します。 - サードパーティ社内アプリの場合は、サードパーティアプリ認可企業のアクセストークンを取得インターフェースを呼び出して取得します。

パスパラメータ

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

クエリパラメータ

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

リクエストボディ

名前	タイプ	必須	説明
name	String	はい	ワークシートの名前。指定したワークシート名が既存のワークシート名と重複する場合、自動的に有効な値に名前を変更します。

リクエスト例

HTTP

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

{
  "name" : "Sheet1"
}

Java

// This file is auto-generated, don't edit it. Thanks.
package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * トークンを使用してアカウントクライアントを初期化します
     * @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 {
        java.util.List<String> args = java.util.Arrays.asList(args_);
        com.aliyun.dingtalkdoc_1_0.Client client = Sample.createClient();
        com.aliyun.dingtalkdoc_1_0.models.CreateSheetHeaders createSheetHeaders = new com.aliyun.dingtalkdoc_1_0.models.CreateSheetHeaders();
        createSheetHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkdoc_1_0.models.CreateSheetRequest createSheetRequest = new com.aliyun.dingtalkdoc_1_0.models.CreateSheetRequest()
                .setOperatorId("ppgAQuHfOoNVpJiStDwWCEgiEiE")
                .setName("Sheet1");
        try {
            client.createSheetWithOptions("e54Lqxxx", createSheetRequest, createSheetHeaders, 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 sys

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:
        """
        トークンを使用してアカウントクライアントを初期化します
        @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()
        create_sheet_headers = dingtalkdoc__1__0_models.CreateSheetHeaders()
        create_sheet_headers.x_acs_dingtalk_access_token = '<your access token>'
        create_sheet_request = dingtalkdoc__1__0_models.CreateSheetRequest(
            operator_id='ppgAQuHfOoNVpJiStDwWCEgiEiE',
            name='Sheet1'
        )
        try:
            client.create_sheet_with_options('e54Lqxxx', create_sheet_request, create_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()
        create_sheet_headers = dingtalkdoc__1__0_models.CreateSheetHeaders()
        create_sheet_headers.x_acs_dingtalk_access_token = '<your access token>'
        create_sheet_request = dingtalkdoc__1__0_models.CreateSheetRequest(
            operator_id='ppgAQuHfOoNVpJiStDwWCEgiEiE',
            name='Sheet1'
        )
        try:
            await client.create_sheet_with_options_async('e54Lqxxx', create_sheet_request, create_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\CreateSheetHeaders;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\CreateSheetRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * トークンを使用してアカウントクライアントを初期化します
     * @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();
        $createSheetHeaders = new CreateSheetHeaders([]);
        $createSheetHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $createSheetRequest = new CreateSheetRequest([
            "operatorId" => "ppgAQuHfOoNVpJiStDwWCEgiEiE",
            "name" => "Sheet1"
        ]);
        try {
            $client->createSheetWithOptions("e54Lqxxx", $createSheetRequest, $createSheetHeaders, 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));

// This file is auto-generated, don't edit it. Thanks.
package main

import (
  "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"
)

/**
 * トークンを使用してアカウントクライアントを初期化します
 * @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
  }

  createSheetHeaders := &dingtalkdoc_1_0.CreateSheetHeaders{}
  createSheetHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  createSheetRequest := &dingtalkdoc_1_0.CreateSheetRequest{
    OperatorId: tea.String("ppgAQuHfOoNVpJiStDwWCEgiEiE"),
    Name: tea.String("Sheet1"),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.CreateSheetWithOptions(tea.String("e54Lqxxx"), createSheetRequest, createSheetHeaders, &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

// This file is auto-generated, don't edit it
import Util, * as $Util from '@alicloud/tea-util';
import dingtalkdoc_1_0, * as $dingtalkdoc_1_0 from '@alicloud/dingtalk/doc_1_0';
import OpenApi, * as $OpenApi from '@alicloud/openapi-client';
import * as $tea from '@alicloud/tea-typescript';

export default class Client {

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

  static async main(args: string[]): Promise<void> {
    let client = Client.createClient();
    let createSheetHeaders = new $dingtalkdoc_1_0.CreateSheetHeaders({ });
    createSheetHeaders.xAcsDingtalkAccessToken = "<your access token>";
    let createSheetRequest = new $dingtalkdoc_1_0.CreateSheetRequest({
      operatorId: "ppgAQuHfOoNVpJiStDwWCEgiEiE",
      name: "Sheet1",
    });
    try {
      await client.createSheetWithOptions("e54Lqxxx", createSheetRequest, createSheetHeaders, new $Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.empty(err.code) && !Util.empty(err.message)) {
        // err には code と message 属性が含まれており、開発時の問題特定に役立ちます
      }

    }    
  }

}

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

// This file is auto-generated, don't edit it. Thanks.

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 
    {

        /**
         * トークンを使用してアカウントクライアントを初期化します
         * @return Client
         * @throws 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.CreateSheetHeaders createSheetHeaders = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CreateSheetHeaders();
            createSheetHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CreateSheetRequest createSheetRequest = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CreateSheetRequest
            {
                OperatorId = "ppgAQuHfOoNVpJiStDwWCEgiEiE",
                Name = "Sheet1",
            };
            try
            {
                client.CreateSheetWithOptions("e54Lqxxx", createSheetRequest, createSheetHeaders, 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 属性が含まれており、開発時の問題特定に役立ちます
                }
            }
        }

    }
}

レスポンス

レスポンスボディ

名前	タイプ	説明
visibility	String	ワークシートの可視性。固定値は visible です。
name	String	ワークシートの名前。
id	String	ワークシートの ID。

レスポンスボディ例

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

{
  "visibility" : "visible",
  "name" : "Sheet1",
  "id" : "st-xxxxx"
}

エラーコード

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

HttpCode	エラーコード	エラーメッセージ	説明
400	invalidRequest.inputArgs.workbookIdIllegal	The workbookId is illegal.	workbookId が不正です。
400	invalidRequest.inputArgs.operatorIdIllegal	The operatorId is illegal.	operatorId が不正です。
400	invalidRequest.inputArgs.invalid	%s	リクエストパラメータが不正です。考えられるエラーとして、range アドレスが正しくない、入力パラメータのデータ次元が正しくない、色のフォーマットが正しくないなどがあります。具体的なエラー内容はエラーメッセージをご確認ください。
403	forbidden.operationIllegal	%s	リクエスト操作が不正です。考えられるエラーとして、ロックされたセルへのアクセス権がない、ピボットテーブルやタスク関連のセルを変更したなどがあります。具体的なエラー内容はエラーメッセージをご確認ください。
403	forbidden.accessDenied	The operator has no permission.	現在のユーザーには本操作の権限がありません。
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	internalError	The server encountered an internal error and was unable to complete your request. Please try again later.	サービス内部エラーです。後で再試行してください。
503	serviceBusy	The server is busy and unable to complete your request. Please try again later.	サービスが混雑しています。後で再試行してください。

API 呼び出しガイド

認証と認可

連絡先

カレンダー

会議

AI Table

Docs とファイル

IM

リクエスト

基本情報

リクエストヘッダー

パスパラメータ

クエリパラメータ

リクエストボディ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード

​リクエスト

​基本情報

​リクエストヘッダー

​パスパラメータ

​クエリパラメータ

​リクエストボディ

​リクエスト例

​レスポンス

​レスポンスボディ

​レスポンスボディ例

​エラーコード

リクエスト

基本情報

リクエストヘッダー

パスパラメータ

クエリパラメータ

リクエストボディ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード