O relatório de atividades do administrador retorna informações sobre as atividades do Admin Console de todos os administradores da sua conta. Cada relatório usa a solicitação básica de endpoint de relatório com parâmetros específicos, como o nome de um administrador ou um evento específico do Admin Console. O período máximo de cada relatório são os últimos 180 dias.
O relatório de atividades administrativas só pode ser usado para fins legais de acordo com o Contrato do Cliente. Esses relatórios se aplicam às contas do Google Workspace, Education e ISP.
Recuperar todas as atividades administrativas
Para recuperar um relatório de todas as atividades administrativas realizadas em uma conta, use a seguinte solicitação HTTP GET e inclua o token de autorização descrito na documentação de autorização. Para mais informações sobre as strings de consulta da solicitação e as propriedades da resposta, consulte a Referência da API. Para facilitar a leitura, o exemplo a seguir é formatado com retornos de linha:
GET https://admin.googleapis.com/admin/reports/v1/activity/users/all /applications/admin ?endTime=a date &startTime=a date &maxResults=number of events listed on each page of the report
O exemplo a seguir obtém um relatório sobre todas as atividades administrativas de sua conta nos últimos 180 dias, que é o período máximo para um relatório. E a string de consulta maxResults determina que este relatório contém dois eventos por página. Para ver um exemplo de uma resposta da API, consulte o exemplo de resposta JSON:
GET https://admin.googleapis.com/admin/reports/v1/activity/users/all /applications/admin?maxResults=2
O exemplo a seguir gera um relatório sobre todas as atividades administrativas de um cliente nos últimos 180 dias. O customerId especifica para qual cliente o relatório será recuperado.
GET https://admin.googleapis.com/admin/reports/v1/activity/users/all /applications/admin?customerId=C03az79cb
Recuperar todas as atividades do administrador
Para recuperar um relatório de todas as atividades do Admin Console feitas por um administrador específico, use a seguinte solicitação HTTP GET e inclua o token de autorização descrito na documentação de autorização. userKey é o endereço de e-mail principal do administrador no relatório. Para mais informações sobre as strings de consulta da solicitação e as propriedades da resposta, consulte a Referência da API. Para facilitar a leitura, o exemplo a seguir é formatado com retornos de linha:
GET https://admin.googleapis.com/admin/reports/v1/activity/users/userKey /applications/admin ?endTime=a date &startTime=a date &maxResults=number of events listed on each page of the report &filters=event name parameter relational operator parameter value
O exemplo a seguir gera um relatório sobre todas as mudanças no aplicativo Admin Console feitas por john@example.com, e a resposta é filtrada para retornar todas as atividades com um OLD_VALUE igual a ALLOW_CAMERA. Para conferir um exemplo de resposta da API, consulte o exemplo de resposta JSON. Para informações sobre as atividades, consulte os nomes de eventos do administrador:
GET https://admin.googleapis.com/admin/reports/v1/activity/users/john@example.com /applications/admin?maxResults=2&filters=OLD_VALUE==ALLOW_CAMERA
Recuperar todas as atividades por nome de evento
Para recuperar um relatório de todas as atividades de um nome de evento específico, use a seguinte solicitação HTTP GET e inclua o token de autorização descrito na documentação de autorização. Para informações sobre eventName, consulte as informações de referência dos nomes de eventos do administrador. Para mais informações sobre as strings de consulta da solicitação e as propriedades da resposta, consulte a Referência da API. Para facilitar a leitura, o exemplo a seguir é formatado com retornos de linha:
GET https://admin.googleapis.com/admin/reports/v1/activity/users/all /applications/admin ?endTime=a date &startTime=a date &maxResults=maximum number of events returned on a response page &eventName=name of the administrative event
O exemplo a seguir recupera um relatório de todas as instâncias do Admin Console de alteração do sobrenome de um usuário. Para ver um exemplo de uma resposta da API, consulte o exemplo de resposta JSON:
GET https://admin.googleapis.com/admin/reports/v1/activity/users/all /applications/admin ?maxResults=1&eventName=CHANGE_LAST_NAME
Recuperar todas as atividades por evento e administrador
Para recuperar um relatório de todas as alterações no Admin Console de um nome de evento específico feitas por um administrador específico, use a seguinte solicitação HTTP GET e inclua o token de autorização descrito na documentação de autorização. userKey é o endereço de e-mail principal do administrador no relatório. Para informações sobre eventName, consulte as informações de referência dos nomes de eventos do administrador. Para mais informações sobre as strings de consulta da solicitação e as propriedades da resposta, consulte a Referência da API. Para facilitar a leitura, o exemplo a seguir é formatado com retornos de linha:
GET https://admin.googleapis.com/admin/reports/v1/activity/users/userKey /applications/admin ?endTime=a date &startTime=a date &maxResults=maximum number of events returned on a response page &eventName=name of the administrative event
O exemplo a seguir recupera um relatório de todas as mudanças feitas no Admin Console feitas por john@example.com no sobrenome de um usuário específico. Para ver um exemplo de uma resposta da API, consulte o exemplo de resposta JSON:
GET https://admin.googleapis.com/admin/reports/v1/activity/users/john@example.com /applications/admin?maxResults=1&eventName=CHANGE_LAST_NAME
Exemplo de resposta JSON do relatório de atividades do administrador
Uma resposta bem-sucedida retorna um código de status HTTP 200. Junto com o código de status, a resposta retorna um relatório. Para informações sobre eventName, consulte as informações de referência dos nomes de eventos do administrador. Para mais informações sobre as strings de consulta do URL da solicitação e as propriedades da resposta, consulte a Referência da API.
{
"kind": "reports#auditActivities",
"nextPageToken": "the next page's token ",
"items": [
{
"kind": "audit#activity",
"id": {
"time": "2011-06-17T15:39:18.460Z",
"uniqueQualifier": "report's unique ID ",
"applicationName": "admin",
"customerId": "C03az79cb"
},
"actor": {
"callerType": "USER",
"email": "liz@example.com",
"profileId": "user's unique Google Workspace profile ID ",
"key": "consumer key of requestor in OAuth 2LO requests "
},
"ownerDomain": "example.com",
"ipAddress": "user's IP address ",
"events": [
{
"type": "GROUP_SETTINGS",
"name": "CHANGE_GROUP_SETTING",
"parameters": [
{
"name": "SETTING_NAME",
"value": "WHO_CAN_JOIN",
"intValue": "integer value of parameter ",
"boolValue": "boolean value of parameter "
}
]
}
]
},
{
"kind": "audit#activity",
"id": {
"time": "2011-06-17T15:39:18.460Z",
"uniqueQualifier": "reports unique ID ",
"applicationName": "admin",
"customerId": "C03az79cb"
},
"actor": {
"callerType": "USER",
"email": "liz@example.com",
"profileId": "user's unique Google Workspace profile ID ",
"key": "consumer key of requestor in an OAuth 2LO request "
},
"ownerDomain": "example.com",
"ipAddress": "user's IP address ",
"events": [
{
"type": "GROUP_SETTINGS",
"name": "CREATE_GROUP",
"parameters": [
{
"name": "GROUP_EMAIL",
"value": "helpdesk@example.com",
"intValue": "",
"boolValue": ""
}
]
}
]
}
]
}