MediaFile

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

  • Key information about a media file includes its type, mime type, ID, source URL, name, and file size.

  • Media files can be of various specific types, including images, media bundles (HTML5 assets in a ZIP), audio, or video.

  • Some fields like mime_type, id, file_size, and the audio specific type are output-only, meaning they are provided by the system and cannot be set.

  • Some fields like resource_name, type, source_url, name, and specific types image, media_bundle, and video are immutable, meaning they cannot be changed after creation.

A media file.

Fields

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}

type

MediaType

Immutable. Type of the media file.

mime_type

MimeType

Output only. The mime type of the media file.

id

int64

Output only. The ID of the media file.

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.

name

string

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

file_size

int64

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

mediatype

mediatype. The specific type of the media file. mediatype can be only one of the following:

image

MediaImage

Immutable. Encapsulates an Image.

media_bundle

MediaBundle

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

audio

MediaAudio

Output only. Encapsulates an Audio.

video

MediaVideo

Immutable. Encapsulates a Video.