Lark Sheets icon

Lark Sheets

Lark Sheets Management

Actions23

Overview

The "Create A Floating Image" operation in the "Sheet Floating Image" resource allows users to add a floating image onto a specific sheet within a Lark spreadsheet. This node is useful for automating the insertion of images that float over cells, such as logos, annotations, or visual markers, without embedding them directly into cell content.

Practical scenarios include:

  • Automatically adding company logos or watermarks to generated reports.
  • Inserting dynamic images based on data changes or external triggers.
  • Enhancing spreadsheets with visual elements for presentations or dashboards.

Properties

Name Meaning
Authentication Method of authentication: either using a Tenant Token or OAuth2 token.
Spreadsheet Token The unique token identifying the target spreadsheet where the floating image will be added.
Sheet Id Identifier of the specific sheet within the spreadsheet to place the floating image.
Float Image Id ID of the floating image to insert.
Float Image Token Token associated with the floating image (likely for access or validation).
Height Height dimension of the floating image in pixels.
Offset X Horizontal offset position of the floating image relative to the specified range.
Offset Y Vertical offset position of the floating image relative to the specified range.
Range Cell range reference indicating where the floating image should be anchored.
Width Width dimension of the floating image in pixels.
Custom Body JSON object allowing full customization of the request body sent to the API.
Options > Use Custom Body Boolean flag to determine whether to send a custom JSON body instead of individual fields.

Output

The node outputs JSON data representing the response from the Lark Sheets API after creating the floating image. This typically includes confirmation details about the inserted floating image, such as its ID, position, and dimensions.

No binary data output is involved in this operation.

Dependencies

  • Requires an active connection to the Lark Suite API.
  • Needs either a Tenant Token credential or OAuth2 authentication configured in n8n.
  • The node sends requests to https://open.larksuite.com/open-apis endpoint.
  • Proper permissions on the spreadsheet and sheet are necessary to create floating images.

Troubleshooting

  • Authentication errors: Ensure that the provided Tenant Token or OAuth2 credentials are valid and have sufficient permissions.
  • Invalid Spreadsheet Token or Sheet Id: Double-check these identifiers; incorrect values will cause the API to reject the request.
  • Missing required properties: Spreadsheet Token and Sheet Id are mandatory; omitting them will result in errors.
  • Incorrect image IDs or tokens: Providing invalid floating image IDs or tokens may cause failures in image creation.
  • Custom Body usage: When using the custom body option, ensure the JSON structure matches the API expectations exactly to avoid malformed request errors.

Links and References

Discussion