Cette page a été traduite par l'API Cloud Translation.

Class Attachment

Obsolète. Cette classe est obsolète et ne doit pas être utilisée dans de nouveaux scripts.

Une pièce jointe Sites (fichier joint à une page, par exemple)

Notez qu'un rattachement est un objet Blob et peut être utilisé partout où une entrée Blob est attendue.

var filesPage = SitesApp.getSite('example.com', 'mysite').getChildByName("files");
var attachments = filesPage.getAttachments();

// DocsList.createFile accepts a blob input. Since an Attachment is just a blob, we can
// just pass it directly to that method
var file = DocsList.createFile(attachments[0]);

Méthodes

Méthode	Type renvoyé	Brève description
`getAs(contentType)`	`Blob`	Renvoyez les données contenues dans cet objet sous la forme d'un blob converti dans le type de contenu spécifié.
`getBlob()`	`Blob`	Renvoyez les données contenues dans cet objet sous forme de blob.

Méthodes obsolètes

Méthode	Type renvoyé	Brève description
`deleteAttachment()`	`void`	Supprime cette pièce jointe.
`getAttachmentType()`	`AttachmentType`	Renvoyez le type de pièce jointe (HÉBERGÉ ou WEB).
`getContentType()`	`String`	Renvoyez le type MIME de cette pièce jointe.
`getDatePublished()`	`Date`	Indiquez la date à laquelle cette pièce jointe a été publiée pour la première fois.
`getDescription()`	`String`	Renvoyez la description de cette pièce jointe.
`getLastUpdated()`	`Date`	Indiquez la date à laquelle cette pièce jointe a été mise à jour pour la dernière fois.
`getParent()`	`Page`	Obtenez la page parente de cette pièce jointe.
`getTitle()`	`String`	Renvoyez le titre de cette pièce jointe.
`getUrl()`	`String`	Renvoyez l'URL de téléchargement de cette pièce jointe.
`setContentType(contentType)`	`Attachment`	Définissez le type MIME de cette pièce jointe.
`setDescription(description)`	`Attachment`	Définissez la description de cette pièce jointe.
`setFrom(blob)`	`Attachment`	Définissez les données réelles de cette pièce jointe.
`setParent(parent)`	`Attachment`	Définissez la page parente de cette pièce jointe.
`setTitle(title)`	`Attachment`	Définissez le titre de cette pièce jointe.
`setUrl(url)`	`Attachment`	Définit l'URL de téléchargement de cette pièce jointe.

Documentation détaillée

`getAs(contentType)`

Renvoyez les données contenues dans cet objet sous la forme d'un blob converti dans le type de contenu spécifié. Ce ajoute l'extension appropriée au nom du fichier (par exemple, "myfile.pdf"). Cependant, il suppose que la partie du nom de fichier qui suit le dernier point (le cas échéant) est une à remplacer. Par conséquent, "ShoppingList.12.25.2014" devient "ShoppingList.12.25.pdf".

Pour connaître les quotas quotidiens de conversion, consultez la page Quotas Services. Les domaines Google Workspace nouvellement créés peuvent être temporairement soumis à des règles des quotas.

Paramètres

Nom	Type	Description
`contentType`	`String`	Type MIME vers lequel effectuer la conversion. Pour la plupart des blobs, `'application/pdf'` correspond à est la seule option valide. Pour les images au format BMP, GIF, JPEG ou PNG, les valeurs `'image/bmp'`, `'image/gif'`, `'image/jpeg'` ou `'image/png'` le sont également. valide. Pour un document Google Docs, `'text/markdown'` est également valide.

Renvois

Blob : données sous forme de blob.

`getBlob()`

Renvoyez les données contenues dans cet objet sous forme de blob.

Renvois

Blob : données sous forme de blob.

Méthodes obsolètes

`deleteAttachment()`

Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans de nouveaux scripts.

Supprime cette pièce jointe.

var pages = SitesApp.getSite('example.com', 'mysite').getChildren();
var attachments = pages[0].getAttachments();
attachments[0].deleteAttachment();

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

https://sites.google.com/feeds

`getAttachmentType()`

Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans de nouveaux scripts.

Renvoyez le type de pièce jointe (HÉBERGÉ ou WEB).

var pages = SitesApp.getSite('example.com', 'mysite').getChildren();
var attachments = pages[0].getAttachments();
var attType = attachments[0].getAttachmentType();

// This will log "Hosted"
Logger.log(attType);

// Since this returns an AttachmentType and not a String, for the
// purposes of equivalence we want to either do this or cast the
// type to a String
if(attType ==  SitesService.AttachmentType.HOSTED) {
  Logger.log("This is a match");
}

// The above is the same as
if(String(attType) == "Hosted") {
   Logger.log("This is also a match");
}

Renvois

AttachmentType : type de pièce jointe

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

https://sites.google.com/feeds

`getContentType()`

Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans de nouveaux scripts.

Renvoyez le type MIME de cette pièce jointe. Échec des pièces jointes Web.

var pages = SitesApp.getSite('example.com', 'mysite').getChildren();
var attachments = pages[0].getAttachments();
var contentType = attachments[0].getContentType();

Renvois

String : type MIME de la pièce jointe

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

https://sites.google.com/feeds

`getDatePublished()`

Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans de nouveaux scripts.

Indiquez la date à laquelle cette pièce jointe a été publiée pour la première fois.

var pages = SitesApp.getSite('example.com', 'mysite').getChildren();
var attachments = pages[0].getAttachments();
var date = attachments[0].getDatePublished();

Renvois

Date : date de publication originale

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

https://sites.google.com/feeds

`getDescription()`

Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans de nouveaux scripts.

Renvoyez la description de cette pièce jointe.

var pages = SitesApp.getSite('example.com', 'mysite').getChildren();
var attachments = pages[0].getAttachments();
var description = attachments[0].getDescription();

Renvois

String : description de la pièce jointe

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

https://sites.google.com/feeds

`getLastUpdated()`

Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans de nouveaux scripts.

Indiquez la date à laquelle cette pièce jointe a été mise à jour pour la dernière fois.

var pages = SitesApp.getSite('example.com', 'mysite').getChildren();
var attachments = pages[0].getAttachments();
var date = attachments[0].getLastUpdated();

Renvois

Date : date de la dernière mise à jour

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

https://sites.google.com/feeds

`getParent()`

Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans de nouveaux scripts.

Obtenez la page parente de cette pièce jointe.

var pages = SitesApp.getSite('example.com', 'mysite').getChildren();
var attachments = pages[0].getAttachments();

// This is equal to pages[0]
var parent = attachments[0].getParent();

Renvois

Page : page parente

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

https://sites.google.com/feeds

`getTitle()`

Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans de nouveaux scripts.

Renvoyez le titre de cette pièce jointe.

var pages = SitesApp.getSite('example.com', 'mysite').getChildren();
var attachments = pages[0].getAttachments();
var title = attachments[0].getTitle();

Renvois

String : titre de la pièce jointe

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

https://sites.google.com/feeds

`getUrl()`

Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans de nouveaux scripts.

Renvoyez l'URL de téléchargement de cette pièce jointe.

var pages = SitesApp.getSite('example.com', 'mysite').getChildren();
var attachments = pages[0].getAttachments();
var url = attachments[0].getUrl();

Renvois

String : URL de téléchargement

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

https://sites.google.com/feeds

`setContentType(contentType)`

Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans de nouveaux scripts.

Définissez le type MIME de cette pièce jointe. Échec des pièces jointes Web.

var pages = SitesApp.getSite('example.com', 'mysite').getChildren();
var attachments = pages[0].getAttachments();
attachments[0].setContentType("text/plain");

Paramètres

Nom	Type	Description
`contentType`	`String`	le nouveau type MIME

Renvois

Attachment : ce rattachement à associer

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

https://sites.google.com/feeds

`setDescription(description)`

Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans de nouveaux scripts.

Définissez la description de cette pièce jointe.

var pages = SitesApp.getSite('example.com', 'mysite').getChildren();
var attachments = pages[0].getAttachments();

// This is an example of chaining in action
attachments[0].setTitle("New Title")
              .setDescription("New Description");

Paramètres

Nom	Type	Description
`description`	`String`	la nouvelle description

Renvois

Attachment : ce rattachement à associer

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

https://sites.google.com/feeds

`setFrom(blob)`

Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans de nouveaux scripts.

Définissez les données réelles de cette pièce jointe. Échec des pièces jointes Web.

var pages = SitesApp.getSite('demositeappsscript').getChildren();
var attachments = pages[0].getAttachments();

// This snippet demonstrates how to create a new text blob and attach it
// to the page
var blob = Utilities.newBlob("This data is now the attachment content");

// We must set a filename since we created the blob from String data
// instead of something like a URL source
blob.setName("attachment.txt");
attachments[0].setTitle("New Title")
              .setDescription("New Description")
              .setContentType("text/plain")
              .setFrom(blob);

Paramètres

Nom	Type	Description
`blob`	`BlobSource`	les nouvelles données

Renvois

Attachment : ce rattachement à associer

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

https://sites.google.com/feeds

`setParent(parent)`

Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans de nouveaux scripts.

Définissez la page parente de cette pièce jointe.

var pages = SitesApp.getSite('example.com', 'mysite').getChildren();
var attachments = pages[0].getAttachments();
// Sets the parent page to be the next sibling
attachments[0].setParent(pages[1]);

Paramètres

Nom	Type	Description
`parent`	`Page`	le nouveau parent

Renvois

Attachment : ce rattachement à associer

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

https://sites.google.com/feeds

`setTitle(title)`

Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans de nouveaux scripts.

Définissez le titre de cette pièce jointe.

var pages = SitesApp.getSite('example.com', 'mysite').getChildren();
var attachments = pages[0].getAttachments();

// This is an example of chaining in action
attachments[0].setTitle("New Title")
              .setDescription("New Description");

Paramètres

Nom	Type	Description
`title`	`String`	le nouveau titre

Renvois

Attachment : ce rattachement à associer

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

https://sites.google.com/feeds

`setUrl(url)`

Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans de nouveaux scripts.

Définit l'URL de téléchargement de cette pièce jointe. Uniquement valide pour les pièces jointes Web.

var pages = SitesApp.getSite('demositeappsscript').getChildren();
var attachments = pages[0].getAttachments();

attachments[0].setTitle("New Web Attachment")
              .setDescription("New Description")
              .setUrl("http://example.com/files/your_file.txt");

Paramètres

Nom	Type	Description
`url`	`String`

Renvois

Attachment : ce rattachement à associer

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

https://sites.google.com/feeds