MediaFile

  • A media file resource is identified by a resource name in the format customers/{customer_id}/mediaFiles/{media_file_id}.

  • Each media file has a type (e.g., AUDIO, IMAGE) and a specific mime type.

  • Media files can be images, media bundles (HTML5 assets), audio, or video, each with its own specific properties.

  • Key output-only fields include the media file's ID, mime type, file size, and audio data.

A media file.

Proto definition

Fields

file_size

int64

Output only. The size of the media file in bytes.

id

int64

Output only. The ID of the media file.

mediatype

Union field. The specific type of the media file.

mediatype can be only one of the following:

audio

MediaAudio

Output only. Encapsulates an Audio.

image

MediaImage

Immutable. Encapsulates an Image.

media_bundle

MediaBundle

Immutable. A ZIP archive media the content of which contains HTML5 assets.

video

MediaVideo

Immutable. Encapsulates a Video.

mime_type

MimeType

Output only. The mime type of the media file.

name

string

Immutable. The name of the media file. The name can be used by clients to help identify previously uploaded media.

resource_name

string

Immutable. The resource name of the media file. Media file resource names have the form:

customers/{customer_id}/mediaFiles/{media_file_id}

source_url

string

Immutable. The URL of where the original media file was downloaded from (or a file name). Only used for media of type AUDIO and IMAGE.

type

MediaType

Immutable. Type of the media file.