フローティング画像の削除

本インターフェースを呼び出すことで、DingTalk スプレッドシートの指定ワークシートからフローティング画像を 1 枚削除できます。削除操作は元に戻すことができず、削除後は当該画像がワークシートから削除され、API 経由で復元することはできません。不要な画像のクリーンアップや、ワークシートのビジュアル要素を再レイアウトするシーンに適しています。

リクエスト

基本情報

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

リクエストヘッダー

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

パスパラメータ

名前	タイプ	必須	説明
workbookId	String	はい	スプレッドシートファイル ID。ナレッジベース API が返す `nodeId(dentryUuid)` がスプレッドシートの `workbookId` に相当します。ノードの取得およびナレッジベースドキュメントの作成インターフェースを呼び出して取得できます。
sheetId	String	はい	ワークシート ID または見出し。すべてのワークシートを取得インターフェースを呼び出して id とワークシートの見出しを取得できます。
id	String	はい	フローティング画像 id。「フローティング画像のクエリ」インターフェースで取得できます。

クエリパラメータ

名前	タイプ	必須	説明
operatorId	String	はい	操作者の unionId。ユーザー詳細のクエリインターフェースを呼び出して取得できます。操作者に権限がない場合、インターフェースは `The operator has no permission` というエラーを返します。

リクエスト例

HTTP

DELETE /v1.0/doc/workbooks/xxx/sheets/xxx/floatImages/xxx?operatorId=xxx HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:xxx
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.DeleteFloatImageHeaders deleteFloatImageHeaders = new com.aliyun.dingtalkdoc_1_0.models.DeleteFloatImageHeaders();
        deleteFloatImageHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkdoc_1_0.models.DeleteFloatImageRequest deleteFloatImageRequest = new com.aliyun.dingtalkdoc_1_0.models.DeleteFloatImageRequest()
                .setOperatorId("xxx");
        try {
            client.deleteFloatImageWithOptions("xxx", "xxx", "xxx", deleteFloatImageRequest, deleteFloatImageHeaders, 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()
        delete_float_image_headers = dingtalkdoc__1__0_models.DeleteFloatImageHeaders()
        delete_float_image_headers.x_acs_dingtalk_access_token = '<your access token>'
        delete_float_image_request = dingtalkdoc__1__0_models.DeleteFloatImageRequest(
            operator_id='xxx'
        )
        try:
            client.delete_float_image_with_options('xxx', 'xxx', 'xxx', delete_float_image_request, delete_float_image_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()
        delete_float_image_headers = dingtalkdoc__1__0_models.DeleteFloatImageHeaders()
        delete_float_image_headers.x_acs_dingtalk_access_token = '<your access token>'
        delete_float_image_request = dingtalkdoc__1__0_models.DeleteFloatImageRequest(
            operator_id='xxx'
        )
        try:
            await client.delete_float_image_with_options_async('xxx', 'xxx', 'xxx', delete_float_image_request, delete_float_image_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\DeleteFloatImageHeaders;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\DeleteFloatImageRequest;
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();
        $deleteFloatImageHeaders = new DeleteFloatImageHeaders([]);
        $deleteFloatImageHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $deleteFloatImageRequest = new DeleteFloatImageRequest([
            "operatorId" => "xxx"
        ]);
        try {
            $client->deleteFloatImageWithOptions("xxx", "xxx", "xxx", $deleteFloatImageRequest, $deleteFloatImageHeaders, 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
  }

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

    }
}

レスポンス

レスポンスボディ

名前	タイプ	説明
success	Boolean	操作成功ステータス。

レスポンスボディ例

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

{
  "success" : true
}

エラーコード

当該インターフェース呼び出し時にエラーが発生した場合は、エラーメッセージをもとにグローバルエラーコードドキュメントで解決策を検索してください。

HttpCode	エラーコード	エラーメッセージ	説明
400	invalidRequest.inputArgs.invalid	%s	リクエストパラメータが不正です。エラーメッセージを確認してください。
400	invalidRequest.inputArgs.workbookIdIllegal	The workbookId is illegal.	workbookId が不正です。
400	invalidRequest.resource.notWorkbook	%s	サポートされていないドキュメントタイプです。workbookId を確認してください。
403	forbidden.accessDenied	The operator has no permission.	現在のユーザーには本操作の権限がありません。
403	forbidden.acrossOrg	%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	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

フローティング画像の削除

リクエスト

基本情報

リクエストヘッダー

パスパラメータ

クエリパラメータ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード

​リクエスト

​基本情報

​リクエストヘッダー

​パスパラメータ

​クエリパラメータ

​リクエスト例

​レスポンス

​レスポンスボディ

​レスポンスボディ例

​エラーコード

リクエスト

基本情報

リクエストヘッダー

パスパラメータ

クエリパラメータ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード