Method: subscriptions.list

Google Workspace 구독을 나열합니다. 이 방법을 사용하는 방법은 Google Workspace 구독 나열하기를 참고하세요.

HTTP 요청

GET https://workspaceevents.googleapis.com/v1/subscriptions

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

쿼리 매개변수

매개변수
pageSize

integer

선택사항입니다. 반환할 최대 구독 수입니다. 서비스가 이 값보다 적게 반환할 수 있습니다.

지정하지 않거나 0로 설정하면 최대 50개의 구독이 반환됩니다.

최댓값은 100입니다. 100보다 큰 값을 지정하면 시스템에서 100개의 구독만 반환합니다.

pageToken

string

선택사항입니다. 이전 목록 구독 호출에서 수신된 페이지 토큰입니다. 다음 페이지를 검색하려면 이 매개변수를 제공합니다.

페이지로 나눌 때 필터 값은 페이지 토큰을 제공한 호출과 일치해야 합니다. 다른 값을 전달하면 예기치 않은 결과가 발생할 수 있습니다.

filter

string

필수 항목입니다. 쿼리 필터

이벤트 유형 (event_types) 및 대상 리소스 (target_resource)별로 구독을 필터링할 수 있습니다.

쿼리에 이벤트 유형을 하나 이상 지정해야 합니다. 여러 이벤트 유형을 필터링하려면 OR 연산자를 사용합니다.

이벤트 유형 및 대상 리소스별로 필터링하려면 AND 연산자를 사용하고 전체 리소스 이름(예: //chat.googleapis.com/spaces/{space})을 지정합니다.

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

event_types:"google.workspace.chat.membership.v1.updated" OR
  event_types:"google.workspace.chat.message.v1.created"

event_types:"google.workspace.chat.message.v1.created" AND
  target_resource="//chat.googleapis.com/spaces/{space}"

( event_types:"google.workspace.chat.membership.v1.updated" OR
  event_types:"google.workspace.chat.message.v1.created" ) AND
  target_resource="//chat.googleapis.com/spaces/{space}"

서버에서 INVALID_ARGUMENT 오류와 함께 잘못된 쿼리를 거부합니다.

요청 본문

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

응답 본문

SubscriptionsService.ListSubscriptions의 응답 메시지입니다.

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

JSON 표현
{
  "subscriptions": [
    {
      object (Subscription)
    }
  ],
  "nextPageToken": string
}
입력란
subscriptions[]

object (Subscription)

구독 목록입니다.

nextPageToken

string

다음 페이지를 검색하기 위해 pageToken으로 전송할 수 있는 토큰입니다. 이 필드를 생략하면 후속 페이지가 표시되지 않습니다.

승인 범위

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

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/meetings.space.created
  • https://www.googleapis.com/auth/meetings.space.readonly

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