Memperbarui gambar mengambang

Panggil API ini untuk memperbarui atribut gambar mengambang yang sudah ada di DingTalk Spreadsheet, termasuk sumber gambar, posisi anchor, dan offset ukuran. Pembaruan sebagian didukung—bidang yang tidak disediakan akan mempertahankan nilai aslinya. Misalnya, kirim hanya anchor untuk menyesuaikan posisi gambar tanpa memengaruhi atribut lain. API ini cocok untuk menyesuaikan posisi gambar, mengganti sumber gambar, atau memodifikasi ukuran tampilan. Setelah panggilan berhasil, atribut lengkap dari gambar yang diperbarui akan dikembalikan.

Permintaan

Informasi dasar

Bidang	Nilai
URL HTTP	`https://api.dingtalk.io/v1.0/doc/workbooks/{workbookId}/sheets/{sheetId}/floatImages/{id}`
Metode HTTP	PUT
Jenis aplikasi yang didukung	appType-Internal app
Izin yang diperlukan	permission-Document.Workbook.Write-DingTalk Spreadsheet write permission

Header permintaan

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

Parameter path

Nama	Tipe	Wajib	Deskripsi
workbookId	String	Ya	ID file Spreadsheet. `nodeId(dentryUuid)` yang dikembalikan oleh Knowledge Base API adalah `workbookId` Spreadsheet. Peroleh dengan memanggil API Mendapatkan node atau 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.
id	String	Ya	ID gambar mengambang yang ditentukan. Peroleh melalui API “Query floating images”.

Parameter query

Nama	Tipe	Wajib	Deskripsi
operatorId	String	Ya	unionId dari operator. Panggil API Menanyakan detail pengguna untuk memperolehnya. Jika operator tidak memiliki izin, API mengembalikan error `The operator has no permission`.

Isi permintaan

Nama	Tipe	Wajib	Deskripsi
src	String	Tidak	Alamat sumber daya dari gambar mengambang. Panggil API Mendapatkan informasi unggah sumber daya untuk memperoleh `resourceUrl`.
anchor	Object	Tidak	Posisi anchor yang menentukan Sel tempat gambar diberi anchor.
row	Integer	Tidak	Nomor baris dari anchor (dimulai dari 0).
col	Integer	Tidak	Nomor kolom dari anchor (dimulai dari 0).
coordinate	Object	Tidak	Ukuran gambar dan offset relatif terhadap Sel anchor.
width	double	Tidak	Lebar gambar, dalam piksel.
height	double	Tidak	Tinggi gambar, dalam piksel.
offsetX	double	Tidak	Offset horizontal relatif terhadap sudut kiri atas Sel anchor, dalam piksel.
offsetY	double	Tidak	Offset vertikal relatif terhadap sudut kiri atas Sel anchor, dalam piksel.

Contoh permintaan

HTTP

PUT /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

{
  "src" : "/core/api/resources/img/xxx",
  "anchor" : {
    "row" : 0,
    "col" : 0
  },
  "coordinate" : {
    "width" : 300.0,
    "height" : 300.0,
    "offsetX" : 8.0,
    "offsetY" : 8.0
  }
}

Java

package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * <b>description</b> :
     * <p>Initialize the account Client with a Token</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.UpdateFloatImageHeaders updateFloatImageHeaders = new com.aliyun.dingtalkdoc_1_0.models.UpdateFloatImageHeaders();
        updateFloatImageHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkdoc_1_0.models.UpdateFloatImageRequest.UpdateFloatImageRequestCoordinate coordinate = new com.aliyun.dingtalkdoc_1_0.models.UpdateFloatImageRequest.UpdateFloatImageRequestCoordinate()
                .setWidth(300D)
                .setHeight(300D)
                .setOffsetX(8D)
                .setOffsetY(8D);
        com.aliyun.dingtalkdoc_1_0.models.UpdateFloatImageRequest.UpdateFloatImageRequestAnchor anchor = new com.aliyun.dingtalkdoc_1_0.models.UpdateFloatImageRequest.UpdateFloatImageRequestAnchor()
                .setRow(0)
                .setCol(0);
        com.aliyun.dingtalkdoc_1_0.models.UpdateFloatImageRequest updateFloatImageRequest = new com.aliyun.dingtalkdoc_1_0.models.UpdateFloatImageRequest()
                .setOperatorId("xxx")
                .setSrc("/core/api/resources/img/xxx")
                .setAnchor(anchor)
                .setCoordinate(coordinate);
        try {
            client.updateFloatImageWithOptions("xxx", "xxx", "xxx", updateFloatImageRequest, updateFloatImageHeaders, new com.aliyun.teautil.models.RuntimeOptions());
        } catch (TeaException err) {
            if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
                // Objek err berisi atribut code dan message, yang membantu 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)) {
                // Objek err berisi atribut code dan message, yang membantu menemukan masalah
            }

        }        
    }
}

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:
        """
        Initialize the account Client with 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()
        update_float_image_headers = dingtalkdoc__1__0_models.UpdateFloatImageHeaders()
        update_float_image_headers.x_acs_dingtalk_access_token = '<your access token>'
        coordinate = dingtalkdoc__1__0_models.UpdateFloatImageRequestCoordinate(
            width=300,
            height=300,
            offset_x=8,
            offset_y=8
        )
        anchor = dingtalkdoc__1__0_models.UpdateFloatImageRequestAnchor(
            row=0,
            col=0
        )
        update_float_image_request = dingtalkdoc__1__0_models.UpdateFloatImageRequest(
            operator_id='xxx',
            src='/core/api/resources/img/xxx',
            anchor=anchor,
            coordinate=coordinate
        )
        try:
            client.update_float_image_with_options('xxx', 'xxx', 'xxx', update_float_image_request, update_float_image_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # Objek err berisi atribut code dan message, yang membantu menemukan masalah
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        update_float_image_headers = dingtalkdoc__1__0_models.UpdateFloatImageHeaders()
        update_float_image_headers.x_acs_dingtalk_access_token = '<your access token>'
        coordinate = dingtalkdoc__1__0_models.UpdateFloatImageRequestCoordinate(
            width=300,
            height=300,
            offset_x=8,
            offset_y=8
        )
        anchor = dingtalkdoc__1__0_models.UpdateFloatImageRequestAnchor(
            row=0,
            col=0
        )
        update_float_image_request = dingtalkdoc__1__0_models.UpdateFloatImageRequest(
            operator_id='xxx',
            src='/core/api/resources/img/xxx',
            anchor=anchor,
            coordinate=coordinate
        )
        try:
            await client.update_float_image_with_options_async('xxx', 'xxx', 'xxx', update_float_image_request, update_float_image_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # Objek err berisi atribut code dan message, yang membantu 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\UpdateFloatImageHeaders;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\UpdateFloatImageRequest\coordinate;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\UpdateFloatImageRequest\anchor;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\UpdateFloatImageRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * Initialize the account Client with 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();
        $updateFloatImageHeaders = new UpdateFloatImageHeaders([]);
        $updateFloatImageHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $coordinate = new coordinate([
            "width" => 300,
            "height" => 300,
            "offsetX" => 8,
            "offsetY" => 8
        ]);
        $anchor = new anchor([
            "row" => 0,
            "col" => 0
        ]);
        $updateFloatImageRequest = new UpdateFloatImageRequest([
            "operatorId" => "xxx",
            "src" => "/core/api/resources/img/xxx",
            "anchor" => $anchor,
            "coordinate" => $coordinate
        ]);
        try {
            $client->updateFloatImageWithOptions("xxx", "xxx", "xxx", $updateFloatImageRequest, $updateFloatImageHeaders, 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)) {
                // Objek err berisi atribut code dan message, yang membantu 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));

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:
// 
// Initialize the account Client with 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
  }

  updateFloatImageHeaders := &dingtalkdoc_1_0.UpdateFloatImageHeaders{}
  updateFloatImageHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  coordinate := &dingtalkdoc_1_0.UpdateFloatImageRequestCoordinate{
    Width: tea.Float64(300),
    Height: tea.Float64(300),
    OffsetX: tea.Float64(8),
    OffsetY: tea.Float64(8),
  }
  anchor := &dingtalkdoc_1_0.UpdateFloatImageRequestAnchor{
    Row: tea.Int32(0),
    Col: tea.Int32(0),
  }
  updateFloatImageRequest := &dingtalkdoc_1_0.UpdateFloatImageRequest{
    OperatorId: tea.String("xxx"),
    Src: tea.String("/core/api/resources/img/xxx"),
    Anchor: anchor,
    Coordinate: coordinate,
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.UpdateFloatImageWithOptions(tea.String("xxx"), tea.String("xxx"), tea.String("xxx"), updateFloatImageRequest, updateFloatImageHeaders, &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)) {
      // Objek err berisi atribut code dan message, yang membantu menemukan masalah
    }

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

  /**
   * Initialize the account Client with a Token
   * @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 updateFloatImageHeaders = new dingtalkdoc_1_0.UpdateFloatImageHeaders({ });
    updateFloatImageHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let coordinate = new dingtalkdoc_1_0.UpdateFloatImageRequestCoordinate({
      width: 300,
      height: 300,
      offsetX: 8,
      offsetY: 8,
    });
    let anchor = new dingtalkdoc_1_0.UpdateFloatImageRequestAnchor({
      row: 0,
      col: 0,
    });
    let updateFloatImageRequest = new dingtalkdoc_1_0.UpdateFloatImageRequest({
      operatorId: 'xxx',
      src: '/core/api/resources/img/xxx',
      anchor: anchor,
      coordinate: coordinate,
    });
    try {
      await client.updateFloatImageWithOptions('xxx', 'xxx', 'xxx', updateFloatImageRequest, updateFloatImageHeaders, new Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
        // Objek err berisi atribut code dan message, yang membantu menemukan masalah
      }

    }    
  }

}

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>Initialize the account Client with a Token</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.UpdateFloatImageHeaders updateFloatImageHeaders = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.UpdateFloatImageHeaders();
            updateFloatImageHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.UpdateFloatImageRequest.UpdateFloatImageRequestCoordinate coordinate = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.UpdateFloatImageRequest.UpdateFloatImageRequestCoordinate
            {
                Width = 300,
                Height = 300,
                OffsetX = 8,
                OffsetY = 8,
            };
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.UpdateFloatImageRequest.UpdateFloatImageRequestAnchor anchor = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.UpdateFloatImageRequest.UpdateFloatImageRequestAnchor
            {
                Row = 0,
                Col = 0,
            };
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.UpdateFloatImageRequest updateFloatImageRequest = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.UpdateFloatImageRequest
            {
                OperatorId = "xxx",
                Src = "/core/api/resources/img/xxx",
                Anchor = anchor,
                Coordinate = coordinate,
            };
            try
            {
                client.UpdateFloatImageWithOptions("xxx", "xxx", "xxx", updateFloatImageRequest, updateFloatImageHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
            }
            catch (TeaException err)
            {
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // Objek err berisi atribut code dan message, yang membantu 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))
                {
                    // Objek err berisi atribut code dan message, yang membantu menemukan masalah
                }
            }
        }

    }
}

Respons

Isi respons

Nama	Tipe	Deskripsi
result	Object	Hasil setelah pembaruan.
id	String	Identifier unik dari gambar mengambang.
src	String	Alamat sumber daya dari gambar.
anchor	Object	Posisi anchor yang menentukan Sel tempat gambar diberi anchor.
row	Integer	Nomor baris dari anchor (dimulai dari 0).
col	Integer	Nomor kolom dari anchor (dimulai dari 0).
coordinate	Object	Ukuran gambar dan offset relatif terhadap Sel anchor.
width	double	Lebar gambar, dalam piksel.
height	double	Tinggi gambar, dalam piksel.
offsetX	double	Offset horizontal relatif terhadap sudut kiri atas Sel anchor, dalam piksel.
offsetY	double	Offset vertikal relatif terhadap sudut kiri atas Sel anchor, dalam piksel.
success	Boolean	Status keberhasilan.

Contoh isi respons

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

{
  "result" : {
    "id" : "xxx",
    "src" : "/core/api/xxx",
    "anchor" : {
      "row" : 0,
      "col" : 0
    },
    "coordinate" : {
      "width" : 300,
      "height" : 300,
      "offsetX" : 8,
      "offsetY" : 8
    }
  },
  "success" : true
}

Kode error

Jika terjadi error saat memanggil API ini, cari solusinya di dokumen Kode error global berdasarkan pesan error.

HttpCode	Kode error	Pesan error	Deskripsi
400	invalidRequest.inputArgs.invalid	%s	Parameter permintaan tidak valid. Periksa pesan error.
400	invalidRequest.inputArgs.workbookIdIllegal	The workbookId is illegal.	workbookId tidak valid.
400	invalidRequest.resource.notWorkbook	%s	Tipe dokumen tidak didukung. Periksa workbookId.
403	forbidden.accessDenied	The operator has no permission.	Pengguna saat ini tidak memiliki izin untuk Tindakan ini.
403	forbidden.acrossOrg	%s	Tindakan yang diminta tidak valid. Periksa pesan error.
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. Coba kurangi konten Spreadsheet.
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 layanan internal. Coba Lagi Nanti.
500	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

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