フィルター条件の設定

本 API を呼び出すと、グローバルフィルター内の指定列にフィルター条件を設定または更新できます。単一列のデータ表示範囲を厳密に制御したい場合に適しています。

API 呼び出し説明

新しく設定した条件は、その列の既存のフィルター条件を上書きします。条件を満たさない行は自動的に非表示になります。

リクエスト

基本情報

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

リクエストヘッダー

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

パスパラメータ

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

クエリパラメータ

名前	タイプ	必須	説明
operatorId	String	はい	操作者の unionId です。 - サイレントログインコードでユーザー情報を取得 API で unionid パラメータの値を取得できます。 - ユーザー詳細を照会 API を呼び出して unionid パラメータの値を取得できます。操作者に権限がない場合、API は `The operator has no permission` というエラーを返します。

リクエストボディ

名前	タイプ	必須	説明
column	Long	はい	列オフセット。フィルター範囲の先頭列を基準とし、0 から始まります。例えばフィルター範囲が `B1:E10` の場合、`column=0` は B 列、`column=1` は C 列を表します。
filterCriteria	Object	はい	フィルター条件オブジェクト。
filterType	String	はい	フィルタータイプ。指定可能な値: - values: 値で絞り込み - color: 色で絞り込み - condition: 条件で絞り込み
visibleValues	Array of String	いいえ	表示する値
backgroundColor	String	いいえ	背景色で絞り込む際の表示色。16 進数形式（例: `#FF0000`）。`filterType` が `color` の場合、`backgroundColor` と `fontColor` のいずれかを必須で指定します。
fontColor	String	いいえ	フォント色で絞り込む際の表示色。16 進数形式（例: `#00FF00`）。`filterType` が `color` の場合、`backgroundColor` と `fontColor` のいずれかを必須で指定します。
conditions	Array	いいえ	条件で絞り込む際の条件リスト。最大 2 件まで指定できます。`filterType` が `condition` の場合は必須です。
operator	String	いいえ	条件演算子。指定可能な値: - equal: 等しい - not-equal: 等しくない - contains: 含む - not-contains: 含まない - starts-with: ～で始まる - not-starts-with: ～で始まらない - ends-with: ～で終わる - not-ends-with: ～で終わらない - greater: より大きい - greater-equal: 以上 - less: より小さい - less-equal: 以下
value	String	いいえ	比較値
conditionOperator	String	いいえ	複数条件間の論理関係。指定可能な値: and: かつ（デフォルト） or: または。 `conditions` に 2 件の条件が含まれる場合に有効です。

リクエスト例

HTTP

POST /v1.0/doc/workbooks/{workbookId}/sheets/{sheetId}/filter/setColumnFilterCriteria HTTP/1.1
Host:api.dingtalk.io
Content-Type:application/json

{
  "column" : 0,
  "filterCriteria" : {
    "filterType" : "values",
    "visibleValues" : ["山田太郎", "佐藤花子", "鈴木一郎"]
  }
}

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.SetFilterCriteriaHeaders setFilterCriteriaHeaders = new com.aliyun.dingtalkdoc_1_0.models.SetFilterCriteriaHeaders();
        setFilterCriteriaHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkdoc_1_0.models.SetFilterCriteriaRequest.SetFilterCriteriaRequestFilterCriteriaConditions filterCriteriaConditions0 = new com.aliyun.dingtalkdoc_1_0.models.SetFilterCriteriaRequest.SetFilterCriteriaRequestFilterCriteriaConditions();
        com.aliyun.dingtalkdoc_1_0.models.SetFilterCriteriaRequest.SetFilterCriteriaRequestFilterCriteria filterCriteria = new com.aliyun.dingtalkdoc_1_0.models.SetFilterCriteriaRequest.SetFilterCriteriaRequestFilterCriteria()
                .setConditions(java.util.Arrays.asList(
                    filterCriteriaConditions0
                ));
        com.aliyun.dingtalkdoc_1_0.models.SetFilterCriteriaRequest setFilterCriteriaRequest = new com.aliyun.dingtalkdoc_1_0.models.SetFilterCriteriaRequest()
                .setFilterCriteria(filterCriteria);
        try {
            client.setFilterCriteriaWithOptions("", "", setFilterCriteriaRequest, setFilterCriteriaHeaders, 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()
        set_filter_criteria_headers = dingtalkdoc__1__0_models.SetFilterCriteriaHeaders()
        set_filter_criteria_headers.x_acs_dingtalk_access_token = '<your access token>'
        filter_criteria_conditions_0 = dingtalkdoc__1__0_models.SetFilterCriteriaRequestFilterCriteriaConditions()
        filter_criteria = dingtalkdoc__1__0_models.SetFilterCriteriaRequestFilterCriteria(
            conditions=[
                filter_criteria_conditions_0
            ]
        )
        set_filter_criteria_request = dingtalkdoc__1__0_models.SetFilterCriteriaRequest(
            filter_criteria=filter_criteria
        )
        try:
            client.set_filter_criteria_with_options('', '', set_filter_criteria_request, set_filter_criteria_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()
        set_filter_criteria_headers = dingtalkdoc__1__0_models.SetFilterCriteriaHeaders()
        set_filter_criteria_headers.x_acs_dingtalk_access_token = '<your access token>'
        filter_criteria_conditions_0 = dingtalkdoc__1__0_models.SetFilterCriteriaRequestFilterCriteriaConditions()
        filter_criteria = dingtalkdoc__1__0_models.SetFilterCriteriaRequestFilterCriteria(
            conditions=[
                filter_criteria_conditions_0
            ]
        )
        set_filter_criteria_request = dingtalkdoc__1__0_models.SetFilterCriteriaRequest(
            filter_criteria=filter_criteria
        )
        try:
            await client.set_filter_criteria_with_options_async('', '', set_filter_criteria_request, set_filter_criteria_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\SetFilterCriteriaHeaders;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\SetFilterCriteriaRequest\filterCriteria\conditions;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\SetFilterCriteriaRequest\filterCriteria;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\SetFilterCriteriaRequest;
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();
        $setFilterCriteriaHeaders = new SetFilterCriteriaHeaders([]);
        $setFilterCriteriaHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $filterCriteriaConditions0 = new conditions([]);
        $filterCriteria = new filterCriteria([
            "conditions" => [
                $filterCriteriaConditions0
            ]
        ]);
        $setFilterCriteriaRequest = new SetFilterCriteriaRequest([
            "filterCriteria" => $filterCriteria
        ]);
        try {
            $client->setFilterCriteriaWithOptions("", "", $setFilterCriteriaRequest, $setFilterCriteriaHeaders, 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
  }

  setFilterCriteriaHeaders := &dingtalkdoc_1_0.SetFilterCriteriaHeaders{}
  setFilterCriteriaHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  filterCriteriaConditions0 := &dingtalkdoc_1_0.SetFilterCriteriaRequestFilterCriteriaConditions{}
  filterCriteria := &dingtalkdoc_1_0.SetFilterCriteriaRequestFilterCriteria{
    Conditions: []*dingtalkdoc_1_0.SetFilterCriteriaRequestFilterCriteriaConditions{filterCriteriaConditions0},
  }
  setFilterCriteriaRequest := &dingtalkdoc_1_0.SetFilterCriteriaRequest{
    FilterCriteria: filterCriteria,
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.SetFilterCriteriaWithOptions(tea.String(""), tea.String(""), setFilterCriteriaRequest, setFilterCriteriaHeaders, &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 setFilterCriteriaHeaders = new dingtalkdoc_1_0.SetFilterCriteriaHeaders({ });
    setFilterCriteriaHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let filterCriteriaConditions0 = new dingtalkdoc_1_0.SetFilterCriteriaRequestFilterCriteriaConditions({ });
    let filterCriteria = new dingtalkdoc_1_0.SetFilterCriteriaRequestFilterCriteria({
      conditions: [
        filterCriteriaConditions0
      ],
    });
    let setFilterCriteriaRequest = new dingtalkdoc_1_0.SetFilterCriteriaRequest({
      filterCriteria: filterCriteria,
    });
    try {
      await client.setFilterCriteriaWithOptions('', '', setFilterCriteriaRequest, setFilterCriteriaHeaders, 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.SetFilterCriteriaHeaders setFilterCriteriaHeaders = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.SetFilterCriteriaHeaders();
            setFilterCriteriaHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.SetFilterCriteriaRequest.SetFilterCriteriaRequestFilterCriteria.SetFilterCriteriaRequestFilterCriteriaConditions filterCriteriaConditions0 = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.SetFilterCriteriaRequest.SetFilterCriteriaRequestFilterCriteria.SetFilterCriteriaRequestFilterCriteriaConditions();
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.SetFilterCriteriaRequest.SetFilterCriteriaRequestFilterCriteria filterCriteria = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.SetFilterCriteriaRequest.SetFilterCriteriaRequestFilterCriteria
            {
                Conditions = new List<AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.SetFilterCriteriaRequest.SetFilterCriteriaRequestFilterCriteria.SetFilterCriteriaRequestFilterCriteriaConditions>
                {
                    filterCriteriaConditions0
                },
            };
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.SetFilterCriteriaRequest setFilterCriteriaRequest = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.SetFilterCriteriaRequest
            {
                FilterCriteria = filterCriteria,
            };
            try
            {
                client.SetFilterCriteriaWithOptions("", "", setFilterCriteriaRequest, setFilterCriteriaHeaders, 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 の属性が含まれており、開発者の問題特定に役立ちます
                }
            }
        }

    }
}

レスポンス

レスポンスボディ

名前	タイプ	説明
id	String	フィルターの一意識別子。

レスポンスボディ例

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

{
  "id" : "flt-ecce06ec-46695"
}

エラーコード

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 呼び出し説明

リクエスト

基本情報

リクエストヘッダー

パスパラメータ

クエリパラメータ

リクエストボディ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード