Menemukan semua sel yang cocok dengan kriteria

Panggil API ini untuk mencari semua sel yang berisi teks target di dalam Lembar Kerja tertentu pada DingTalk Spreadsheet, dan mengembalikan daftar posisi sel yang cocok. Ini cocok untuk skenario ketika konten tertentu perlu ditemukan secara massal dalam kumpulan data yang besar. API ini mendukung beberapa mode pencarian, termasuk pencocokan persis, sensitivitas huruf, ekspresi reguler, dan pencarian di dalam formula.

Permintaan

Informasi dasar

Bidang	Nilai
URL HTTP	`https://api.dingtalk.io/v1.0/doc/workbooks/{workbookId}/sheets/{sheetId}/findAll`
Metode HTTP	POST
Tipe aplikasi yang didukung	appType-Aplikasi internal
Izin yang diperlukan	permission-Document.Workbook.Read-Izin baca DingTalk Spreadsheet

Header permintaan

Nama	Tipe	Wajib	Deskripsi
x-acs-dingtalk-access-token	String	Ya	Kredensial akses untuk memanggil API ini. Panggil API Mendapatkan access token aplikasi internal untuk memperolehnya.

Parameter path

Nama	Tipe	Wajib	Deskripsi
workbookId	String	Ya	ID file spreadsheet. `nodeId(dentryUuid)` yang dikembalikan oleh API Knowledge Base adalah `workbookId` spreadsheet. Anda dapat memperolehnya dengan memanggil API Mendapatkan node dan Membuat dokumen Knowledge Base.
sheetId	String	Ya	ID atau judul Lembar Kerja. Panggil API Mendapatkan semua Lembar Kerja untuk memperoleh ID dan judul Lembar Kerja.

Parameter query

Nama	Tipe	Wajib	Deskripsi
operatorId	String	Ya	unionId operator. Panggil API Kueri detail pengguna untuk memperolehnya. Jika operator tidak memiliki izin, API mengembalikan error `The operator has no permission`.
select	String	Tidak	Memfilter bidang yang akan dikembalikan. Jika parameter ini tidak ditentukan, semua bidang dikembalikan. - Jika select=a1Notation, hanya bidang a1Notation yang dikembalikan. - Untuk mengembalikan beberapa bidang, pisahkan dengan koma. Misalnya, select=a1Notation,values hanya mengembalikan bidang a1Notation dan values. Menentukan parameter ini disarankan untuk meningkatkan performa dan menghindari timeout API ketika nilai kembalian tambahan ditambahkan di masa mendatang.

Isi permintaan

Nama	Tipe	Wajib	Deskripsi
text	String	Ya	Teks yang akan dicari. Jika useRegExp diaktifkan, ini adalah pola ekspresi reguler. Contoh: “\d+“
findOptions	Object	Ya	Opsi pencarian.
matchEntireCell	Boolean	Tidak	Apakah mencocokkan seluruh sel. Nilai yang valid: - true: Ya - false: Tidak (default)
matchCase	Boolean	Tidak	Apakah pencarian bersifat sensitif huruf. Nilai yang valid: - true: Ya - false: Tidak (default)
useRegExp	Boolean	Tidak	Apakah text merupakan ekspresi reguler. Nilai yang valid: - true: Ya - false: Tidak (default)
matchFormulaText	Boolean	Tidak	Apakah mencari berdasarkan teks formula mentah. Nilai yang valid: - true: Ya - false: Tidak (default) Misalnya, jika sebuah sel diisi dengan formula “=A1+B1” dan nilai yang ditampilkan adalah 4: - Ketika teks pencarian adalah “4” dan matchFormulaText bernilai true, sel tersebut tidak disertakan dalam hasil. - Ketika teks pencarian adalah “=A1” dan matchFormulaText bernilai true, sel tersebut disertakan dalam hasil.
scope	String	Tidak	Cakupan pencarian. Formatnya adalah alamat Range yang dinyatakan dalam notasi A1.
includeHidden	Boolean	Tidak	Apakah menyertakan sel tersembunyi, yaitu sel yang tidak terlihat akibat baris atau kolom tersembunyi, filter, grup, atau fitur sejenis. Sel yang tidak diizinkan untuk dilihat oleh pengguna tidak disertakan. Nilai yang valid: - true: Ya - false: Tidak (default)
unionCells	Boolean	Ya	Apakah mengagregasi alamat sel yang ditemukan. Agregasi disarankan; jika tidak, sejumlah besar alamat mungkin dikembalikan. Nilai yang valid: - true: Ya - false: Tidak (default)

Contoh permintaan

HTTP

POST /v1.0/doc/workbooks/e54Lq3xxx/sheets/Sheet1/findAll?operatorId=ppgAxxx&select=a1Notation 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" : false,
    "unionCells" : true
  }
}

Java

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

import com.aliyun.tea.*;

public class Sample {

    /**
     * Initialize the account Client using a Token.
     * @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.SheetFindAllHeaders sheetFindAllHeaders = new com.aliyun.dingtalkdoc_1_0.models.SheetFindAllHeaders();
        sheetFindAllHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkdoc_1_0.models.SheetFindAllRequest.SheetFindAllRequestFindOptions findOptions = new com.aliyun.dingtalkdoc_1_0.models.SheetFindAllRequest.SheetFindAllRequestFindOptions()
                .setMatchEntireCell(true)
                .setMatchCase(true)
                .setUseRegExp(true)
                .setMatchFormulaText(true)
                .setScope("A:A")
                .setIncludeHidden(false)
                .setUnionCells(true);
        com.aliyun.dingtalkdoc_1_0.models.SheetFindAllRequest sheetFindAllRequest = new com.aliyun.dingtalkdoc_1_0.models.SheetFindAllRequest()
                .setOperatorId("ppgAxxx")
                .setSelect("a1Notation")
                .setText("DingTalk")
                .setFindOptions(findOptions);
        try {
            client.sheetFindAllWithOptions("e54Lq3xxx", "Sheet1", sheetFindAllRequest, sheetFindAllHeaders, 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 berisi properti code dan message, yang membantu developer menemukan masalah
            }

        } 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 berisi properti code dan message, yang membantu developer menemukan masalah
            }

        }        
    }
}

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:
        """
        Initialize the account Client using a Token.
        @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()
        sheet_find_all_headers = dingtalkdoc__1__0_models.SheetFindAllHeaders()
        sheet_find_all_headers.x_acs_dingtalk_access_token = '<your access token>'
        find_options = dingtalkdoc__1__0_models.SheetFindAllRequestFindOptions(
            match_entire_cell=True,
            match_case=True,
            use_reg_exp=True,
            match_formula_text=True,
            scope='A:A',
            include_hidden=False,
            union_cells=True
        )
        sheet_find_all_request = dingtalkdoc__1__0_models.SheetFindAllRequest(
            operator_id='ppgAxxx',
            select='a1Notation',
            text='DingTalk',
            find_options=find_options
        )
        try:
            client.sheet_find_all_with_options('e54Lq3xxx', 'Sheet1', sheet_find_all_request, sheet_find_all_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err berisi properti code dan message, yang membantu developer menemukan masalah
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        sheet_find_all_headers = dingtalkdoc__1__0_models.SheetFindAllHeaders()
        sheet_find_all_headers.x_acs_dingtalk_access_token = '<your access token>'
        find_options = dingtalkdoc__1__0_models.SheetFindAllRequestFindOptions(
            match_entire_cell=True,
            match_case=True,
            use_reg_exp=True,
            match_formula_text=True,
            scope='A:A',
            include_hidden=False,
            union_cells=True
        )
        sheet_find_all_request = dingtalkdoc__1__0_models.SheetFindAllRequest(
            operator_id='ppgAxxx',
            select='a1Notation',
            text='DingTalk',
            find_options=find_options
        )
        try:
            await client.sheet_find_all_with_options_async('e54Lq3xxx', 'Sheet1', sheet_find_all_request, sheet_find_all_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err berisi properti code dan message, yang membantu developer menemukan masalah
                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\SheetFindAllHeaders;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\SheetFindAllRequest\findOptions;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\SheetFindAllRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * Initialize the account Client using a Token.
     * @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();
        $sheetFindAllHeaders = new SheetFindAllHeaders([]);
        $sheetFindAllHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $findOptions = new findOptions([
            "matchEntireCell" => true,
            "matchCase" => true,
            "useRegExp" => true,
            "matchFormulaText" => true,
            "scope" => "A:A",
            "includeHidden" => false,
            "unionCells" => true
        ]);
        $sheetFindAllRequest = new SheetFindAllRequest([
            "operatorId" => "ppgAxxx",
            "select" => "a1Notation",
            "text" => "DingTalk",
            "findOptions" => $findOptions
        ]);
        try {
            $client->sheetFindAllWithOptions("e54Lq3xxx", "Sheet1", $sheetFindAllRequest, $sheetFindAllHeaders, 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 berisi properti code dan message, yang membantu developer menemukan masalah
            }
        }
    }
}
$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"
)

/**
 * Initialize the account Client using a Token.
 * @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
  }

  sheetFindAllHeaders := &dingtalkdoc_1_0.SheetFindAllHeaders{}
  sheetFindAllHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  findOptions := &dingtalkdoc_1_0.SheetFindAllRequestFindOptions{
    MatchEntireCell: tea.Bool(true),
    MatchCase: tea.Bool(true),
    UseRegExp: tea.Bool(true),
    MatchFormulaText: tea.Bool(true),
    Scope: tea.String("A:A"),
    IncludeHidden: tea.Bool(false),
    UnionCells: tea.Bool(true),
  }
  sheetFindAllRequest := &dingtalkdoc_1_0.SheetFindAllRequest{
    OperatorId: tea.String("ppgAxxx"),
    Select: tea.String("a1Notation"),
    Text: tea.String("DingTalk"),
    FindOptions: findOptions,
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.SheetFindAllWithOptions(tea.String("e54Lq3xxx"), tea.String("Sheet1"), sheetFindAllRequest, sheetFindAllHeaders, &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 berisi properti code dan message, yang membantu developer menemukan masalah
    }

  }
  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 {

  /**
   * Initialize the account Client using a Token.
   * @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 sheetFindAllHeaders = new $dingtalkdoc_1_0.SheetFindAllHeaders({ });
    sheetFindAllHeaders.xAcsDingtalkAccessToken = "<your access token>";
    let findOptions = new $dingtalkdoc_1_0.SheetFindAllRequestFindOptions({
      matchEntireCell: true,
      matchCase: true,
      useRegExp: true,
      matchFormulaText: true,
      scope: "A:A",
      includeHidden: false,
      unionCells: true,
    });
    let sheetFindAllRequest = new $dingtalkdoc_1_0.SheetFindAllRequest({
      operatorId: "ppgAxxx",
      select: "a1Notation",
      text: "DingTalk",
      findOptions: findOptions,
    });
    try {
      await client.sheetFindAllWithOptions("e54Lq3xxx", "Sheet1", sheetFindAllRequest, sheetFindAllHeaders, new $Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.empty(err.code) && !Util.empty(err.message)) {
        // err berisi properti code dan message, yang membantu developer menemukan masalah
      }

    }    
  }

}

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 
    {

        /**
         * Initialize the account Client using a Token.
         * @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.SheetFindAllHeaders sheetFindAllHeaders = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.SheetFindAllHeaders();
            sheetFindAllHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.SheetFindAllRequest.SheetFindAllRequestFindOptions findOptions = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.SheetFindAllRequest.SheetFindAllRequestFindOptions
            {
                MatchEntireCell = true,
                MatchCase = true,
                UseRegExp = true,
                MatchFormulaText = true,
                Scope = "A:A",
                IncludeHidden = false,
                UnionCells = true,
            };
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.SheetFindAllRequest sheetFindAllRequest = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.SheetFindAllRequest
            {
                OperatorId = "ppgAxxx",
                Select = "a1Notation",
                Text = "DingTalk",
                FindOptions = findOptions,
            };
            try
            {
                client.SheetFindAllWithOptions("e54Lq3xxx", "Sheet1", sheetFindAllRequest, sheetFindAllHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
            }
            catch (TeaException err)
            {
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // err berisi properti code dan message, yang membantu developer menemukan masalah
                }
            }
            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 berisi properti code dan message, yang membantu developer menemukan masalah
                }
            }
        }

    }
}

Respons

Isi respons

Nama	Tipe	Deskripsi
value	Array	Jika tidak ada konten yang ditemukan, value adalah array kosong.
a1Notation	String	Alamat sel yang ditemukan. - Jika `unionCells` disetel ke `true`, alamat agregasinya mungkin `A1:B3`. - Jika `unionCells` disetel ke `false`, ini adalah alamat sel tunggal, misalnya `A1`.
values	Array
	Array of Any	Nilai dalam sel yang ditemukan (sebagai teks yang ditampilkan).

Contoh isi respons

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

{
  "value" : [ {
    "a1Notation" : "A1:B3",
    "values" : [ [ "1" ] ]
  } ]
}

Kode error

Jika terjadi error saat Anda memanggil API ini, lihat dokumen Kode error global berdasarkan pesan error untuk menemukan solusinya.

HttpCode	Kode error	Pesan error	Deskripsi
400	invalidRequest.inputArgs.workbookIdIllegal	The workbookId is illegal.	workbookId tidak valid.
400	invalidRequest.inputArgs.operatorIdIllegal	The operatorId is illegal.	operatorId tidak valid.
400	invalidRequest.inputArgs.invalid	%s	Parameter permintaan tidak valid. Periksa pesan error.
400	invalidRequest.resource.notWorkbook	%s	Tipe dokumen tidak didukung. Periksa workbookId.
403	forbidden.operationIllegal	%s	Tindakan yang diminta tidak valid. Periksa pesan error.
403	forbidden.accessDenied	The operator has no permission.	Pengguna saat ini tidak memiliki izin untuk tindakan ini.
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.	Konten spreadsheet terlalu besar. Kurangi konten spreadsheet dan coba lagi.
403	forbidden.acrossOrg	%s	Permintaan tidak valid. Periksa apakah dokumen yang akan diakses milik organisasi yang ditentukan oleh access token.
404	invalidRequest.resource.notFound	%s	Permintaan gagal. Sumber daya yang diminta tidak dapat ditemukan.
500	internalError	The server encountered an internal error and was unable to complete your request. Please try again later.	Error internal server. Coba lagi nanti.
503	serviceBusy	The server is busy and unable to complete your request. Please try again later.	Layanan sedang sibuk. Coba lagi nanti.

Panduan pemanggilan API

Autentikasi & otorisasi

Kontak

Kalender

Konferensi

AI Table

Dokumen & file

IM

Menemukan semua sel yang cocok dengan kriteria

Permintaan

Informasi dasar

Header permintaan

Parameter path

Parameter query

Isi permintaan

Contoh permintaan

Respons

Isi respons

Contoh isi respons

Kode error

​Permintaan

​Informasi dasar

​Header permintaan

​Parameter path

​Parameter query

​Isi permintaan

​Contoh permintaan

​Respons

​Isi respons

​Contoh isi respons

​Kode error

Permintaan

Informasi dasar

Header permintaan

Parameter path

Parameter query

Isi permintaan

Contoh permintaan

Respons

Isi respons

Contoh isi respons

Kode error