Method: activities.list

擷取特定客戶帳戶和應用程式的活動清單，例如管理控制台應用程式或 Google 雲端硬碟應用程式。詳情請參閱管理員和 Google 雲端硬碟活動報告指南。如要進一步瞭解活動報告的參數，請參閱活動參數參考指南。

HTTP 要求

GET https://admin.googleapis.com/admin/reports/v1/activity/users/{userKey or all}/applications/{applicationName}

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
userKey or all

string

代表要篩選資料的設定檔 ID 或使用者電子郵件。可以是 all (所有資訊)，也可以是 userKey (使用者的專屬 Google Workspace 個人資料 ID 或主要電子郵件地址)。不得為已刪除的使用者。如要為已刪除的使用者執行這項操作，請在 Directory API 中呼叫 users.list，並使用 showDeleted=true，然後將傳回的 ID 做為 userKey。
applicationName

enum (ApplicationName)

要擷取事件的應用程式名稱。

查詢參數

參數
actorIpAddress

string

執行事件的主機網際網路通訊協定 (IP) 位址。這是另一種篩選報表摘要的方式，可根據活動報表中的使用者 IP 位址進行篩選。這個 IP 位址可能反映使用者的實際位置，也可能不是。舉例來說，IP 位址可能是使用者的 Proxy 伺服器位址或虛擬私人網路 (VPN) 位址。這個參數支援 IPv4 和 IPv6 位址版本。
customerId

string

要擷取資料的顧客專屬 ID。
endTime

string

設定報表顯示的時間範圍結尾。日期採用 RFC 3339 格式，例如 2010-10-28T10:26:35.000Z。預設值為 API 要求的約略時間。API 報表有三個基本時間概念：

  • API 要求報表的日期：API 建立及擷取報表的日期。
  • 報表開始時間：報表顯示的時間範圍開頭。startTime 必須早於 endTime (如有指定) 和提出要求時的目前時間，否則 API 會傳回錯誤。
  • 報表結束時間：報表顯示的時間範圍結束時間。舉例來說，報表摘要的事件時間範圍可以從 4 月開始，到 5 月結束，而報表本身則可以在 8 月要求。
如果未指定 endTime，報表會傳回從 startTime 到目前時間的所有活動，如果 startTime 是 180 天前，則會傳回最近 180 天的活動。

如果是 Gmail 要求，則必須提供 startTime 和 endTime，且兩者間隔不得超過 30 天。
eventName

string

API 查詢的事件名稱。每個 eventName 都與特定的 Google Workspace 服務或功能相關，API 會將這些服務或功能整理成不同類型的事件。舉例來說，管理控制台應用程式的報表會顯示 Google 日曆活動。「日曆設定」type結構包含 API 回報的所有「日曆」eventName活動。管理員變更日曆設定時，API 會在「日曆設定」type和 eventName 參數中回報這項活動。如要進一步瞭解eventName查詢字串和參數，請參閱上方applicationName中各種應用程式的事件名稱清單。
filters

string

filters 查詢字串是以逗號分隔的清單，由關係運算子操控的事件參數組成。事件參數的格式為 {parameter1 name}{relational operator}{parameter1 value},{parameter2 name}{relational operator}{parameter2 value},...

這些事件參數與特定 eventName 相關聯。如果要求參數不屬於 eventName，系統會傳回空白報表。如要進一步瞭解各應用程式的可用 eventName 欄位及其相關聯的參數，請前往「ApplicationName」表格，然後點選附錄中所需應用程式的「Activity Events」頁面。

在下列雲端硬碟活動範例中，傳回的清單包含所有 edit 事件，其中 doc_id 參數值符合關係運算子定義的條件。在第一個範例中，要求會傳回 doc_id 值等於 12345 的所有已編輯文件。在第二個範例中，報表會傳回 doc_id 值不等於 98765 的所有已編輯文件。要求查詢字串中的 <> 運算子會經過網址編碼 (%3C%3E)：

GET...&eventName=edit&filters=doc_id==12345
GET...&eventName=edit&filters=doc_id%3C%3E98765

filters 查詢支援下列關係運算子：

  • == -「等於」。
  • <>「不等於」。必須經過網址編碼 (%3C%3E)。
  • <—'less than'。必須經過網址編碼 (%3C)。
  • <= -「小於或等於」。必須經過網址編碼 (%3C=)。
  • >「大於」。必須經過網址編碼 (%3E)。
  • >=「大於或等於」。必須經過網址編碼 (%3E=)。

注意：API 不接受同一參數的多個值。如果 API 要求中提供的參數超過一次，API 只會接受該參數的最後一個值。此外，如果 API 要求中提供無效參數，API 會忽略該參數，並傳回與其餘有效參數相應的回應。如未要求任何參數，系統會傳回所有參數。
maxResults

integer

決定每個回覆頁面顯示的活動記錄數量。舉例來說，如果要求設定 maxResults=1，且報表有兩項活動，則報表會有兩頁。回應的 nextPageToken 屬性包含第二頁的權杖。要求中的 maxResults 查詢字串為選用項目。預設值為 1000。
orgUnitID

string

要產生報表的機構單位 ID。系統只會顯示指定機構單位中，使用者所屬的活動記錄。
pageToken

string

指定下一頁的符記。如果報表有多個頁面，回應中會包含 nextPageToken 屬性。在後續要求中取得下一頁報表時，請在 pageToken 查詢字串中輸入 nextPageToken 值。
startTime

string

設定報表顯示的時間範圍開頭。日期採用 RFC 3339 格式，例如 2010-10-28T10:26:35.000Z。這份報表會傳回 startTime 到 endTime 的所有活動。startTime 必須早於 endTime (如有指定) 和提出要求時的目前時間，否則 API 會傳回錯誤。

如果是 Gmail 要求，則必須提供 startTime 和 endTime，且兩者間隔不得超過 30 天。
groupIdFilter

string

以半形逗號分隔的群組 ID (經過模糊處理)，用於篩選使用者活動，也就是說，回應只會包含至少屬於其中一個群組 ID 的使用者活動。格式：「id:abc123,id:xyz456」

要求主體

要求主體必須為空白。

回應主體

活動集合的 JSON 範本。

如果成功，回應主體會含有以下結構的資料：

JSON 表示法 
{
  "kind": string,
  "etag": string,
  "items": [
    {
      object (Activity)
    }
  ],
  "nextPageToken": string
}
欄位
kind

string

API 資源類型。如果是活動報告，值為 reports#activities。
etag

string

資源的 ETag。
items[]

object (Activity)

回應中的每筆活動記錄。
nextPageToken

string

用於擷取後續報表頁面的權杖。nextPageToken 值會用於要求的 pageToken 查詢字串。

授權範圍

需要下列 OAuth 範圍：

  • https://www.googleapis.com/auth/admin.reports.audit.readonly

詳情請參閱授權指南。

ApplicationName

列舉
access_transparency

Google Workspace「資料存取透明化控管機制」活動報告會傳回不同類型的資料存取透明化控管機制活動事件相關資訊。
admin

管理控制台應用程式的活動報告會傳回不同類型管理員活動事件的帳戶資訊。
calendar

Google 日曆應用程式的活動報告會傳回各種日曆活動事件的相關資訊。
chat Chat 活動報表會傳回各種 Chat 活動事件的相關資訊。
drive

Google 雲端硬碟應用程式的活動報告會傳回各種 Google 雲端硬碟活動事件的相關資訊。雲端硬碟活動報表僅適用於 Google Workspace Business 和 Enterprise 客戶。
gcp Google Cloud Platform 應用程式的活動報表會傳回各種 GCP 活動事件的相關資訊。
gmail Gmail 應用程式的活動報告會傳回各種 Gmail 活動事件的相關資訊。
gplus Google+ 應用程式的活動報告會傳回各種 Google+ 活動事件的相關資訊。
groups

Google 網路論壇應用程式的活動報告會傳回各種群組活動事件的相關資訊。
groups_enterprise

Enterprise Groups 活動報表會傳回各種企業群組活動事件的相關資訊。
jamboard Jamboard 活動報表會傳回各種 Jamboard 活動事件的相關資訊。
login

登入應用程式的活動報表會傳回不同類型登入活動事件的帳戶資訊。
meet Meet 稽核活動報告會傳回不同類型的 Meet 稽核活動事件相關資訊。
mobile 裝置稽核活動報表會傳回不同類型的裝置稽核活動事件相關資訊。
rules

規則活動報表會傳回不同類型的規則活動事件相關資訊。
saml

SAML 活動報表會傳回不同類型的 SAML 活動事件相關資訊。
token

權杖應用程式的活動報表會傳回不同類型權杖活動事件的帳戶資訊。
user_accounts

使用者帳戶應用程式的活動報告會傳回不同類型使用者帳戶活動事件的帳戶資訊。
context_aware_access

情境感知存取權活動報表會傳回使用者因 情境感知存取權規則而遭拒存取事件的相關資訊。
chrome

Chrome 活動報告會回報 Chrome 瀏覽器和 ChromeOS 事件的相關資訊。
data_studio 數據分析活動報表會傳回各種數據分析活動事件的相關資訊。
keep Keep 應用程式的活動報告會傳回各種 Google Keep 活動事件的相關資訊。Keep 活動報表僅適用於 Google Workspace Business 和 Enterprise 客戶。
vault 保管箱活動報表會傳回各種保管箱活動事件的相關資訊。
gemini_in_workspace_apps Gemini for Workspace 活動報表會傳回使用者在 Workspace 應用程式中執行的各種 Gemini 活動事件資訊。
classroom Classroom 活動報表會傳回不同類型的 Classroom 活動事件相關資訊。

活動

活動資源的 JSON 範本。

JSON 表示法 
{
  "kind": string,
  "etag": string,
  "ownerDomain": string,
  "ipAddress": string,
  "events": [
    {
      "type": string,
      "name": string,
      "parameters": [
        {
          "messageValue": {
            "parameter": [
              {
                object (NestedParameter)
              }
            ]
          },
          "name": string,
          "value": string,
          "multiValue": [
            string
          ],
          "intValue": string,
          "multiIntValue": [
            string
          ],
          "boolValue": boolean,
          "multiMessageValue": [
            {
              "parameter": [
                {
                  object (NestedParameter)
                }
              ]
            }
          ]
        }
      ],
      "resourceIds": [
        string
      ]
    }
  ],
  "id": {
    "time": string,
    "uniqueQualifier": string,
    "applicationName": string,
    "customerId": string
  },
  "actor": {
    "profileId": string,
    "email": string,
    "callerType": string,
    "key": string,
    "applicationInfo": {
      "oauthClientId": string,
      "applicationName": string,
      "impersonation": boolean
    }
  },
  "networkInfo": {
    object (NetworkInfo)
  },
  "resourceDetails": [
    {
      object (ResourceDetails)
    }
  ]
}
欄位
kind

string

API 資源類型。如果是活動報告，值為 audit#activity。
etag

string

項目的 ETag。
ownerDomain

string

這是受到報表事件影響的網域。例如管理控制台的網域，或是雲端硬碟應用程式的文件擁有者。
ipAddress

string

執行動作的使用者 IP 位址。這是使用者登入 Google Workspace 時的網際網路通訊協定 (IP) 位址，可能反映使用者的實際位置，也可能不是。舉例來說，IP 位址可能是使用者的 Proxy 伺服器位址或虛擬私人網路 (VPN) 位址。API 支援 IPv4 和 IPv6。
events[]

object

報表中的活動事件。
events[].type

string

事件類型。管理員變更的 Google Workspace 服務或功能會顯示在 type 屬性中，該屬性會使用 eventName 屬性識別事件。如需 API type 類別的完整清單，請參閱上方 applicationName 中各種應用程式的事件名稱清單。
events[].name

string

活動名稱。這是 API 回報的活動名稱。每個 eventName 都與特定的 Google Workspace 服務或功能相關，API 會將這些服務或功能整理成不同類型的事件。
一般而言，eventName 要求參數：

  • 如果未提供 eventName，報表會傳回 eventName 的所有可能執行個體。
  • 要求 eventName 時，API 的回應會傳回包含該 eventName 的所有活動。

如要進一步瞭解eventName屬性，請參閱上方applicationName中各種應用程式的事件名稱清單。
events[].parameters[]

object

適用於各種應用程式的參數值配對。如要進一步瞭解eventName參數，請參閱上方各種應用程式的事件名稱清單applicationName。
events[].parameters[].messageValue

object

與這個參數相關聯的巢狀參數值配對。參數的複雜值類型會以參數值清單的形式傳回。舉例來說，地址參數的值可能是 [{parameter: [{name: city, value: abc}]}]
events[].parameters[].messageValue.parameter[]

object (NestedParameter)

參數值
events[].parameters[].name

string

參數的名稱。
events[].parameters[].value

string

參數的字串值。
events[].parameters[].multiValue[]

string

參數的字串值。
events[].parameters[].intValue

string (int64 format)

參數的整數值。
events[].parameters[].multiIntValue[]

string (int64 format)

參數的整數值。
events[].parameters[].boolValue

boolean

參數的布林值。
events[].parameters[].multiMessageValue[]

object

activities.list 的 messageValue 個物件。
events[].parameters[].multiMessageValue[].parameter[]

object (NestedParameter)

參數值
events[].resourceIds[]

string

與活動相關聯的資源 ID。
id

object

每筆活動記錄的專屬 ID。
id.time

string

活動發生時間。這是以秒為單位的 UNIX Epoch 時間。
id.uniqueQualifier

string (int64 format)

如果多個事件的時間相同，請使用專屬限定符。
id.applicationName

string

事件所屬的應用程式名稱。如需可能的值，請參閱上方 applicationName 中的應用程式清單。
id.customerId

string

Google Workspace 帳戶的專屬 ID。
actor

object

執行動作的使用者。
actor.profileId

string

行為者的專屬 Google Workspace 設定檔 ID。如果行為人不是 Google Workspace 使用者，這個值可能不存在，也可能是 105250506097979753968，做為預留位置 ID。
actor.email

string

執行者的主要電子郵件地址。如果動作項目沒有相關聯的電子郵件地址，系統可能不會顯示這項資訊。
actor.callerType

string

執行者類型。
actor.key

string

只有在 callerType 為 KEY 時才會顯示。可以是 OAuth 2LO API 要求的請求者 consumer_key，也可以是機器人帳戶的 ID。
actor.applicationInfo

object

活動的執行者應用程式詳細資料。
actor.applicationInfo.oauthClientId

string

用於執行動作的第三方應用程式的 OAuth 用戶端 ID。
actor.applicationInfo.applicationName

string

用於執行動作的應用程式名稱。
actor.applicationInfo.impersonation

boolean

應用程式是否模擬使用者。
networkInfo

object (NetworkInfo)

執行動作的使用者網路資訊。
resourceDetails[]

object (ResourceDetails)

執行動作的資源詳細資料。

NetworkInfo

執行動作的使用者網路資訊。

JSON 表示法 
{
  "ipAsn": [
    integer
  ],
  "regionCode": string,
  "subdivisionCode": string
}
欄位
ipAsn[]

integer

執行動作的使用者 IP 位址。
regionCode

string

執行動作的使用者的 ISO 3166-1 alpha-2 區域代碼。
subdivisionCode

string

執行動作的使用者所在國家/地區的 ISO 3166-2 區域代碼 (州和省)。

ResourceDetails

執行動作的資源詳細資料。

JSON 表示法 
{
  "id": string,
  "title": string,
  "type": string,
  "appliedLabels": [
    {
      object (AppliedLabel)
    }
  ],
  "relation": string
}
欄位
id

string

資源的 ID。
title

string

資源標題。舉例來說，如果是雲端硬碟文件，這就是文件的標題。如果是電子郵件，這就是主旨。
type

string

資源類型 - 文件、電子郵件、即時通訊訊息
appliedLabels[]

object (AppliedLabel)

活動。套用至資源的標籤清單
relation

string

定義資源與事件的關係

AppliedLabel

套用至資源的標籤詳細資料。

JSON 表示法 
{
  "id": string,
  "title": string,
  "fieldValues": [
    {
      object (FieldValue)
    }
  ],
  "reason": {
    object (Reason)
  }
}
欄位
id

string

標籤的 ID - 僅限標籤 ID，不得是完整的 OnePlatform 資源名稱。
title

string

標籤名稱
fieldValues[]

object (FieldValue)

活動。標籤的一部分，且由使用者設定的欄位清單。如果標籤含有使用者未設定的欄位，就不會顯示在這個清單中。
reason

object (Reason)

標籤套用至資源的原因。

FieldValue

使用者為特定標籤設定的欄位值詳細資料。

JSON 表示法 
{
  "id": string,
  "displayName": string,
  "type": string,
  "reason": {
    object (Reason)
  },

  // Union field value can be only one of the following:
  "unsetValue": boolean,
  "longTextValue": string,
  "textValue": string,
  "textListValue": {
    object (TextListValue)
  },
  "selectionValue": {
    object (SelectionValue)
  },
  "selectionListValue": {
    object (SelectionListValue)
  },
  "integerValue": string,
  "userValue": {
    object (UserValue)
  },
  "userListValue": {
    object (UserListValue)
  },
  "dateValue": {
    object (Date)
  }
  // End of list of possible types for union field value.
}
欄位
id

string

欄位 ID
displayName

string

欄位的顯示名稱
type

string

欄位類型
reason

object (Reason)

將欄位套用至標籤的原因。
聯集欄位 value。儲存在欄位 value 中的值只能是下列其中一個：
unsetValue

boolean

如果未設定這個欄位，則為 true。
longTextValue

string

設定長文字值。
textValue

string

設定文字值。
textListValue

object (TextListValue)

設定文字清單值。
selectionValue

object (SelectionValue)

從下拉式選單中選取單一值，即可設定選取值。
selectionListValue

object (SelectionListValue)

從下拉式選單中選取多個值，設定選取清單值。
integerValue

string (int64 format)

設定整數值。
userValue

object (UserValue)

選取單一使用者，即可設定使用者值。
userListValue

object (UserListValue)

選取多位使用者，設定使用者清單值。
dateValue

object (Date)

設定日期值。

TextListValue

設定文字清單值。

JSON 表示法 
{
  "values": [
    string
  ]
}
欄位
values[]

string

活動。文字值清單。

SelectionValue

從下拉式選單中選取單一值，即可設定選取值。

JSON 表示法 
{
  "id": string,
  "displayName": string,
  "badged": boolean
}
欄位
id

string

所選內容的 ID。
displayName

string

選取範圍的顯示名稱。
badged

boolean

選取項目是否已標示徽章。

SelectionListValue

從下拉式選單中選取多個值，設定選取清單值。

JSON 表示法 
{
  "values": [
    {
      object (SelectionValue)
    }
  ]
}
欄位
values[]

object (SelectionValue)

activities.list of selections.

UserValue

選取單一使用者，即可設定使用者值。

JSON 表示法 
{
  "email": string
}
欄位
email

string

使用者的電子郵件地址。

UserListValue

選取多位使用者，設定使用者清單值。

JSON 表示法 
{
  "values": [
    {
      object (UserValue)
    }
  ]
}
欄位
values[]

object (UserValue)

activities.list of users。

日期

表示完整或部分的日曆日期，例如生日。您可以視重要性決定是否要在別處指定時段和時區。日期以公曆為主，這可以代表下列其中一項：

  • 完整日期，具有非零的年、月和日值。
  • 月和日，年值為零 (例如週年紀念日)。
  • 只有年，月和日值為零。
  • 年和月，日值為零 (例如信用卡到期日)。

相關類型：

JSON 表示法 
{
  "year": integer,
  "month": integer,
  "day": integer
}
欄位
year

integer

日期中的年份。必須為 1 到 9999；如要指定不含年份的日期，請輸入 0。
month

integer

一年中的月份。必須為 1 到 12；如要指定不含日期的年份，請輸入 0。
day

integer

當月第幾日。必須為 1 到 31，並屬於有效的年和月；如果只指定年份，或只指定年份和月份，而不指定當月第幾日的話，請輸入 0。

原因

套用標籤/欄位的原因。

JSON 表示法 
{
  "reasonType": string
}
欄位
reasonType

string

原因類型。