セル範囲の取得

本インターフェースを呼び出すと、セルの属性を取得できます。現在、セル内の値、数式、表示値、背景色、フォントサイズ、水平揃え、垂直揃えを取得できます。

リクエスト

基本情報

フィールド	値
HTTP URL	`https://api.dingtalk.io/v1.0/doc/workbooks/{workbookId}/sheets/{sheetId}/ranges/{rangeAddress}`
HTTP Method	GET
対応アプリタイプ	appType-社内アプリ
必要な権限	permission-Document.Workbook.Read-スプレッドシート読み取り権限

リクエストヘッダー

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

パスパラメータ

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

クエリパラメータ

名前	タイプ	必須	説明
select	String	いいえ	返却するフィールドを絞り込みます。本パラメータを指定しない場合、すべてのフィールドが返されます。 - 例：`select=values` を指定すると、本インターフェースは values フィールドのみ返します。 - 複数のフィールドを返す場合はカンマで区切ります。例：`select=values,formulas` を指定すると、本インターフェースは values と formulas フィールドのみ返します。パフォーマンス向上のため、また将来的に返却値が追加された際の API タイムアウトを避けるため、本パラメータの指定を推奨します。
operatorId	String	はい	操作者の unionId。 - サイレントログインコードによるユーザー情報の取得インターフェースを呼び出して unionid パラメータの値を取得できます。 - ユーザー詳細の照会インターフェースを呼び出して unionid パラメータの値を取得できます。操作者に権限がない場合、インターフェースは `The operator has no permission` のエラーを返します。

リクエスト例

HTTP

GET /v1.0/doc/workbooks/e54Lq3xxx/sheets/Sheet1/ranges/A1:B2?select=values&operatorId=ppgAxxx HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:f86e0bxxx
Content-Type:application/json

Java

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

import com.aliyun.tea.*;

public class Sample {

    /**
     * トークンを使用してアカウントの Client を初期化
     * @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.GetRangeHeaders getRangeHeaders = new com.aliyun.dingtalkdoc_1_0.models.GetRangeHeaders();
        getRangeHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkdoc_1_0.models.GetRangeRequest getRangeRequest = new com.aliyun.dingtalkdoc_1_0.models.GetRangeRequest()
                .setSelect("values")
                .setOperatorId("ppgAxxx");
        try {
            client.getRangeWithOptions("e54Lq3xxx", "Sheet1", "A1:B2", getRangeRequest, getRangeHeaders, 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

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:
        """
        トークンを使用してアカウントの 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()
        get_range_headers = dingtalkdoc__1__0_models.GetRangeHeaders()
        get_range_headers.x_acs_dingtalk_access_token = '<your access token>'
        get_range_request = dingtalkdoc__1__0_models.GetRangeRequest(
            select='values',
            operator_id='ppgAxxx'
        )
        try:
            client.get_range_with_options('e54Lq3xxx', 'Sheet1', 'A1:B2', get_range_request, get_range_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()
        get_range_headers = dingtalkdoc__1__0_models.GetRangeHeaders()
        get_range_headers.x_acs_dingtalk_access_token = '<your access token>'
        get_range_request = dingtalkdoc__1__0_models.GetRangeRequest(
            select='values',
            operator_id='ppgAxxx'
        )
        try:
            await client.get_range_with_options_async('e54Lq3xxx', 'Sheet1', 'A1:B2', get_range_request, get_range_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\GetRangeHeaders;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\GetRangeRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * トークンを使用してアカウントの 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();
        $getRangeHeaders = new GetRangeHeaders([]);
        $getRangeHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $getRangeRequest = new GetRangeRequest([
            "select" => "values",
            "operatorId" => "ppgAxxx"
        ]);
        try {
            $client->getRangeWithOptions("e54Lq3xxx", "Sheet1", "A1:B2", $getRangeRequest, $getRangeHeaders, 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"
)

/**
 * トークンを使用してアカウントの 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
  }

  getRangeHeaders := &dingtalkdoc_1_0.GetRangeHeaders{}
  getRangeHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  getRangeRequest := &dingtalkdoc_1_0.GetRangeRequest{
    Select: tea.String("values"),
    OperatorId: tea.String("ppgAxxx"),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.GetRangeWithOptions(tea.String("e54Lq3xxx"), tea.String("Sheet1"), tea.String("A1:B2"), getRangeRequest, getRangeHeaders, &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 {

  /**
   * トークンを使用してアカウントの 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 getRangeHeaders = new $dingtalkdoc_1_0.GetRangeHeaders({ });
    getRangeHeaders.xAcsDingtalkAccessToken = "<your access token>";
    let getRangeRequest = new $dingtalkdoc_1_0.GetRangeRequest({
      select: "values",
      operatorId: "ppgAxxx",
    });
    try {
      await client.getRangeWithOptions("e54Lq3xxx", "Sheet1", "A1:B2", getRangeRequest, getRangeHeaders, 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 
    {

        /**
         * トークンを使用してアカウントの Client を初期化
         * @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.GetRangeHeaders getRangeHeaders = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.GetRangeHeaders();
            getRangeHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.GetRangeRequest getRangeRequest = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.GetRangeRequest
            {
                Select = "values",
                OperatorId = "ppgAxxx",
            };
            try
            {
                client.GetRangeWithOptions("e54Lq3xxx", "Sheet1", "A1:B2", getRangeRequest, getRangeHeaders, 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 の属性が含まれており、開発時の問題特定に役立ちます
                }
            }
        }

    }
}

レスポンス

レスポンスボディ

名前	タイプ	説明
values	Array	セルの値。セルが数式の場合は、数式の計算結果が返されます。二次元配列の形式で、第一次元は Range 範囲内のすべての行、第二次元は Range 範囲内の各行のセルの値です。
	Array of Any	セルの値。セルが数式の場合は、数式の計算結果が返されます。二次元配列の形式で、第一次元は Range 範囲内のすべての行、第二次元は Range 範囲内の各行のセルの値です。
formulas	Array	セルの数式。二次元配列の形式で、第一次元は Range 範囲内のすべての行、第二次元は Range 範囲内の各行のすべてのセルの数式です。
	Array of String	セルの数式。二次元配列の形式で、第一次元は Range 範囲内のすべての行、第二次元は Range 範囲内の各行のすべてのセルの数式です。
displayValues	Array	セルの表示値。表示値はスプレッドシート画面上で表示される結果です。values と比較して、番号フォーマット（小数桁数、パーセント、日付フォーマットなど）の影響を受けます。二次元配列の形式で、第一次元は Range 範囲内のすべての行、第二次元は Range 範囲内の各行のすべてのセルの表示値です。
	Array of String	セルの表示値。表示値はスプレッドシート画面上で表示される結果です。values と比較して、番号フォーマット（小数桁数、パーセント、日付フォーマットなど）の影響を受けます。二次元配列の形式で、第一次元は Range 範囲内のすべての行、第二次元は Range 範囲内の各行のすべてのセルの表示値です。
backgroundColors	Array	セルの背景色。二次元配列の形式で、第一次元は Range 範囲内のすべての行、第二次元は Range 範囲内の各行のすべてのセルの背景色です。
	Array	セルの背景色。二次元配列の形式で、第一次元は Range 範囲内のすべての行、第二次元は Range 範囲内の各行のすべてのセルの背景色です。
red	Integer	RGB 値の赤色の値。
green	Integer	RGB 値の緑色の値。
blue	Integer	RGB 値の青色の値。
hexString	String	16 進数で表された色。
fontSizes	Array	セルのフォントサイズ。二次元配列の形式で、第一次元は Range 範囲内のすべての行、第二次元は Range 範囲内の各行のすべてのセルのフォントサイズです。
	Array of Integer	セルのフォントサイズ。二次元配列の形式で、第一次元は Range 範囲内のすべての行、第二次元は Range 範囲内の各行のすべてのセルのフォントサイズです。
horizontalAlignments	Array	セルの水平揃え。二次元配列の形式で、第一次元は Range 範囲内のすべての行、第二次元は Range 範囲内の各行のすべてのセルの水平揃えです。
	Array of String	セルの水平揃え。二次元配列の形式で、第一次元は Range 範囲内のすべての行、第二次元は Range 範囲内の各行のすべてのセルの水平揃えです。
verticalAlignments	Array	セルの垂直揃え。二次元配列の形式で、第一次元は Range 範囲内のすべての行、第二次元は Range 範囲内の各行のすべてのセルの垂直揃えです。
	Array of String	セルの垂直揃え。二次元配列の形式で、第一次元は Range 範囲内のすべての行、第二次元は Range 範囲内の各行のすべてのセルの垂直揃えです。

レスポンスボディ例

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

{
  "values" : [ [ "1" ] ],
  "formulas" : [ [ "=B1+C2" ] ],
  "displayValues" : [ [ "100%" ] ],
  "backgroundColors" : [ [ {
    "red" : 0,
    "green" : 0,
    "blue" : 0,
    "hexString" : "#000000"
  } ] ],
  "fontSizes" : [ [ 14 ] ],
  "horizontalAlignments" : [ [ "general" ] ],
  "verticalAlignments" : [ [ "middle" ] ]
}

エラーコード

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

HttpCode	エラーコード	エラーメッセージ	説明
400	invalidRequest.inputArgs.invalid	%s	リクエストパラメータが不正です。エラーメッセージをご確認ください。
400	invalidRequest.inputArgs.workbookIdIllegal	The workbookId is illegal.	workbookId が不正です。
400	invalidRequest.resource.notWorkbook	%s	サポートされていないドキュメントタイプです。workbookId をご確認ください。
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

リクエスト

基本情報

リクエストヘッダー

パスパラメータ

クエリパラメータ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード

​リクエスト

​基本情報

​リクエストヘッダー

​パスパラメータ

​クエリパラメータ

​リクエスト例

​レスポンス

​レスポンスボディ

​レスポンスボディ例

​エラーコード

リクエスト

基本情報

リクエストヘッダー

パスパラメータ

クエリパラメータ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード