Class VideoItem

VideoItem

動画を表示するレイアウト アイテム。アイテムは 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

メソッド戻り値の型概要
duplicate()VideoItemこのアイテムのコピーを作成して、フォームの末尾に追加します。
getAlignment()Alignment動画の水平方向の配置を取得します。
getHelpText()Stringアイテムのヘルプテキスト(ImageItemsPageBreakItemsSectionHeaderItems などのレイアウト アイテムの説明テキスト)を取得します。
getId()Integerアイテムの一意の識別子を取得します。
getIndex()Integerフォーム内のすべてのアイテムの中でアイテムのインデックスを取得します。
getTitle()Stringアイテムのタイトル(SectionHeaderItem の場合にヘッダー テキストとも呼ばれます)を取得します。
getType()ItemTypeItemType で表されるアイテムのタイプを取得します。
getWidth()Integer動画の幅をピクセル単位で取得します。
setAlignment(alignment)VideoItem動画の水平方向の配置を設定します。
setHelpText(text)VideoItemアイテムのヘルプテキスト(ImageItemsPageBreakItemsSectionHeaderItems などのレイアウト アイテムの説明テキスト)を設定します。
setTitle(title)VideoItemアイテムのタイトル(SectionHeaderItem ではヘッダー テキストとも呼ばれます)を設定します。
setVideoUrl(youtubeUrl)VideoItem指定した YouTube URL または YouTube 動画 ID から動画自体を設定します。
setWidth(width)VideoItem動画の幅をピクセル単位で設定します。

詳細なドキュメント

duplicate()

このアイテムのコピーを作成して、フォームの末尾に追加します。

リターン

VideoItem - この VideoItem の重複(チェーン用)

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getAlignment()

動画の水平方向の配置を取得します。

リターン

Alignment - 水平方向の配置

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getHelpText()

アイテムのヘルプテキスト(ImageItemsPageBreakItemsSectionHeaderItems などのレイアウト アイテムの説明テキスト)を取得します。

リターン

String - アイテムのヘルプテキストまたは説明テキスト

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getId()

アイテムの一意の識別子を取得します。

リターン

Integer - 商品アイテムの ID

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getIndex()

フォーム内のすべてのアイテムの中でアイテムのインデックスを取得します。

リターン

Integer - アイテムのインデックス

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getTitle()

アイテムのタイトル(SectionHeaderItem の場合にヘッダー テキストとも呼ばれます)を取得します。

リターン

String - アイテムのタイトルまたはヘッダー テキスト

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getType()

ItemType で表されるアイテムのタイプを取得します。

リターン

ItemType - アイテムのタイプ

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getWidth()

動画の幅をピクセル単位で取得します。

リターン

Integer - 幅(ピクセル単位)

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

setAlignment(alignment)

動画の水平方向の配置を設定します。

パラメータ

名前説明
alignmentAlignment水平方向の配置

リターン

VideoItem - この VideoItem(チェーン用)

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

setHelpText(text)

アイテムのヘルプテキスト(ImageItemsPageBreakItemsSectionHeaderItems などのレイアウト アイテムの説明テキスト)を設定します。

パラメータ

名前説明
textString新しいヘルプテキスト

リターン

VideoItem - この VideoItem(チェーン用)

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

setTitle(title)

アイテムのタイトル(SectionHeaderItem ではヘッダー テキストとも呼ばれます)を設定します。

パラメータ

名前説明
titleString新しいタイトルまたはヘッダー テキスト

リターン

VideoItem - この VideoItem(チェーン用)

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

setVideoUrl(youtubeUrl)

指定した YouTube URL または YouTube 動画 ID から動画自体を設定します。

パラメータ

名前説明
youtubeUrlStringYouTube の URL または ID

リターン

VideoItem - この VideoItem(チェーン用)

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

setWidth(width)

動画の幅をピクセル単位で設定します。設定できるのは動画の幅のみです。高さは、動画のアスペクト比に合わせて自動的に設定されます。

パラメータ

名前説明
widthInteger幅(ピクセル単位)

リターン

VideoItem - この VideoItem(チェーン用)

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms