REST Resource: courses.announcements

Ressource: Announcement

Annonce créée par un enseignant pour les élèves du cours

Représentation JSON
{
  "courseId": string,
  "id": string,
  "text": string,
  "materials": [
    {
      object (Material)
    }
  ],
  "state": enum (AnnouncementState),
  "alternateLink": string,
  "creationTime": string,
  "updateTime": string,
  "scheduledTime": string,
  "assigneeMode": enum (AssigneeMode),
  "individualStudentsOptions": {
    object (IndividualStudentsOptions)
  },
  "creatorUserId": string
}
Champs
courseId

string

Identifiant du cours.

Lecture seule.

id

string

Identifiant attribué par Classroom à cette annonce, unique par cours.

Lecture seule.

text

string

Description de cette annonce. Le texte doit être une chaîne UTF-8 valide ne contenant pas plus de 30 000 caractères.

materials[]

object (Material)

Autres ressources

Les annonces ne doivent pas comporter plus de 20 éléments matériels.

state

enum (AnnouncementState)

État de cette annonce. Si aucune valeur n'est spécifiée, l'état par défaut est DRAFT.

creationTime

string (Timestamp format)

Horodatage de création de cette annonce.

Lecture seule.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Code temporel de la dernière modification de cette annonce.

Lecture seule.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

scheduledTime

string (Timestamp format)

Code temporel facultatif de la date et de l'heure de publication de cette annonce.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

assigneeMode

enum (AssigneeMode)

Mode de l'annonce pour l'utilisateur responsable. Si elle n'est pas spécifiée, la valeur par défaut est ALL_STUDENTS.

individualStudentsOptions

object (IndividualStudentsOptions)

Identifiants des élèves ayant accès à l'annonce. Ce champ n'est défini que si assigneeMode est INDIVIDUAL_STUDENTS. Si assigneeMode est INDIVIDUAL_STUDENTS, seuls les élèves spécifiés dans ce champ peuvent voir l'annonce.

creatorUserId

string

Identifiant de l'utilisateur qui a créé l'annonce.

Lecture seule.

AnnouncementState

États possibles des annonces

Enums
ANNOUNCEMENT_STATE_UNSPECIFIED Aucun état spécifié. Cette valeur n'est jamais renvoyée.
PUBLISHED État de l'annonce publiée. Il s'agit de l'état par défaut.
DRAFT État d'une annonce qui n'est pas encore publiée. Dans cet état, l'annonce n'est visible que par les enseignants du cours et les administrateurs du domaine.
DELETED État de l'annonce publiée, mais désormais supprimée. Dans cet état, l'annonce n'est visible que par les enseignants du cours et les administrateurs du domaine. Les annonces dans cet état sont supprimées au bout d'un certain temps.

Méthodes

create

Crée une annonce.

delete

Supprime une annonce.

get

Renvoie une annonce.

getAddOnContext

Récupère les métadonnées des modules complémentaires Classroom dans le contexte d'un post spécifique.

list

Affiche la liste des annonces que le demandeur est autorisé à consulter.

modifyAssignees

Modifie le mode d'attribution et les options d'une annonce.

patch

Met à jour un ou plusieurs champs d'une annonce.