Class VideoItem

動画アイテム

動画を表示するレイアウト アイテム。アイテムには Form からアクセスまたは作成できます。

// Open a form by ID and add three new video items, using a long URL,
// a short URL, and a video ID.
const 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');

メソッド

メソッド戻り値の型概要
duplicate()VideoItemこの項目のコピーを作成して、フォームの末尾に追加します。
getAlignment()Alignment動画の水平方向の配置を取得します。
getHelpText()Stringアイテムのヘルプテキストを取得します（ImageItems、PageBreakItems、SectionHeaderItems などのレイアウト アイテムの説明テキストとも呼ばれます）。
getId()Integerアイテムの一意の識別子を取得します。
getIndex()Integerフォーム内のすべてのアイテムの中で、アイテムのインデックスを取得します。
getTitle()Stringアイテムのタイトルを取得します（SectionHeaderItem の場合はヘッダー テキストと呼ばれることもあります）。
getType()ItemTypeアイテムのタイプ（ItemType として表されます）を取得します。
getWidth()Integer動画の幅（ピクセル単位）を取得します。
setAlignment(alignment)VideoItem動画の水平方向の配置を設定します。
setHelpText(text)VideoItemアイテムのヘルプテキスト（ImageItems、PageBreakItems、SectionHeaderItems などのレイアウト アイテムの説明テキスト）を設定します。
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()

アイテムのヘルプテキストを取得します（ImageItems、PageBreakItems、SectionHeaderItems などのレイアウト アイテムの説明テキストとも呼ばれます）。

戻る

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 - チェーン用の this VideoItem

承認

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

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

setHelpText(text)

アイテムのヘルプテキスト（ImageItems、PageBreakItems、SectionHeaderItems などのレイアウト アイテムの説明テキスト）を設定します。

パラメータ

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

戻る

VideoItem - チェーン用の this VideoItem

承認

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

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

setTitle(title)

アイテムのタイトル（SectionHeaderItem の場合はヘッダー テキスト）を設定します。

パラメータ

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

戻る

VideoItem - チェーン用の this 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 - チェーン用の this VideoItem

承認

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

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

setWidth(width)

動画の幅をピクセル単位で設定します。設定できるのは動画の幅のみです。動画のアスペクト比を維持するように高さが自動的に設定されます。

パラメータ

名前型説明
widthInteger幅（ピクセル）

戻る

VideoItem - チェーン用の this VideoItem

承認

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

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