Method: subscriptions.list
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
자세한 내용은 승인 가이드를 참조하세요.
달리 명시되지 않는 한 이 페이지의 콘텐츠에는 Creative Commons Attribution 4.0 라이선스에 따라 라이선스가 부여되며, 코드 샘플에는 Apache 2.0 라이선스에 따라 라이선스가 부여됩니다. 자세한 내용은 Google Developers 사이트 정책을 참조하세요. 자바는 Oracle 및/또는 Oracle 계열사의 등록 상표입니다.
최종 업데이트: 2024-08-22(UTC)
[null,null,["최종 업데이트: 2024-08-22(UTC)"],[[["Lists existing Google Workspace subscriptions, allowing retrieval of details like event types and target resources."],["Enables filtering of subscriptions by event types and target resource using query parameters, requiring at least one event type for filtering."],["Uses pagination to retrieve large lists of subscriptions, providing a `nextPageToken` for accessing subsequent pages."],["Requires specific OAuth scopes for authorization, such as `https://www.googleapis.com/auth/chat.bot` or `https://www.googleapis.com/auth/chat.spaces`, to access and manage subscriptions."],["Returns a response body containing a list of subscriptions and a token for pagination if further pages exist."]]],["This document outlines how to list Google Workspace subscriptions using a `GET` request to `https://workspaceevents.googleapis.com/v1/subscriptions`. Key parameters include `pageSize` (max 100) to limit results, `pageToken` for pagination, and a mandatory `filter` to specify event types and/or target resources using `OR` and `AND` operators. The request body is empty. The response body contains a list of `subscriptions` and an optional `nextPageToken` for subsequent pages. Specific OAuth scopes are required for authorization.\n"]]