ワークシートへの行追加

本 API を呼び出すと、DingTalk スプレッドシートのワークシートの既存データの末尾に複数行のデータを追加できます。システムはデータが存在する最終行を自動的に検出し、その直下に新しい行を挿入します。

API 呼び出し説明

ワークシート内でデータが存在する最終行を自動的に検出し、その下に新しい行データを追加します。
values の二次元配列で渡すことで、一度に複数行のデータを追加できます。
ワークシートが空の場合、データは 1 行目から書き込まれます。
追加したデータが配置されたセル範囲（A1 表記）を返します。
追加するデータの列数は、ワークシートの既存データの列数と一致させ、データの揃えを確保してください。

リクエスト

基本情報

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

リクエストヘッダー

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

パスパラメータ

名前	タイプ	必須	説明
workbookId	String	はい	スプレッドシートファイルの ID。`nodeId`（dentryUuid）を渡すと、それがスプレッドシートの `workbookId` となります。ノードを取得およびナレッジベースドキュメントを作成 API を呼び出して取得できます。
sheetId	String	はい	ワークシートの ID または見出し。すべてのワークシートを取得 API を呼び出して取得するか、ワークシートの見出しを入力してください。

クエリパラメータ

名前	タイプ	必須	説明
operatorId	String	はい	操作者の unionId。サイレントログインコードでユーザー情報を取得または userId からユーザー詳細を取得 API のいずれかで取得できます。

リクエストボディ

名前	タイプ	必須	説明
values	Array of Array	はい	追加するデータのリスト。

リクエスト例

HTTP

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

{
  "values" : [ [ "text" ] ]
}

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.AppendRowsHeaders appendRowsHeaders = new com.aliyun.dingtalkdoc_1_0.models.AppendRowsHeaders();
        appendRowsHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkdoc_1_0.models.AppendRowsRequest appendRowsRequest = new com.aliyun.dingtalkdoc_1_0.models.AppendRowsRequest()
                .setOperatorId("ppgAQxxxxgiEiE")
                .setValues(java.util.Arrays.asList(
                    java.util.Arrays.asList(
                        "text"
                    )
                ));
        try {
            client.appendRowsWithOptions("e54Lqxxx", "Sheet1", appendRowsRequest, appendRowsHeaders, 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()
        append_rows_headers = dingtalkdoc__1__0_models.AppendRowsHeaders()
        append_rows_headers.x_acs_dingtalk_access_token = '<your access token>'
        append_rows_request = dingtalkdoc__1__0_models.AppendRowsRequest(
            operator_id='ppgAQxxxxgiEiE',
            values=[
                [
                    'text'
                ]
            ]
        )
        try:
            client.append_rows_with_options('e54Lqxxx', 'Sheet1', append_rows_request, append_rows_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()
        append_rows_headers = dingtalkdoc__1__0_models.AppendRowsHeaders()
        append_rows_headers.x_acs_dingtalk_access_token = '<your access token>'
        append_rows_request = dingtalkdoc__1__0_models.AppendRowsRequest(
            operator_id='ppgAQxxxxgiEiE',
            values=[
                [
                    'text'
                ]
            ]
        )
        try:
            await client.append_rows_with_options_async('e54Lqxxx', 'Sheet1', append_rows_request, append_rows_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\AppendRowsHeaders;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\AppendRowsRequest;
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();
        $appendRowsHeaders = new AppendRowsHeaders([]);
        $appendRowsHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $appendRowsRequest = new AppendRowsRequest([
            "operatorId" => "ppgAQxxxxgiEiE",
            "values" => [
                [
                    "text"
                ]
            ]
        ]);
        try {
            $client->appendRowsWithOptions("e54Lqxxx", "Sheet1", $appendRowsRequest, $appendRowsHeaders, 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
  }

  appendRowsHeaders := &dingtalkdoc_1_0.AppendRowsHeaders{}
  appendRowsHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  appendRowsRequest := &dingtalkdoc_1_0.AppendRowsRequest{
    OperatorId: tea.String("ppgAQxxxxgiEiE"),
    Values: [][]*string{[]*string{tea.String("text")}},
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.AppendRowsWithOptions(tea.String("e54Lqxxx"), tea.String("Sheet1"), appendRowsRequest, appendRowsHeaders, &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 appendRowsHeaders = new dingtalkdoc_1_0.AppendRowsHeaders({ });
    appendRowsHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let appendRowsRequest = new dingtalkdoc_1_0.AppendRowsRequest({
      operatorId: 'ppgAQxxxxgiEiE',
      values: [
        [
          'text'
        ]
      ],
    });
    try {
      await client.appendRowsWithOptions('e54Lqxxx', 'Sheet1', appendRowsRequest, appendRowsHeaders, 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.AppendRowsHeaders appendRowsHeaders = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.AppendRowsHeaders();
            appendRowsHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.AppendRowsRequest appendRowsRequest = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.AppendRowsRequest
            {
                OperatorId = "ppgAQxxxxgiEiE",
                Values = new List<List<string>>
                {
                    new List<string>
                    {
                        "text"
                    }
                },
            };
            try
            {
                client.AppendRowsWithOptions("e54Lqxxx", "Sheet1", appendRowsRequest, appendRowsHeaders, 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 属性が含まれており、開発時の問題特定に役立ちます
                }
            }
        }

    }
}

レスポンス

レスポンスボディ

名前	タイプ	説明
a1Notation	String	A1 表記による Range アドレス

レスポンスボディ例

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

{
  "a1Notation" : "a1_notation"
}

エラーコード

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

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.	ドキュメントを初期化中です。後で再試行してください。
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

API 呼び出し説明

リクエスト

基本情報

リクエストヘッダー

パスパラメータ

クエリパラメータ

リクエストボディ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード

​API 呼び出し説明

​リクエスト

​基本情報

​リクエストヘッダー

​パスパラメータ

​クエリパラメータ

​リクエストボディ

​リクエスト例

​レスポンス

​レスポンスボディ

​レスポンスボディ例

​エラーコード

API 呼び出し説明

リクエスト

基本情報

リクエストヘッダー

パスパラメータ

クエリパラメータ

リクエストボディ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード