絞り込みビューの一覧取得

本 API を呼び出すことで、指定したワークシート上のすべての絞り込みビューの一覧を取得できます。各絞り込みビューの ID、名前、範囲、フィルター条件が返されます。絞り込みビューを管理または切り替える前に既存のビューを列挙する場合や、プログラム内で絞り込みビュー設定を一括して読み取り後続処理を行う場合に適しています。

リクエスト

基本情報

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

リクエストヘッダー

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

パスパラメータ

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

クエリパラメータ

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

リクエスト例

HTTP

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

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.GetFilterViewsHeaders getFilterViewsHeaders = new com.aliyun.dingtalkdoc_1_0.models.GetFilterViewsHeaders();
        getFilterViewsHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkdoc_1_0.models.GetFilterViewsRequest getFilterViewsRequest = new com.aliyun.dingtalkdoc_1_0.models.GetFilterViewsRequest()
                .setOperatorId("ppgAxxx");
        try {
            client.getFilterViewsWithOptions("e54Lq3xxx", "Sheet1", getFilterViewsRequest, getFilterViewsHeaders, 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()
        get_filter_views_headers = dingtalkdoc__1__0_models.GetFilterViewsHeaders()
        get_filter_views_headers.x_acs_dingtalk_access_token = '<your access token>'
        get_filter_views_request = dingtalkdoc__1__0_models.GetFilterViewsRequest(
            operator_id='ppgAxxx'
        )
        try:
            client.get_filter_views_with_options('e54Lq3xxx', 'Sheet1', get_filter_views_request, get_filter_views_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_filter_views_headers = dingtalkdoc__1__0_models.GetFilterViewsHeaders()
        get_filter_views_headers.x_acs_dingtalk_access_token = '<your access token>'
        get_filter_views_request = dingtalkdoc__1__0_models.GetFilterViewsRequest(
            operator_id='ppgAxxx'
        )
        try:
            await client.get_filter_views_with_options_async('e54Lq3xxx', 'Sheet1', get_filter_views_request, get_filter_views_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\GetFilterViewsHeaders;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\GetFilterViewsRequest;
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();
        $getFilterViewsHeaders = new GetFilterViewsHeaders([]);
        $getFilterViewsHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $getFilterViewsRequest = new GetFilterViewsRequest([
            "operatorId" => "ppgAxxx"
        ]);
        try {
            $client->getFilterViewsWithOptions("e54Lq3xxx", "Sheet1", $getFilterViewsRequest, $getFilterViewsHeaders, 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
  }

  getFilterViewsHeaders := &dingtalkdoc_1_0.GetFilterViewsHeaders{}
  getFilterViewsHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  getFilterViewsRequest := &dingtalkdoc_1_0.GetFilterViewsRequest{
    OperatorId: tea.String("ppgAxxx"),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.GetFilterViewsWithOptions(tea.String("e54Lq3xxx"), tea.String("Sheet1"), getFilterViewsRequest, getFilterViewsHeaders, &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 getFilterViewsHeaders = new dingtalkdoc_1_0.GetFilterViewsHeaders({ });
    getFilterViewsHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let getFilterViewsRequest = new dingtalkdoc_1_0.GetFilterViewsRequest({
      operatorId: 'ppgAxxx',
    });
    try {
      await client.getFilterViewsWithOptions('e54Lq3xxx', 'Sheet1', getFilterViewsRequest, getFilterViewsHeaders, 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.GetFilterViewsHeaders getFilterViewsHeaders = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.GetFilterViewsHeaders();
            getFilterViewsHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.GetFilterViewsRequest getFilterViewsRequest = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.GetFilterViewsRequest
            {
                OperatorId = "ppgAxxx",
            };
            try
            {
                client.GetFilterViewsWithOptions("e54Lq3xxx", "Sheet1", getFilterViewsRequest, getFilterViewsHeaders, 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 属性が含まれており、開発時の問題特定に役立ちます
                }
            }
        }

    }
}

レスポンス

レスポンスボディ

名前	タイプ	説明
filterViews	Array	絞り込みビューのリスト。絞り込みビューが存在しない場合は空の配列となります。
id	String	絞り込みビューの一意識別 ID。
name	String	絞り込みビューの名前。
range	String	絞り込みビューの範囲（A1 表記）。
criteria	`Map<String, Object>`	各列のフィルターです。key は列のオフセット（range の先頭列を基準とし、0 から開始）、value はフィルター条件オブジェクトです。フィルター条件がない場合は空オブジェクト `{}` となります。
	Object	フィルター条件
filterType	String	絞り込みタイプ。設定可能な値：`values`（値で絞り込み）、`condition`（条件で絞り込み）、`color`（色で絞り込み）。
visibleValues	Array of String	表示する値
conditions	Array	条件で絞り込む場合の、絞り込み条件のリスト。`filterType` が `condition` の場合に有効です。各条件オブジェクトには `operator`（演算子）と `value`（条件値）フィールドが含まれます。
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`（または）。デフォルトは `and`。`filterType` が `condition` で複数条件がある場合に有効です。
backgroundColor	String	背景色で絞り込む場合、色値（16 進数、例：`#FF0000`）を指定します。`filterType` が `color` の場合に有効で、`fontColor` といずれかを選択します。
fontColor	String	フォント色で絞り込む場合、色値（16 進数、例：`#FF0000`）を指定します。`filterType` が `color` の場合に有効で、`backgroundColor` といずれかを選択します。

レスポンスボディ例

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

{
  "filterViews" : [ {
    "id" : "fv-xxxxx",
    "name" : "売上データ絞り込み",
    "range" : "A1:E20",
    "criteria" : {
      "key" : {
        "filterType" : "values",
        "visibleValues" : [ "123" ],
        "conditions" : [ {
          "operator" : "equal",
          "value" : "123"
        } ],
        "conditionOperator" : "or",
        "backgroundColor" : "#FF0000",
        "fontColor" : "#00FFFF"
      }
    }
  } ]
}

エラーコード

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

絞り込みビューの一覧取得

リクエスト

基本情報

リクエストヘッダー

パスパラメータ

クエリパラメータ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード

​リクエスト

​基本情報

​リクエストヘッダー

​パスパラメータ

​クエリパラメータ

​リクエスト例

​レスポンス

​レスポンスボディ

​レスポンスボディ例

​エラーコード

リクエスト

基本情報

リクエストヘッダー

パスパラメータ

クエリパラメータ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード