Interface Item

Élément

Élément de formulaire générique contenant des propriétés communes à tous les éléments, telles que le titre et le texte d'aide. Vous pouvez accéder à des éléments ou en créer à partir d'un Form.

Pour effectuer des opérations sur des propriétés spécifiques à un type, utilisez getType() pour vérifier le ItemType de l'élément, puis transtypez l'élément dans la classe appropriée à l'aide d'une méthode telle que asCheckboxItem(). 

// Create a new form and add a text item.
const form = FormApp.create('Form Name');
form.addTextItem();

// Access the text item as a generic item.
const items = form.getItems();
const item = items[0];

// Cast the generic item to the text-item class.
if (item.getType() === 'TEXT') {
  const textItem = item.asTextItem();
  textItem.setRequired(false);
}

Implémenter des classes

NomBrève description

Méthodes

MéthodeType renvoyéBrève description
asCheckboxGridItem()CheckboxGridItemRenvoie l'élément sous forme d'élément de grille à cases à cocher.
asCheckboxItem()CheckboxItemRenvoie l'élément sous forme de case à cocher.
asDateItem()DateItemRenvoie l'élément sous forme d'élément de date.
asDateTimeItem()DateTimeItemRenvoie l'élément en tant qu'élément de date et heure.
asDurationItem()DurationItemRenvoie l'élément en tant qu'élément de durée.
asGridItem()GridItemRenvoie l'élément sous forme d'élément de grille.
asImageItem()ImageItemRenvoie l'élément en tant qu'élément image.
asListItem()ListItemRenvoie l'élément sous forme d'élément de liste.
asMultipleChoiceItem()MultipleChoiceItemRenvoie l'élément en tant qu'élément à choix multiples.
asPageBreakItem()PageBreakItemRenvoie l'élément en tant qu'élément de saut de page.
asParagraphTextItem()ParagraphTextItemRenvoie l'élément sous forme d'élément de texte de paragraphe.
asRatingItem()RatingItemRenvoie l'élément en tant qu'élément de notation.
asScaleItem()ScaleItemRenvoie l'élément en tant qu'élément d'échelle.
asSectionHeaderItem()SectionHeaderItemRenvoie l'élément en tant qu'élément d'en-tête de section.
asTextItem()TextItemRenvoie l'élément sous forme d'élément de texte.
asTimeItem()TimeItemRenvoie l'élément en tant qu'élément temporel.
asVideoItem()VideoItemRenvoie l'élément sous forme d'élément vidéo.
duplicate()ItemCrée une copie de cet élément et l'ajoute à la fin du formulaire.
getHelpText()StringObtient le texte d'aide de l'élément (parfois appelé texte de description pour les éléments de mise en page tels que ImageItems, PageBreakItems et SectionHeaderItems).
getId()IntegerObtient l'identifiant unique de l'élément.
getIndex()IntegerObtient l'index de l'élément parmi tous les éléments du formulaire.
getTitle()StringObtient le titre de l'élément (parfois appelé texte d'en-tête dans le cas d'un SectionHeaderItem).
getType()ItemTypeObtient le type de l'élément, représenté sous la forme d'un ItemType.
setHelpText(text)ItemDéfinit le texte d'aide de l'élément (parfois appelé texte de description pour les éléments de mise en page tels que ImageItems, PageBreakItems et SectionHeaderItems).
setTitle(title)ItemDéfinit le titre de l'élément (parfois appelé texte d'en-tête dans le cas d'un SectionHeaderItem).

Documentation détaillée

asCheckboxGridItem()

Renvoie l'élément sous forme d'élément de grille à cases à cocher. Génère une exception de script si le ItemType n'était pas déjà CHECKBOX_GRID.

Renvois

CheckboxGridItem : élément de grille de cases à cocher

Génère

Error : si l'élément n'est pas un élément de grille à cases à cocher

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

asCheckboxItem()

Renvoie l'élément sous forme de case à cocher. Génère une exception de script si le ItemType n'était pas déjà CHECKBOX.

Renvois

CheckboxItem : élément de case à cocher

Génère

Error : si l'élément n'est pas une case à cocher

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

asDateItem()

Renvoie l'élément sous forme d'élément de date. Génère une exception de script si le ItemType n'était pas déjà DATE.

Renvois

DateItem : élément de date

Génère

Error : si l'élément n'est pas un élément de date

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

asDateTimeItem()

Renvoie l'élément en tant qu'élément de date et heure. Génère une exception de script si le ItemType n'était pas déjà DATETIME.

Renvois

DateTimeItem : élément date et heure

Génère

Error : si l'élément n'est pas un élément de date et heure

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

asDurationItem()

Renvoie l'élément en tant qu'élément de durée. Génère une exception de script si le ItemType n'était pas déjà DURATION.

Renvois

DurationItem : élément de durée

Génère

Error : si l'élément n'est pas un élément de durée

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

asGridItem()

Renvoie l'élément sous forme d'élément de grille. Génère une exception de script si le ItemType n'était pas déjà GRID.

Renvois

GridItem : élément de grille

Génère

Error : si l'élément n'est pas un élément de grille

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

asImageItem()

Renvoie l'élément en tant qu'élément image. Génère une exception de script si le ItemType n'était pas déjà IMAGE.

Renvois

ImageItem : élément image

Génère

Error : si l'élément n'est pas un élément image

asListItem()

Renvoie l'élément sous forme d'élément de liste. Génère une exception de script si le ItemType n'était pas déjà LIST.

Renvois

ListItem : élément de la liste

Génère

Error : si l'élément n'est pas un élément de liste

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

asMultipleChoiceItem()

Renvoie l'élément en tant qu'élément à choix multiples. Génère une exception de script si le ItemType n'était pas déjà MULTIPLE_CHOICE.

Renvois

MultipleChoiceItem : l'élément à choix multiples

Génère

Error : si l'élément n'est pas un élément à choix multiples

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

asPageBreakItem()

Renvoie l'élément en tant qu'élément de saut de page. Génère une exception de script si le ItemType n'était pas déjà PAGE_BREAK.

Renvois

PageBreakItem : élément de saut de page

Génère

Error : si l'élément n'est pas un élément de saut de page

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

asParagraphTextItem()

Renvoie l'élément sous forme d'élément de texte de paragraphe. Génère une exception de script si le ItemType n'était pas déjà PARAGRAPH_TEXT.

Renvois

ParagraphTextItem : élément de texte de paragraphe

Génère

Error : si l'élément n'est pas un élément de texte de paragraphe

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

asRatingItem()

Renvoie l'élément en tant qu'élément de notation. Génère une exception ScriptingException si ItemType n'était pas déjà RATING. 

// Opens the Forms file by its URL. If you created your script from within a
// Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl('https://docs.google.com/forms/d/abc123456/edit');

// Fetch any item which is of type rating.
const item = form.getItems(FormApp.ItemType.RATING)[0];

// Convert the item to a rating item.
const ratingItem = item.asRatingItem();

Renvois

RatingItem : élément de classification.

Génère

Error : si l'élément n'est pas un élément de notation

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

asScaleItem()

Renvoie l'élément en tant qu'élément d'échelle. Génère une exception de script si le ItemType n'était pas déjà SCALE.

Renvois

ScaleItem : élément de mise à l'échelle

Génère

Error : si l'élément n'est pas un élément de type "échelle"

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

asSectionHeaderItem()

Renvoie l'élément en tant qu'élément d'en-tête de section. Génère une exception de script si le ItemType n'était pas déjà SECTION_HEADER.

Renvois

SectionHeaderItem : élément d'en-tête de section

Génère

Error : si l'élément n'est pas un élément d'en-tête de section

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

asTextItem()

Renvoie l'élément sous forme d'élément de texte. Génère une exception de script si le ItemType n'était pas déjà TEXT.

Renvois

TextItem : élément textuel

Génère

Error : si l'élément n'est pas un élément de texte

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

asTimeItem()

Renvoie l'élément en tant qu'élément temporel. Génère une exception de script si le ItemType n'était pas déjà TIME.

Renvois

TimeItem : élément temporel

Génère

Error : si l'élément n'est pas un élément temporel

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

asVideoItem()

Renvoie l'élément sous forme d'élément vidéo. Génère une exception de script si le ItemType n'était pas déjà VIDEO.

Renvois

VideoItem : élément vidéo

Génère

Error : si l'élément n'est pas une vidéo

duplicate()

Crée une copie de cet élément et l'ajoute à la fin du formulaire.

Renvois

Item : double de ce Item, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

getHelpText()

Obtient le texte d'aide de l'élément (parfois appelé texte de description pour les éléments de mise en page tels que ImageItems, PageBreakItems et SectionHeaderItems).

Renvois

String : texte d'aide ou description de l'élément

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

getId()

Obtient l'identifiant unique de l'élément.

Renvois

Integer : ID de l'article

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

getIndex()

Obtient l'index de l'élément parmi tous les éléments du formulaire.

Renvois

Integer : index de l'élément

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

getTitle()

Obtient le titre de l'élément (parfois appelé texte d'en-tête dans le cas d'un SectionHeaderItem).

Renvois

String : titre ou texte d'en-tête de l'élément

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

getType()

Obtient le type de l'élément, représenté sous la forme d'un ItemType.

Renvois

ItemType : type de l'article

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

setHelpText(text)

Définit le texte d'aide de l'élément (parfois appelé texte de description pour les éléments de mise en page tels que ImageItems, PageBreakItems et SectionHeaderItems).

Paramètres

NomTypeDescription
textStringle nouveau texte d'aide ;

Renvois

Item : Item, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

setTitle(title)

Définit le titre de l'élément (parfois appelé texte d'en-tête dans le cas d'un SectionHeaderItem).

Paramètres

NomTypeDescription
titleStringle nouveau titre ou texte d'en-tête ;

Renvois

Item : Item, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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