ワークシート内のセルを検索

指定された条件に基づき、与えられた文字列に一致する次のセルを検索します。検索範囲は、指定領域（rangeAddress）の左上セル以降のワークシート全体です。findOptions.scope パラメータを指定した場合、検索範囲はさらにその範囲と積集合を取ります。

リクエスト

基本情報

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

リクエストヘッダー

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

パスパラメータ

名前	タイプ	必須	説明
workbookId	String	はい	スプレッドシートファイルの ID です。`nodeId`（dentryUuid）がスプレッドシートの `workbookId` に相当します。ノードを取得およびナレッジベースドキュメントを作成を呼び出して取得できます。
sheetId	String	はい	ワークシートの ID またはタイトルです。すべてのワークシートを取得を呼び出して id を取得するか、ワークシートのタイトルを渡してください。
rangeAddress	String	はい	検索を開始する起点位置です。この領域の左上のセルから開始します（ただし当該セル自体は含まれません）。

クエリパラメータ

名前	タイプ	必須	説明
operatorId	String	はい	操作者の unionId です。

リクエストボディ

名前	タイプ	必須	説明
text	String	はい	検索するテキストです。
findOptions	Object	いいえ	検索オプションです。
matchEntireCell	Boolean	いいえ	セル全体に一致させるかどうか： - true：はい - false：いいえ
matchCase	Boolean	いいえ	大文字小文字を区別するかどうか： - true：はい - false：いいえ
useRegExp	Boolean	いいえ	text パラメータを正規表現として扱うかどうか： - true：はい - false：いいえ
matchFormulaText	Boolean	いいえ	数式内を検索するかどうか： - true：はい - false：いいえ
scope	String	いいえ	検索範囲です。A1 表記で指定する Range アドレス形式です。
includeHidden	Boolean	いいえ	非表示のセルを含めるかどうか。すなわち、行・列の非表示、絞り込み、グループ分けなどの機能により不可視となったセルを指します。ただし、閲覧権限のないセルは含まれません。 - true：はい - false：いいえ

リクエスト例

HTTP

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

{
  "text" : "DingTalk",
  "findOptions" : {
    "matchEntireCell" : true,
    "matchCase" : true,
    "useRegExp" : true,
    "matchFormulaText" : true,
    "scope" : "A:A",
    "includeHidden" : true
  }
}

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.RangeFindNextHeaders rangeFindNextHeaders = new com.aliyun.dingtalkdoc_1_0.models.RangeFindNextHeaders();
        rangeFindNextHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkdoc_1_0.models.RangeFindNextRequest.RangeFindNextRequestFindOptions findOptions = new com.aliyun.dingtalkdoc_1_0.models.RangeFindNextRequest.RangeFindNextRequestFindOptions()
                .setMatchEntireCell(true)
                .setMatchCase(true)
                .setUseRegExp(true)
                .setMatchFormulaText(true)
                .setScope("A:A")
                .setIncludeHidden(true);
        com.aliyun.dingtalkdoc_1_0.models.RangeFindNextRequest rangeFindNextRequest = new com.aliyun.dingtalkdoc_1_0.models.RangeFindNextRequest()
                .setOperatorId("ppgAxxx")
                .setText("DingTalk")
                .setFindOptions(findOptions);
        try {
            client.rangeFindNextWithOptions("e54Lq3xxx", "Sheet1", "B2:C3", rangeFindNextRequest, rangeFindNextHeaders, 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()
        range_find_next_headers = dingtalkdoc__1__0_models.RangeFindNextHeaders()
        range_find_next_headers.x_acs_dingtalk_access_token = '<your access token>'
        find_options = dingtalkdoc__1__0_models.RangeFindNextRequestFindOptions(
            match_entire_cell=True,
            match_case=True,
            use_reg_exp=True,
            match_formula_text=True,
            scope='A:A',
            include_hidden=True
        )
        range_find_next_request = dingtalkdoc__1__0_models.RangeFindNextRequest(
            operator_id='ppgAxxx',
            text='DingTalk',
            find_options=find_options
        )
        try:
            client.range_find_next_with_options('e54Lq3xxx', 'Sheet1', 'B2:C3', range_find_next_request, range_find_next_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()
        range_find_next_headers = dingtalkdoc__1__0_models.RangeFindNextHeaders()
        range_find_next_headers.x_acs_dingtalk_access_token = '<your access token>'
        find_options = dingtalkdoc__1__0_models.RangeFindNextRequestFindOptions(
            match_entire_cell=True,
            match_case=True,
            use_reg_exp=True,
            match_formula_text=True,
            scope='A:A',
            include_hidden=True
        )
        range_find_next_request = dingtalkdoc__1__0_models.RangeFindNextRequest(
            operator_id='ppgAxxx',
            text='DingTalk',
            find_options=find_options
        )
        try:
            await client.range_find_next_with_options_async('e54Lq3xxx', 'Sheet1', 'B2:C3', range_find_next_request, range_find_next_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\RangeFindNextHeaders;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\RangeFindNextRequest\findOptions;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\RangeFindNextRequest;
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();
        $rangeFindNextHeaders = new RangeFindNextHeaders([]);
        $rangeFindNextHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $findOptions = new findOptions([
            "matchEntireCell" => true,
            "matchCase" => true,
            "useRegExp" => true,
            "matchFormulaText" => true,
            "scope" => "A:A",
            "includeHidden" => true
        ]);
        $rangeFindNextRequest = new RangeFindNextRequest([
            "operatorId" => "ppgAxxx",
            "text" => "DingTalk",
            "findOptions" => $findOptions
        ]);
        try {
            $client->rangeFindNextWithOptions("e54Lq3xxx", "Sheet1", "B2:C3", $rangeFindNextRequest, $rangeFindNextHeaders, 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
  }

  rangeFindNextHeaders := &dingtalkdoc_1_0.RangeFindNextHeaders{}
  rangeFindNextHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  findOptions := &dingtalkdoc_1_0.RangeFindNextRequestFindOptions{
    MatchEntireCell: tea.Bool(true),
    MatchCase: tea.Bool(true),
    UseRegExp: tea.Bool(true),
    MatchFormulaText: tea.Bool(true),
    Scope: tea.String("A:A"),
    IncludeHidden: tea.Bool(true),
  }
  rangeFindNextRequest := &dingtalkdoc_1_0.RangeFindNextRequest{
    OperatorId: tea.String("ppgAxxx"),
    Text: tea.String("DingTalk"),
    FindOptions: findOptions,
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.RangeFindNextWithOptions(tea.String("e54Lq3xxx"), tea.String("Sheet1"), tea.String("B2:C3"), rangeFindNextRequest, rangeFindNextHeaders, &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 rangeFindNextHeaders = new dingtalkdoc_1_0.RangeFindNextHeaders({ });
    rangeFindNextHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let findOptions = new dingtalkdoc_1_0.RangeFindNextRequestFindOptions({
      matchEntireCell: true,
      matchCase: true,
      useRegExp: true,
      matchFormulaText: true,
      scope: 'A:A',
      includeHidden: true,
    });
    let rangeFindNextRequest = new dingtalkdoc_1_0.RangeFindNextRequest({
      operatorId: 'ppgAxxx',
      text: 'DingTalk',
      findOptions: findOptions,
    });
    try {
      await client.rangeFindNextWithOptions('e54Lq3xxx', 'Sheet1', 'B2:C3', rangeFindNextRequest, rangeFindNextHeaders, 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.RangeFindNextHeaders rangeFindNextHeaders = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.RangeFindNextHeaders();
            rangeFindNextHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.RangeFindNextRequest.RangeFindNextRequestFindOptions findOptions = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.RangeFindNextRequest.RangeFindNextRequestFindOptions
            {
                MatchEntireCell = true,
                MatchCase = true,
                UseRegExp = true,
                MatchFormulaText = true,
                Scope = "A:A",
                IncludeHidden = true,
            };
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.RangeFindNextRequest rangeFindNextRequest = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.RangeFindNextRequest
            {
                OperatorId = "ppgAxxx",
                Text = "DingTalk",
                FindOptions = findOptions,
            };
            try
            {
                client.RangeFindNextWithOptions("e54Lq3xxx", "Sheet1", "B2:C3", rangeFindNextRequest, rangeFindNextHeaders, 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 表記で示します。

レスポンスボディ例

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

{
  "a1Notation" : "C2"
}

エラーコード

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

HttpCode	エラーコード	エラーメッセージ	説明
400	invalidRequest.inputArgs.workbookIdIllegal	The workbookId is illegal.	workbookId が不正です。
400	invalidRequest.inputArgs.operatorIdIllegal	The operatorId is illegal.	operatorId が不正です。
400	invalidRequest.inputArgs.invalid	%s	リクエストパラメータが不正です。エラーメッセージをご確認ください。
400	invalidRequest.resource.notWorkbook	%s	サポートされていないドキュメントタイプです。workbookId をご確認ください。
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.	スプレッドシートのコンテンツが大きすぎます。コンテンツを削減してお試しください。
403	forbidden.acrossOrg	%s	リクエストが不正です。アクセス対象のドキュメントが、アクセストークンで指定された組織に所属しているかをご確認ください。
404	invalidRequest.resource.notFound	%s	リクエストに失敗しました。アクセス対象のリソースが見つかりません。
500	internalError	The server encountered an internal error and was unable to complete your request. Please try again later.	サーバー内部エラーです。後で再試行してください。
500	serviceBusy	The server is busy and unable to complete your request. Please try again later.	サーバーが混雑しています。後で再試行してください。

API 呼び出しガイド

認証と認可

連絡先

カレンダー

会議

AI Table

Docs とファイル

IM

ワークシート内のセルを検索

リクエスト

基本情報

リクエストヘッダー

パスパラメータ

クエリパラメータ

リクエストボディ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード

​リクエスト

​基本情報

​リクエストヘッダー

​パスパラメータ

​クエリパラメータ

​リクエストボディ

​リクエスト例

​レスポンス

​レスポンスボディ

​レスポンスボディ例

​エラーコード

リクエスト

基本情報

リクエストヘッダー

パスパラメータ

クエリパラメータ

リクエストボディ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード