フィルターの更新

本インターフェースを呼び出すことで、グローバルフィルターにおける複数列のフィルターを一括で更新できます。複数列に対してフィルタールールの設定、変更、またはクリアを同時に行う必要があるシーンに適しています。たとえば、データ分析レポートで、メンバー、金額範囲、マークカラーといった複数の観点で同時に絞り込みを行う場合などです。

リクエスト

基本情報

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

リクエストヘッダー

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

パスパラメータ

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

クエリパラメータ

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

リクエストボディ

名前	タイプ	必須	説明
criteria	`Map<String, Object>`	はい	列オフセットからフィルターへのマッピング。Key は列オフセット（フィルター範囲の先頭列を基準とした、0 から始まる文字列）、Value はその列のフィルターオブジェクトまたは `null`（その列のフィルターをクリアすることを意味します）です。
	Object	いいえ	該当列に対応するフィルター
filterType	String	いいえ	フィルタータイプ。指定可能な値： - values：値で絞り込み - color：色で絞り込み - condition：条件で絞り込み
visibleValues	Array of String	いいえ	表示する値
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"`。`filterType` が `condition` の場合のみ指定します。
backgroundColor	String	いいえ	背景色で絞り込み。16 進カラー値（例：`"#FF0000"`）。`filterType` が `color` の場合のみ指定します。
fontColor	String	いいえ	フォント色で絞り込み。16 進カラー値（例：`"#0000FF"`）。`filterType` が `color` の場合のみ指定します。

リクエスト例

HTTP

POST /v1.0/doc/workbooks/e54Lq3xxx/sheets/Sheet1/filter/updateFilter?operatorId=ppgAxxx HTTP/1.1
Host:api.dingtalk.io
Content-Type:application/json

{
  "criteria" : {
    "0" : {
      "filterType" : "values",
      "visibleValues" : ["山田太郎", "佐藤花子", "鈴木一郎"]
    },
    "2" : {
      "filterType" : "condition",
      "conditions" : [
        {
          "operator" : "greater",
          "value" : "100"
        }
      ]
    }
  }
}

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.UpdateFilterHeaders updateFilterHeaders = new com.aliyun.dingtalkdoc_1_0.models.UpdateFilterHeaders();
        updateFilterHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkdoc_1_0.models.CriteriaValue.CriteriaValueConditions criteriaValueKeyConditions0 = new com.aliyun.dingtalkdoc_1_0.models.CriteriaValue.CriteriaValueConditions();
        com.aliyun.dingtalkdoc_1_0.models.CriteriaValue criteriaValueKey = new com.aliyun.dingtalkdoc_1_0.models.CriteriaValue()
                .setConditions(java.util.Arrays.asList(
                    criteriaValueKeyConditions0
                ));
        java.util.Map<String, com.aliyun.dingtalkdoc_1_0.models.CriteriaValue> criteria = TeaConverter.buildMap(
            new TeaPair("criteriaValueKey", criteriaValueKey)
        );
        com.aliyun.dingtalkdoc_1_0.models.UpdateFilterRequest updateFilterRequest = new com.aliyun.dingtalkdoc_1_0.models.UpdateFilterRequest()
                .setOperatorId("ppgAxxx")
                .setCriteria(criteria);
        try {
            client.updateFilterWithOptions("e54Lq3xxx", "Sheet1", updateFilterRequest, updateFilterHeaders, 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()
        update_filter_headers = dingtalkdoc__1__0_models.UpdateFilterHeaders()
        update_filter_headers.x_acs_dingtalk_access_token = '<your access token>'
        criteria_value_key_conditions_0 = dingtalkdoc__1__0_models.CriteriaValueConditions()
        criteria_value_key = dingtalkdoc__1__0_models.CriteriaValue(
            conditions=[
                criteria_value_key_conditions_0
            ]
        )
        criteria = {
            'criteriaValueKey': criteria_value_key
        }
        update_filter_request = dingtalkdoc__1__0_models.UpdateFilterRequest(
            operator_id='ppgAxxx',
            criteria=criteria
        )
        try:
            client.update_filter_with_options('e54Lq3xxx', 'Sheet1', update_filter_request, update_filter_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()
        update_filter_headers = dingtalkdoc__1__0_models.UpdateFilterHeaders()
        update_filter_headers.x_acs_dingtalk_access_token = '<your access token>'
        criteria_value_key_conditions_0 = dingtalkdoc__1__0_models.CriteriaValueConditions()
        criteria_value_key = dingtalkdoc__1__0_models.CriteriaValue(
            conditions=[
                criteria_value_key_conditions_0
            ]
        )
        criteria = {
            'criteriaValueKey': criteria_value_key
        }
        update_filter_request = dingtalkdoc__1__0_models.UpdateFilterRequest(
            operator_id='ppgAxxx',
            criteria=criteria
        )
        try:
            await client.update_filter_with_options_async('e54Lq3xxx', 'Sheet1', update_filter_request, update_filter_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\UpdateFilterHeaders;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\CriteriaValue\conditions;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\CriteriaValue;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\UpdateFilterRequest;
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();
        $updateFilterHeaders = new UpdateFilterHeaders([]);
        $updateFilterHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $criteriaValueKeyConditions0 = new conditions([]);
        $criteriaValueKey = new CriteriaValue([
            "conditions" => [
                $criteriaValueKeyConditions0
            ]
        ]);
        $criteria = [
            "criteriaValueKey" => $criteriaValueKey
        ];
        $updateFilterRequest = new UpdateFilterRequest([
            "operatorId" => "ppgAxxx",
            "criteria" => $criteria
        ]);
        try {
            $client->updateFilterWithOptions("e54Lq3xxx", "Sheet1", $updateFilterRequest, $updateFilterHeaders, 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
  }

  updateFilterHeaders := &dingtalkdoc_1_0.UpdateFilterHeaders{}
  updateFilterHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  criteriaValueKeyConditions0 := &dingtalkdoc_1_0.CriteriaValueConditions{}
  criteriaValueKey := &dingtalkdoc_1_0.CriteriaValue{
    Conditions: []*dingtalkdoc_1_0.CriteriaValueConditions{criteriaValueKeyConditions0},
  }
  criteria := map[string]*dingtalkdoc_1_0.CriteriaValue{
    "criteriaValueKey": criteriaValueKey,
  }
  updateFilterRequest := &dingtalkdoc_1_0.UpdateFilterRequest{
    OperatorId: tea.String("ppgAxxx"),
    Criteria: criteria,
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.UpdateFilterWithOptions(tea.String("e54Lq3xxx"), tea.String("Sheet1"), updateFilterRequest, updateFilterHeaders, &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 updateFilterHeaders = new dingtalkdoc_1_0.UpdateFilterHeaders({ });
    updateFilterHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let criteriaValueKeyConditions0 = new dingtalkdoc_1_0.CriteriaValueConditions({ });
    let criteriaValueKey = new dingtalkdoc_1_0.CriteriaValue({
      conditions: [
        criteriaValueKeyConditions0
      ],
    });
    let criteria = {
      criteriaValueKey: criteriaValueKey,
    };
    let updateFilterRequest = new dingtalkdoc_1_0.UpdateFilterRequest({
      operatorId: 'ppgAxxx',
      criteria: criteria,
    });
    try {
      await client.updateFilterWithOptions('e54Lq3xxx', 'Sheet1', updateFilterRequest, updateFilterHeaders, 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.UpdateFilterHeaders updateFilterHeaders = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.UpdateFilterHeaders();
            updateFilterHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CriteriaValue.CriteriaValueConditions criteriaValueKeyConditions0 = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CriteriaValue.CriteriaValueConditions();
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CriteriaValue criteriaValueKey = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CriteriaValue
            {
                Conditions = new List<AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CriteriaValue.CriteriaValueConditions>
                {
                    criteriaValueKeyConditions0
                },
            };
            Dictionary<string, AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CriteriaValue> criteria = new Dictionary<string, AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CriteriaValue>
            {
                {"criteriaValueKey", criteriaValueKey},
            };
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.UpdateFilterRequest updateFilterRequest = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.UpdateFilterRequest
            {
                OperatorId = "ppgAxxx",
                Criteria = criteria,
            };
            try
            {
                client.UpdateFilterWithOptions("e54Lq3xxx", "Sheet1", updateFilterRequest, updateFilterHeaders, 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	Id of the request

レスポンスボディ例

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

{
  "id" : "filter-xxxxx"
}

エラーコード

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

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	リクエストが不正です。アクセス対象のドキュメントがアクセストークンで指定した組織に所属しているかをご確認ください。
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

リクエスト

基本情報

リクエストヘッダー

パスパラメータ

クエリパラメータ

リクエストボディ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード

​リクエスト

​基本情報

​リクエストヘッダー

​パスパラメータ

​クエリパラメータ

​リクエストボディ

​リクエスト例

​レスポンス

​レスポンスボディ

​レスポンスボディ例

​エラーコード

リクエスト

基本情報

リクエストヘッダー

パスパラメータ

クエリパラメータ

リクエストボディ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード