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

Types d'événement

Cette page décrit la propriété eventType et les spécifications des types d'événements. disponibles dans l'API Google Calendar.

Google Agenda permet aux utilisateurs de créer des événements génériques, ainsi que des événements sont conçus pour des cas d'utilisation spécifiques et avec des propriétés personnalisées.

Le type d'événement est visible aux endroits suivants dans l'API:

Tous les événements sont renvoyés avec un eventType.
eventType doit être défini lors de la création ou de la mise à jour d'une ressource d'événement. Si cette règle n'est pas configurée, Le type 'default' sera utilisé.
eventTypes peut être spécifié dans une liste Events:list pour répertorier des événements de types spécifiques. Si aucun type n'est spécifié, tous les types d'événements est renvoyé.
eventTypes peut être spécifié dans une instruction Events:watch. pour s'abonner aux mises à jour d'événements de types spécifiques. Si aucun type n'est spécifié, la requête entraîne l'abonnement à tous les types d'événements.

Événement par défaut

Les événements de type default sont créés et utilisés comme l'un des principaux de l'API Google Calendar. Ils sont compatibles avec de nombreux propriétés pour personnaliser davantage l'événement.

Voir créer des événements avec lesquels commencer. des événements Google Agenda.

Anniversaire

Les anniversaires sont des événements spéciaux qui durent toute la journée et se répètent chaque année. Ils ont le rôle caractéristiques suivantes:

eventType est défini sur 'birthday'
start et Les champs end doivent définir une événement d'une journée, qui dure exactement une journée.
Valeur du champ visibility doit être 'private'.
Valeur du champ transparency doit être 'transparent'.
Ils doivent avoir une récurrence annuelle, ce qui signifie Le champ recurrence doit être 'RRULE:FREQ=YEARLY' Les anniversaires tombant le 29 février la règle de récurrence suivante: 'RRULE:FREQ=YEARLY;BYMONTH=2;BYMONTHDAY=-1'
Il peut avoir un colorId, summary et reminders
Ils ne sont pas compatibles avec les autres propriétés d'événement.

Événements ajoutés à partir de Gmail

Événements générés automatiquement à partir de Gmail sont associés au type d'événement 'fromGmail'.

L'API Google Calendar ne permet pas de créer ce type d'événement à l'aide de la propriété insert.

L'API permet de mettre à jour colorId, reminders, visibility, transparency, status, private et shared propriétés étendues à l'aide de la commande update et patch.

L'API accepte les commandes get et list pour lire les événements à partir de Gmail eventTypes peut être est définie sur 'fromGmail' pour répertorier uniquement les événements générés à partir de Gmail. Si aucun type n'est les événements ajoutés à partir de Gmail seront répertoriés avec tous les autres types d'événements.

L'API est compatible avec la méthode watch pour s'abonner aux modifications apportées aux événements ajoutés à partir de Gmail dans Google Agenda. Si aucun type n'est spécifié, tous les types d'événements, y compris 'fromGmail', seront abonnés.

Les événements ajoutés à partir de Gmail peuvent être supprimés à l'aide de l' delete de la méthode API Google Calendar.

Changer l'organisateur d'un événement dans Gmail avec déplacer ou update n'est pas accepté.

Temps de travail, absence du bureau et lieu de travail

L'API Google Calendar permet de créer et de gérer des événements qui indiquent l'état l'état des utilisateurs de Google Agenda.

Ces fonctionnalités ne sont disponibles que dans les agendas principaux, et pour certains Utilisateurs de Google Agenda. Consultez l'article Gérer les moments de concentration, les absences du bureau et les heures de travail. les événements de type "lieu" pour en savoir plus.

Découvrir les types d'événements dans Google Apps Script

Google Apps Script est un service cloud basé sur JavaScript qui permet de créer des applications d'entreprise qui s'intègrent Google Workspace. Les scripts sont développés dans un éditeur de code intégré au navigateur. elles sont stockées et exécutées sur les serveurs de Google. Voir aussi Google Apps Script de démarrage rapide pour commencer à utiliser Apps Script pour envoyer des requêtes à l'API Google Calendar.

Les instructions suivantes décrivent comment lire et gérer les événements à l'aide de la classe l'API Google Calendar en tant que service avancé dans Google Apps Script. Pour obtenir la liste complète des ressources et méthodes de l'API Google Agenda, consultez la documentation de référence.

Créer et configurer le script

Créez un script en accédant à script.google.com/create.
Dans le volet de gauche à côté de Services, cliquez sur "Ajouter un service".
Sélectionnez API Google Calendar, puis cliquez sur Ajouter.
Une fois l'API activée, elle apparaît dans le volet de gauche. Les méthodes et de l'API peuvent être listées à l'aide du mot clé Calendar (Agenda) dans l'éditeur.

(Facultatif) Mettre à jour le projet Google Cloud

Chaque projet Google Apps Script est associé à un projet Google Cloud. Votre peut utiliser le projet par défaut que Google Apps Script s'occupe automatiquement crée. Si vous souhaitez utiliser un projet Google Cloud personnalisé, consultez la section Passer un autre projet Cloud standard. Après avoir défini le projet Google Cloud, sélectionnez Éditeur à gauche pour revenir à la éditeur de code.

Ajouter du code au script

L'exemple de code suivant montre comment répertorier, lire et créer des événements avec différentes valeurs eventType.

Collez le code suivant dans l'éditeur de code.

const CALENDAR_ID = 'CALENDAR_ID' || 'primary';

/** Lists default events. */
function listDefaultEvents() {
  listEvents('default');
}

/** Lists events from Gmail. */
function listEventsFromGmail() {
  listEvents('fromGmail');
}

/**
  * Lists events with the given event type. If no type is specified, lists all events.
  * See https://developers.google.com/calendar/api/v3/reference/events/list
  */
function listEvents(eventType = undefined) {
  // Query parameters for the list request.
  const optionalArgs = {
    eventTypes: eventType ? [eventType] : undefined,
    singleEvents: true,
    timeMax: '2024-07-30T00:00:00+01:00',
    timeMin: '2024-07-29T00:00:00+01:00',
  }
  try {
    var response = Calendar.Events.list(CALENDAR_ID, optionalArgs);
    response.items.forEach(event => console.log(event));
  } catch (exception) {
    console.log(exception.message);
  }
}

/**
  * Reads the event with the given eventId.
  * See https://developers.google.com/calendar/api/v3/reference/events/get
  */
function readEvent() {
  try {
    var response = Calendar.Events.get(CALENDAR_ID, 'EVENT_ID');
    console.log(response);
  } catch (exception) {
    console.log(exception.message);
  }
}

/** Creates a default event. */
function createDefaultEvent() {
  const event = {
    start: { dateTime: '2024-07-30T10:30:00+01:00'},
    end: { dateTime: '2024-07-30T12:30:00+01:00'},
    description: 'Created from Apps Script.',
    eventType: 'default',
    summary: 'Sample event',
  }
  createEvent(event);
}

/**
  * Creates a Calendar event.
  * See https://developers.google.com/calendar/api/v3/reference/events/insert
  */
function createEvent(event) {

  try {
    var response = Calendar.Events.insert(event, CALENDAR_ID);
    console.log(response);
  } catch (exception) {
    console.log(exception.message);
  }
}

Remplacez les éléments suivants :

CALENDAR_ID: adresse e-mail de l'agenda à pour récupérer et créer des événements. Cette constante est initialement définie sur 'primary', qui est un mot clé permettant d'accéder à l'agenda principal de un utilisateur connecté. La modification de cette valeur vous permet de consulter les événements des agendas de d'autres utilisateurs auxquels vous avez accès.
EVENT_ID: ID de l'événement. Vous pouvez appeler la méthode Events:list pour récupérer les identifiants des événements.

Exécuter l'exemple de code

Au-dessus de l'éditeur de code, sélectionnez la fonction à exécuter dans le menu déroulant, puis cliquez sur Exécuter.
Lors de la première exécution, vous êtes invité à autoriser l'accès. Examiner et autoriser Apps Script pour accéder à votre agenda.
Vous pouvez inspecter les résultats de l'exécution du script dans la Execution Log (Journal d'exécution) qui s'affiche en bas de la fenêtre.