항목 사용량 보고서는 항목과 관련된 Google Workspace 서비스 활동을 반환합니다. 정보를 볼 수 있습니다. 이러한 보고서는 특정 용도에 맞게 맞춤설정하고 필터링할 수 있습니다. 확인할 수 있습니다 지난 30일간의 데이터를 사용할 수 있습니다.
법인 사용 보고서는 다음의 법적 목적으로만 사용할 수 있습니다. 을 준수해야 합니다. 이 보고서는 Google Workspace 및 Education
모든 항목 사용 활동 가져오기
현재 이 API에서 지원하는 유일한 항목 유형은 Google+ 커뮤니티입니다. 포드의 상태를
계정 내 앱 항목과 관련된 모든 활동을 보고할 때 다음을 사용하세요.
GET HTTP 요청을 호출하고 다음에 설명된 승인 토큰을 포함합니다.
승인 문서가 필요합니다. 대상
다음 예는 줄 반환으로 형식이 지정됩니다.
GET https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/all/dates/date ?parameters=applicationParameters &filters=parameterFilters &maxResults=maxResults
date 값은 사용량이 발생한 날짜이며 타임스탬프는 ISO 8601 형식, yyyy-mm-dd. 권장사항: 계정의 시간대를 사용합니다. 쿼리 문자열 매개변수 및 자세한 내용은 API 참조. 항목 사용량 보고서 매개변수에 대한 자세한 내용은 다음을 참고하세요. 항목 사용량 매개변수 참조
applicationParameters는 검색하려는 매개변수의 쉼표로 구분된 목록입니다.
각 매개변수의 형식은 application:parameter_name입니다. 예를 들면 다음과 같습니다.
gplus:community_name입니다. 사용 가능한 매개변수는
항목 사용량 매개변수
참조 매개변수를 지정하지 않으면 모두 반환됩니다.
parameterFilters는 결과에 적용할 필터의 쉼표로 구분된 목록입니다. 각
필터의 형식은 다음과 같습니다.
application:parameter_name[relational_operator]parameter_value 예를 들어
필터 gplus:num_total_members>100 - 결과만 포함하도록 결과를 필터링합니다.
여기서 gplus:num_total_members 매개변수의 값이 100보다 큽니다.
maxResults는 한 번의 가져오기에서 반환할 최대 결과 수입니다. 총
결과 수가 이보다 크면 응답이 잘리고
nextPageToken가 포함됩니다. 자세한 내용은
아래 JSON 응답 예).
예
다음 예에서는 모든 매개변수가 포함된 보고서를 가져옵니다.
gplus_communities 항목 전체
GET https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/all /dates/2017-12-11
다음 예시에서는 community_name 매개변수가 포함된 보고서를 가져옵니다.
(gplus_communities 항목 모두)
GET https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/all /dates/2017-12-11?parameters=gplus:community_name
다음 예는 community_name의 보고서를 가져오고
각 gplus_communities 항목에 대한 num_total_members, 다음을 기준으로 필터링됨
회원이 100명 이상인 커뮤니티 API 응답의 예는 다음을 참조하세요.
JSON 응답 예
GET https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/all/dates/2017-12-11 ?parameters=gplus:community_name,gplus:num_total_members&filters=gplus:num_total_members>100
특정 항목에 대한 보고서 가져오기
특정 항목에 대한 보고서를 검색하려면 다음 GET HTTP 요청을 사용하고
이
승인 문서가 필요합니다. 대상
다음 예는 줄 반환으로 형식이 지정됩니다.
GET https://admin.googleapis.com/admin/reports/v1/gplus_communities/entityKey/dates/date ?parameters=applicationParameters &filters=parameterFilters &maxResults=maxResults
entityKey는 있습니다. API 참조 참조: 특정 항목의 entityKey를 얻는 방법에 관한 자세한 내용은 다음을 참고하세요. 파악할 수 있습니다 다른 매개변수는 위의 모든 항목 사용 활동 검색
쿼리 문자열 매개변수와 응답 속성에 대한 자세한 내용은 API 참조를 확인하세요. 정보 항목 사용 보고서 매개변수에 대한 자세한 내용은 항목 사용량 매개변수 참조
예
다음 예는 gplus_community 항목의 항목 보고서를 가져오고,
entityKey '1234'.
https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/1234/dates/2017-12-11
사용량 보고서 JSON 응답 예
성공 응답은 HTTP 200 상태 코드를 반환합니다. 또한 응답에서 보고서를 반환합니다. 응답의 일부 매개변수는 가독성을 위해 생략됩니다.
항목 보고서의 JSON 응답 예시
{
"kind": "reports#usageReports",
"nextPageToken": "NjQ1OTgwODk0MzkxNDAwNjQ0OA",
"usageReports": [
{
"kind": "admin#reports#usageReport",
"date": "2017-12-11",
"entity": {
"type": "OBJECT",
"customerId": "C03az79cb",
"objectType": "GPLUS_COMMUNITY",
"objectId": "1234",
},
"parameters": [
{
"name": "gplus:community_name",
"stringValue": "My Community"
},
{
"name": "gplus:num_total_members",
"intValue": 37
},
{
"name": "gplus:num_7day_active_members",
"intValue": 12
},
{
"name": "gplus:num_30day_active_members",
"intValue": 17
},
]
}
]
}
경고가 있는 항목 보고서의 JSON 응답 예시
요청을 수행할 수 없는 경우 응답에 하나 이상의 경고가 반환될 수 있습니다. 이 예를 들어 요청이 이루어진 시점에는 보고서를 사용할 수 없습니다.{
"kind": "reports#usageReports",
"warnings": [
{
"code": "PARTIAL_DATA_AVAILABLE"
"message": "Data for date 2017-12-11 for application gplus is not available right now, please try again after a few hours."
"data": [
{
"key": "date"
"value": "2017-12-11"
}
]
}
],
"usageReports": [],
}
warnings 배열의 각 항목에는 다음과 같은 매개변수가 있습니다.
<ph type="x-smartling-placeholder">- </ph>
code: 컴퓨터에서 읽을 수 있는 경고 코드message: 사람이 읽을 수 있는 경고 메시지data: 자세한 경고 정보를 제공하는 키-값 쌍 목록입니다.