Method: spaces.messages.list

발신자가 참여 중인 스페이스의 메시지(차단된 회원 및 스페이스의 메시지 포함)를 표시합니다. 메시지가 없는 스페이스의 메시지를 나열하면 응답은 빈 객체입니다. REST/HTTP 인터페이스를 사용하는 경우 응답에 빈 JSON 객체 {}가 포함됩니다. 예는 메시지 목록을 참고하세요.

다음 승인 범위 중 하나를 사용하여 사용자 인증이 필요합니다.

  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.import (가져오기 모드 스페이스만 해당)

HTTP 요청

GET https://chat.googleapis.com/v1/{parent=spaces/*}/messages

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

경로 매개변수

매개변수
parent

string

필수 항목입니다. 메시지를 표시할 스페이스의 리소스 이름입니다.

형식: spaces/{space}

쿼리 매개변수

매개변수
pageSize

integer

선택사항입니다. 반환되는 최대 메시지 수입니다. 서비스가 이 값보다 적은 메시지를 반환할 수 있습니다.

지정하지 않으면 최대 25개가 반환됩니다.

최대 값은 1,000입니다. 1,000을 초과하는 값을 사용하면 1,000으로 자동 변경됩니다.

음수 값은 INVALID_ARGUMENT 오류를 반환합니다.
pageToken

string

선택사항입니다. 이전 list messages 호출에서 수신된 페이지 토큰입니다. 후속 페이지를 가져오려면 이 매개변수를 제공합니다.

페이지로 나누는 경우, 제공하는 다른 모든 매개변수가 페이지 토큰을 제공한 호출과 일치해야 합니다. 다른 매개변수에 다른 값을 전달하면 예기치 않은 결과가 발생할 수 있습니다.
filter

string

선택사항입니다. 쿼리 필터입니다.

날짜 (createTime) 및 대화목록 (thread.name)별로 메시지를 필터링할 수 있습니다.

생성 날짜별로 메시지를 필터링하려면 RFC-3339 형식의 타임스탬프와 따옴표로 묶은 createTime를 지정합니다. 예를 들면 "2023-04-21T11:30:00-04:00"입니다. 보다 큰 연산자 >를 사용하여 타임스탬프 이후에 생성된 메시지를 나열하거나 보다 작은 연산자 <를 사용하여 타임스탬프 이전에 생성된 메시지를 나열할 수 있습니다. 시간 간격 내의 메시지를 필터링하려면 두 타임스탬프 사이에 AND 연산자를 사용합니다.

대화목록별로 필터링하려면 thread.name를 지정하고 형식을 spaces/{space}/threads/{thread}로 지정합니다. 쿼리당 thread.name 하나만 지정할 수 있습니다.

대화목록과 날짜를 모두 기준으로 필터링하려면 쿼리에서 AND 연산자를 사용하세요.

예를 들어 다음 쿼리는 유효합니다.

createTime > "2012-04-21T11:30:00-04:00"

createTime > "2012-04-21T11:30:00-04:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

createTime > "2012-04-21T11:30:00+00:00" AND

createTime < "2013-01-01T00:00:00+00:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

thread.name = spaces/AAAAAAAAAAA/threads/123

잘못된 쿼리는 서버에서 INVALID_ARGUMENT 오류와 함께 거부됩니다.
orderBy

string

선택사항입니다. 메시지 목록의 순서입니다. 정렬 작업에 따라 정렬할 값을 지정합니다. 유효한 순서 지정 작업 값은 다음과 같습니다.

  • 오름차순의 경우 ASC

  • 내림차순의 경우 DESC

기본 순서는 createTime ASC입니다.
showDeleted

boolean

선택사항입니다. 삭제된 메시지를 포함할지 여부입니다. 삭제된 메일에는 삭제 시간과 삭제에 관한 메타데이터가 포함되지만 메시지 콘텐츠는 사용할 수 없습니다.

요청 본문

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

응답 본문

메시지 목록에 대한 응답 메시지입니다.

성공한 경우 응답 본문은 다음과 같은 구조의 데이터를 포함합니다.

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

object (Message)

메시지 목록
nextPageToken

string

토큰을 pageToken으로 전송하여 결과의 다음 페이지를 검색할 수 있습니다. 비어 있으면 후속 페이지가 없습니다.

승인 범위

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

  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly

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