ReplaceImageRequest

import type { ReplaceImageRequest } from "https://googleapis.deno.dev/v1/docs:v1.ts";

Replaces an existing image with a new image. Replacing an image removes some image effects from the existing image in order to mirror the behavior of the Docs editor.

interface ReplaceImageRequest {

imageObjectId?: string;

imageReplaceMethod?: "IMAGE_REPLACE_METHOD_UNSPECIFIED" | "CENTER_CROP";

tabId?: string;

uri?: string;

}

§Properties

imageObjectId?: string

[src]

The ID of the existing image that will be replaced. The ID can be retrieved from the response of a get request.

imageReplaceMethod?: "IMAGE_REPLACE_METHOD_UNSPECIFIED" | "CENTER_CROP"

[src]

The replacement method.

tabId?: string

[src]

The tab that the image to be replaced is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.

uri?: string

[src]

The URI of the new image. The image is fetched once at insertion time and a copy is stored for display inside the document. Images must be less than 50MB, cannot exceed 25 megapixels, and must be in PNG, JPEG, or GIF format. The provided URI can't surpass 2 KB in length. The URI is saved with the image, and exposed through the ImageProperties.source_uri field.