Method: courses.announcements.list

요청자가 볼 수 있는 공지사항 목록을 반환합니다.

과정의 학생은 PUBLISHED개의 공지사항만 볼 수 있습니다. 과정 교사와 도메인 관리자는 모든 공지사항을 볼 수 있습니다.

이 메서드는 다음 오류 코드를 반환합니다.

  • PERMISSION_DENIED - 요청한 사용자에게 요청된 과정에 대한 액세스 권한이 없거나 액세스 오류가 있는 경우
  • 요청 형식이 잘못된 경우 INVALID_ARGUMENT입니다.
  • 요청한 과정이 없는 경우 NOT_FOUND입니다.

HTTP 요청

GET https://classroom.googleapis.com/v1/courses/{courseId}/announcements

URL은 gRPC 트랜스코딩 문법을 사용합니다.

경로 매개변수

매개변수
courseId

string

과정의 식별자입니다. 이 식별자는 클래스룸에서 할당한 식별자 또는 alias일 수 있습니다.

쿼리 매개변수

매개변수
announcementStates[]

enum (AnnouncementState)

반환된 공지사항의 state에 대한 제한입니다. 이 인수를 지정하지 않으면 기본값은 PUBLISHED입니다.

orderBy

string

결과에 대한 정렬 순서입니다(선택사항). 선택사항인 정렬 방향 키워드를 사용하는 쉼표로 구분된 필드 목록입니다. 지원되는 필드는 updateTime입니다. 지원되는 경로 키워드는 ascdesc입니다. 지정하지 않으면 updateTime desc가 기본 동작입니다. 예: updateTime asc, updateTime

pageSize

integer

반환할 최대 항목 수입니다. 0 또는 지정되지 않은 값은 서버가 최댓값을 할당할 수 있음을 나타냅니다.

서버는 지정된 수보다 적은 수의 결과를 반환할 수도 있습니다.

pageToken

string

이전 list 호출에서 반환된 nextPageToken 값이며, 결과의 후속 페이지를 반환해야 함을 나타냅니다.

그 외의 list 요청은 이 토큰을 생성한 요청과 동일해야 합니다.

요청 본문

요청 본문은 비어 있어야 합니다.

응답 본문

과정 활동을 나열할 때의 응답입니다.

성공할 경우 응답 본문에 다음 구조의 데이터가 포함됩니다.

JSON 표현
{
  "announcements": [
    {
      object (Announcement)
    }
  ],
  "nextPageToken": string
}
필드
announcements[]

object (Announcement)

요청과 일치하는 공지사항 항목입니다.

nextPageToken

string

반환할 다음 결과 페이지를 식별하는 토큰입니다. 비어 있으면 추가 결과가 없습니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/classroom.announcements
  • https://www.googleapis.com/auth/classroom.announcements.readonly

자세한 내용은 승인 가이드를 참조하세요.