Class VideoItem

VideoItem

A layout item that displays a video. Items can be accessed or created from a Form.

 // Open a form by ID and add three new video items, using a long URL,
 // a short URL, and a video ID.
 var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
 form.addVideoItem()
     .setTitle('Video Title')
     .setHelpText('Video Caption')
     .setVideoUrl('www.youtube.com/watch?v=1234abcdxyz');

 form.addVideoItem()
     .setTitle('Video Title')
     .setHelpText('Video Caption')
     .setVideoUrl('youtu.be/1234abcdxyz');

 form.addVideoItem()
     .setTitle('Video Title')
     .setHelpText('Video Caption')
     .setVideoUrl('1234abcdxyz');
 

Methods

MethodReturn typeBrief description
duplicate()VideoItemCreates a copy of this item and appends it to the end of the form.
getAlignment()AlignmentGets the video's horizontal alignment.
getHelpText()StringGets the item's help text (sometimes called description text for layout items like ImageItems, PageBreakItems, and SectionHeaderItems).
getId()IntegerGets the item's unique identifier.
getIndex()IntegerGets the index of the item among all the items in the form.
getTitle()StringGets the item's title (sometimes called header text, in the case of a SectionHeaderItem).
getType()ItemTypeGets the item's type, represented as an ItemType.
getWidth()IntegerGets the video's width in pixels.
setAlignment(alignment)VideoItemSets the video's horizontal alignment.
setHelpText(text)VideoItemSets the item's help text (sometimes called description text for layout items like ImageItems, PageBreakItems, and SectionHeaderItems).
setTitle(title)VideoItemSets the item's title (sometimes called header text, in the case of a SectionHeaderItem).
setVideoUrl(youtubeUrl)VideoItemSets the video itself from a given YouTube URL or YouTube video ID.
setWidth(width)VideoItemSets the video's width in pixels.

Detailed documentation

duplicate()

Creates a copy of this item and appends it to the end of the form.

Return

VideoItem — a duplicate of this VideoItem, for chaining


getAlignment()

Gets the video's horizontal alignment.

Return

Alignment — the horizontal alignment


getHelpText()

Gets the item's help text (sometimes called description text for layout items like ImageItems, PageBreakItems, and SectionHeaderItems).

Return

String — the item's help text or description text


getId()

Gets the item's unique identifier.

Return

Integer — the item's ID


getIndex()

Gets the index of the item among all the items in the form.

Return

Integer — the index of the item


getTitle()

Gets the item's title (sometimes called header text, in the case of a SectionHeaderItem).

Return

String — the item's title or header text


getType()

Gets the item's type, represented as an ItemType.

Return

ItemType — the item's type


getWidth()

Gets the video's width in pixels.

Return

Integer — the width in pixels


setAlignment(alignment)

Sets the video's horizontal alignment.

Parameters

NameTypeDescription
alignmentAlignmentthe horizontal alignment

Return

VideoItem — this VideoItem, for chaining


setHelpText(text)

Sets the item's help text (sometimes called description text for layout items like ImageItems, PageBreakItems, and SectionHeaderItems).

Parameters

NameTypeDescription
textStringthe new help text

Return

VideoItem — this VideoItem, for chaining


setTitle(title)

Sets the item's title (sometimes called header text, in the case of a SectionHeaderItem).

Parameters

NameTypeDescription
titleStringthe new title or header text

Return

VideoItem — this VideoItem, for chaining


setVideoUrl(youtubeUrl)

Sets the video itself from a given YouTube URL or YouTube video ID.

Parameters

NameTypeDescription
youtubeUrlStringthe YouTube URL or ID

Return

VideoItem — this VideoItem, for chaining


setWidth(width)

Sets the video's width in pixels. Only the video's width can be set. Height is set automatically to maintain the video's proportions.

Parameters

NameTypeDescription
widthIntegerthe width in pixels

Return

VideoItem — this VideoItem, for chaining

发送以下问题的反馈:

此网页
Apps Script
Apps Script