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 pour 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)

Ressources supplémentaires

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

state

enum (AnnouncementState)

État de cette annonce. Si aucun état n'est spécifié, la valeur par défaut est DRAFT.

creationTime

string (Timestamp format)

Horodatage de la création de cette annonce.

Lecture seule.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

updateTime

string (Timestamp format)

Code temporel de la dernière modification apportée à cette annonce.

Lecture seule.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

scheduledTime

string (Timestamp format)

Code temporel facultatif indiquant la date de publication prévue de cette annonce.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

assigneeMode

enum (AssigneeMode)

Mode d'attribution de l'annonce. Si aucune valeur n'est 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 défini sur 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 d'une annonce publiée. Il s'agit de l'état par défaut.
DRAFT État d'une annonce qui n'a pas encore été publiée. Dans cet état, l'annonce n'est visible que par les enseignants du cours et les administrateurs du domaine.
DELETED État d'une annonce qui a été publiée, mais qui est 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

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

list

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

modifyAssignees

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

patch

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