Membuat gambar mengambang

Panggil API ini untuk mengambil daftar semua gambar mengambang pada Lembar Kerja tertentu di DingTalk Spreadsheet. API ini berlaku untuk skenario yang memerlukan pembacaan gambar mengambang secara massal dalam sebuah Lembar Kerja, seperti ekspor, sinkronisasi, atau audit. Isi respons berisi pengenal unik, URL gambar, posisi anchor, dan offset ukuran setiap gambar.

Permintaan

Informasi dasar

Bidang	Value
URL HTTP	`https://api.dingtalk.io/v1.0/doc/workbooks/{workbookId}/sheets/{sheetId}/floatImages`
Metode HTTP	POST
Jenis aplikasi yang didukung	appType-Aplikasi internal
Izin yang diperlukan	permission-Document.Workbook.Write-Izin tulis DingTalk Spreadsheet

Header permintaan

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

Parameter path

Nama	Tipe	Wajib	Deskripsi
workbookId	String	Ya	ID file spreadsheet. `nodeId(dentryUuid)` yang dikembalikan oleh API Knowledge Base adalah `workbookId` dari spreadsheet. Peroleh dengan memanggil API Mendapatkan node dan 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.

Parameter query

Nama	Tipe	Wajib	Deskripsi
operatorId	String	Ya	unionId dari operator. Panggil API Mengueri 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	Ya	URL sumber daya dari gambar mengambang. Peroleh `resourceUrl` dengan memanggil API Mendapatkan informasi unggah sumber daya.
anchor	Object	Ya	Informasi pemosisian dari gambar mengambang.
row	Integer	Ya	Indeks baris untuk pemosisian. Cursor dimulai dari 0.
col	Integer	Ya	Indeks kolom untuk pemosisian. Cursor dimulai dari 0.
coordinate	Object	Ya	Informasi geometri.
width	double	Ya	Lebar gambar, dalam piksel.
height	double	Ya	Tinggi gambar, dalam piksel.
offsetX	double	Ya	Offset horizontal relatif terhadap koordinat pemosisian, dalam piksel.
offsetY	double	Ya	Offset vertikal relatif terhadap koordinat pemosisian, dalam piksel.

Contoh permintaan

HTTP

POST /v1.0/doc/workbooks/e54Lqxxxxx/sheets/Sheet1/floatImages?operatorId=ppgAQuxxxxx HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:f86e0bxxx
Content-Type:application/json

{
  "src" : "/core/api/resources/img/xxx",
  "anchor" : {
    "row" : 1,
    "col" : 1
  },
  "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.CreateFloatImageHeaders createFloatImageHeaders = new com.aliyun.dingtalkdoc_1_0.models.CreateFloatImageHeaders();
        createFloatImageHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkdoc_1_0.models.CreateFloatImageRequest.CreateFloatImageRequestCoordinate coordinate = new com.aliyun.dingtalkdoc_1_0.models.CreateFloatImageRequest.CreateFloatImageRequestCoordinate()
                .setWidth(300D)
                .setHeight(300D)
                .setOffsetX(8D)
                .setOffsetY(8D);
        com.aliyun.dingtalkdoc_1_0.models.CreateFloatImageRequest.CreateFloatImageRequestAnchor anchor = new com.aliyun.dingtalkdoc_1_0.models.CreateFloatImageRequest.CreateFloatImageRequestAnchor()
                .setRow(1)
                .setCol(1);
        com.aliyun.dingtalkdoc_1_0.models.CreateFloatImageRequest createFloatImageRequest = new com.aliyun.dingtalkdoc_1_0.models.CreateFloatImageRequest()
                .setOperatorId("ppgAQuxxxxx")
                .setSrc("/core/api/resources/img/xxx")
                .setAnchor(anchor)
                .setCoordinate(coordinate);
        try {
            client.createFloatImageWithOptions("e54Lqxxxxx", "Sheet1", createFloatImageRequest, createFloatImageHeaders, 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 mendiagnosis 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 mendiagnosis 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()
        create_float_image_headers = dingtalkdoc__1__0_models.CreateFloatImageHeaders()
        create_float_image_headers.x_acs_dingtalk_access_token = '<your access token>'
        coordinate = dingtalkdoc__1__0_models.CreateFloatImageRequestCoordinate(
            width=300,
            height=300,
            offset_x=8,
            offset_y=8
        )
        anchor = dingtalkdoc__1__0_models.CreateFloatImageRequestAnchor(
            row=1,
            col=1
        )
        create_float_image_request = dingtalkdoc__1__0_models.CreateFloatImageRequest(
            operator_id='ppgAQuxxxxx',
            src='/core/api/resources/img/xxx',
            anchor=anchor,
            coordinate=coordinate
        )
        try:
            client.create_float_image_with_options('e54Lqxxxxx', 'Sheet1', create_float_image_request, create_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 mendiagnosis masalah.
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        create_float_image_headers = dingtalkdoc__1__0_models.CreateFloatImageHeaders()
        create_float_image_headers.x_acs_dingtalk_access_token = '<your access token>'
        coordinate = dingtalkdoc__1__0_models.CreateFloatImageRequestCoordinate(
            width=300,
            height=300,
            offset_x=8,
            offset_y=8
        )
        anchor = dingtalkdoc__1__0_models.CreateFloatImageRequestAnchor(
            row=1,
            col=1
        )
        create_float_image_request = dingtalkdoc__1__0_models.CreateFloatImageRequest(
            operator_id='ppgAQuxxxxx',
            src='/core/api/resources/img/xxx',
            anchor=anchor,
            coordinate=coordinate
        )
        try:
            await client.create_float_image_with_options_async('e54Lqxxxxx', 'Sheet1', create_float_image_request, create_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 mendiagnosis 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\CreateFloatImageHeaders;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\CreateFloatImageRequest\coordinate;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\CreateFloatImageRequest\anchor;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\CreateFloatImageRequest;
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();
        $createFloatImageHeaders = new CreateFloatImageHeaders([]);
        $createFloatImageHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $coordinate = new coordinate([
            "width" => 300,
            "height" => 300,
            "offsetX" => 8,
            "offsetY" => 8
        ]);
        $anchor = new anchor([
            "row" => 1,
            "col" => 1
        ]);
        $createFloatImageRequest = new CreateFloatImageRequest([
            "operatorId" => "ppgAQuxxxxx",
            "src" => "/core/api/resources/img/xxx",
            "anchor" => $anchor,
            "coordinate" => $coordinate
        ]);
        try {
            $client->createFloatImageWithOptions("e54Lqxxxxx", "Sheet1", $createFloatImageRequest, $createFloatImageHeaders, 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 mendiagnosis 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
  }

  createFloatImageHeaders := &dingtalkdoc_1_0.CreateFloatImageHeaders{}
  createFloatImageHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  coordinate := &dingtalkdoc_1_0.CreateFloatImageRequestCoordinate{
    Width: tea.Float64(300),
    Height: tea.Float64(300),
    OffsetX: tea.Float64(8),
    OffsetY: tea.Float64(8),
  }
  anchor := &dingtalkdoc_1_0.CreateFloatImageRequestAnchor{
    Row: tea.Int32(1),
    Col: tea.Int32(1),
  }
  createFloatImageRequest := &dingtalkdoc_1_0.CreateFloatImageRequest{
    OperatorId: tea.String("ppgAQuxxxxx"),
    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.CreateFloatImageWithOptions(tea.String("e54Lqxxxxx"), tea.String("Sheet1"), createFloatImageRequest, createFloatImageHeaders, &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 mendiagnosis 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 createFloatImageHeaders = new dingtalkdoc_1_0.CreateFloatImageHeaders({ });
    createFloatImageHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let coordinate = new dingtalkdoc_1_0.CreateFloatImageRequestCoordinate({
      width: 300,
      height: 300,
      offsetX: 8,
      offsetY: 8,
    });
    let anchor = new dingtalkdoc_1_0.CreateFloatImageRequestAnchor({
      row: 1,
      col: 1,
    });
    let createFloatImageRequest = new dingtalkdoc_1_0.CreateFloatImageRequest({
      operatorId: 'ppgAQuxxxxx',
      src: '/core/api/resources/img/xxx',
      anchor: anchor,
      coordinate: coordinate,
    });
    try {
      await client.createFloatImageWithOptions('e54Lqxxxxx', 'Sheet1', createFloatImageRequest, createFloatImageHeaders, 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 mendiagnosis 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.CreateFloatImageHeaders createFloatImageHeaders = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CreateFloatImageHeaders();
            createFloatImageHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CreateFloatImageRequest.CreateFloatImageRequestCoordinate coordinate = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CreateFloatImageRequest.CreateFloatImageRequestCoordinate
            {
                Width = 300,
                Height = 300,
                OffsetX = 8,
                OffsetY = 8,
            };
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CreateFloatImageRequest.CreateFloatImageRequestAnchor anchor = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CreateFloatImageRequest.CreateFloatImageRequestAnchor
            {
                Row = 1,
                Col = 1,
            };
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CreateFloatImageRequest createFloatImageRequest = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CreateFloatImageRequest
            {
                OperatorId = "ppgAQuxxxxx",
                Src = "/core/api/resources/img/xxx",
                Anchor = anchor,
                Coordinate = coordinate,
            };
            try
            {
                client.CreateFloatImageWithOptions("e54Lqxxxxx", "Sheet1", createFloatImageRequest, createFloatImageHeaders, 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 mendiagnosis 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 mendiagnosis masalah.
                }
            }
        }

    }
}

Respons

Isi respons

Nama	Tipe	Deskripsi
result	Object	Informasi gambar mengambang.
id	String	ID dari gambar mengambang.
src	String	URL sumber daya dari gambar mengambang.
anchor	Object	Posisi anchor yang menentukan sel tempat gambar ditambatkan.
row	Integer	Indeks baris untuk pemosisian. Cursor dimulai dari 0.
col	Integer	Indeks kolom untuk pemosisian. Cursor dimulai dari 0.
coordinate	Object	Ukuran gambar dan offset relatif terhadap sel anchor.
width	double	Lebar dari gambar mengambang.
height	double	Tinggi dari gambar mengambang.
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/resources/img/xxx",
    "anchor" : {
      "row" : 1,
      "col" : 1
    },
    "coordinate" : {
      "width" : 300,
      "height" : 300,
      "offsetX" : 1,
      "offsetY" : 1
    }
  },
  "success" : true
}

Kode error

Jika terjadi error saat memanggil API ini, temukan 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 permintaan 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 kontennya.
404	invalidRequest.resource.notFound	%s	Permintaan gagal. Sumber daya yang akan diakses tidak dapat ditemukan.
500	internalError	The server encountered an internal error and was unable to complete your request. Please try again later.	Terjadi error internal server. 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