索引
AnalyticsAdminService
(介面)AccessBetweenFilter
(訊息)AccessDateRange
(訊息)AccessDimension
(訊息)AccessDimensionHeader
(訊息)AccessDimensionValue
(訊息)AccessFilter
(訊息)AccessFilterExpression
(訊息)AccessFilterExpressionList
(訊息)AccessInListFilter
(訊息)AccessMetric
(訊息)AccessMetricHeader
(訊息)AccessMetricValue
(訊息)AccessNumericFilter
(訊息)AccessNumericFilter.Operation
(列舉)AccessOrderBy
(訊息)AccessOrderBy.DimensionOrderBy
(訊息)AccessOrderBy.DimensionOrderBy.OrderType
(列舉)AccessOrderBy.MetricOrderBy
(訊息)AccessQuota
(訊息)AccessQuotaStatus
(訊息)AccessRow
(訊息)AccessStringFilter
(訊息)AccessStringFilter.MatchType
(列舉)Account
(訊息)AccountSummary
(訊息)AcknowledgeUserDataCollectionRequest
(訊息)AcknowledgeUserDataCollectionResponse
(訊息)ActionType
(列舉)ActorType
(列舉)ArchiveCustomDimensionRequest
(訊息)ArchiveCustomMetricRequest
(訊息)ChangeHistoryChange
(訊息)ChangeHistoryChange.ChangeHistoryResource
(訊息)ChangeHistoryEvent
(訊息)ChangeHistoryResourceType
(列舉)ConversionEvent
(訊息)ConversionEvent.ConversionCountingMethod
(列舉)ConversionEvent.DefaultConversionValue
(訊息)CreateConversionEventRequest
(訊息)CreateCustomDimensionRequest
(訊息)CreateCustomMetricRequest
(訊息)CreateDataStreamRequest
(訊息)CreateFirebaseLinkRequest
(訊息)CreateGoogleAdsLinkRequest
(訊息)CreateKeyEventRequest
(訊息)CreateMeasurementProtocolSecretRequest
(訊息)CreatePropertyRequest
(訊息)CustomDimension
(訊息)CustomDimension.DimensionScope
(列舉)CustomMetric
(訊息)CustomMetric.MeasurementUnit
(列舉)CustomMetric.MetricScope
(列舉)CustomMetric.RestrictedMetricType
(列舉)DataRetentionSettings
(訊息)DataRetentionSettings.RetentionDuration
(列舉)DataSharingSettings
(訊息)DataStream
(訊息)DataStream.AndroidAppStreamData
(訊息)DataStream.DataStreamType
(列舉)DataStream.IosAppStreamData
(訊息)DataStream.WebStreamData
(訊息)DeleteAccountRequest
(訊息)DeleteConversionEventRequest
(訊息)DeleteDataStreamRequest
(訊息)DeleteFirebaseLinkRequest
(訊息)DeleteGoogleAdsLinkRequest
(訊息)DeleteKeyEventRequest
(訊息)DeleteMeasurementProtocolSecretRequest
(訊息)DeletePropertyRequest
(訊息)FirebaseLink
(訊息)GetAccountRequest
(訊息)GetConversionEventRequest
(訊息)GetCustomDimensionRequest
(訊息)GetCustomMetricRequest
(訊息)GetDataRetentionSettingsRequest
(訊息)GetDataSharingSettingsRequest
(訊息)GetDataStreamRequest
(訊息)GetKeyEventRequest
(訊息)GetMeasurementProtocolSecretRequest
(訊息)GetPropertyRequest
(訊息)GoogleAdsLink
(訊息)IndustryCategory
(列舉)KeyEvent
(訊息)KeyEvent.CountingMethod
(列舉)KeyEvent.DefaultValue
(訊息)ListAccountSummariesRequest
(訊息)ListAccountSummariesResponse
(訊息)ListAccountsRequest
(訊息)ListAccountsResponse
(訊息)ListConversionEventsRequest
(訊息)ListConversionEventsResponse
(訊息)ListCustomDimensionsRequest
(訊息)ListCustomDimensionsResponse
(訊息)ListCustomMetricsRequest
(訊息)ListCustomMetricsResponse
(訊息)ListDataStreamsRequest
(訊息)ListDataStreamsResponse
(訊息)ListFirebaseLinksRequest
(訊息)ListFirebaseLinksResponse
(訊息)ListGoogleAdsLinksRequest
(訊息)ListGoogleAdsLinksResponse
(訊息)ListKeyEventsRequest
(訊息)ListKeyEventsResponse
(訊息)ListMeasurementProtocolSecretsRequest
(訊息)ListMeasurementProtocolSecretsResponse
(訊息)ListPropertiesRequest
(訊息)ListPropertiesResponse
(訊息)MeasurementProtocolSecret
(訊息)NumericValue
(訊息)Property
(訊息)PropertySummary
(訊息)PropertyType
(列舉)ProvisionAccountTicketRequest
(訊息)ProvisionAccountTicketResponse
(訊息)RunAccessReportRequest
(訊息)RunAccessReportResponse
(訊息)SearchChangeHistoryEventsRequest
(訊息)SearchChangeHistoryEventsResponse
(訊息)ServiceLevel
(列舉)UpdateAccountRequest
(訊息)UpdateConversionEventRequest
(訊息)UpdateCustomDimensionRequest
(訊息)UpdateCustomMetricRequest
(訊息)UpdateDataRetentionSettingsRequest
(訊息)UpdateDataStreamRequest
(訊息)UpdateGoogleAdsLinkRequest
(訊息)UpdateKeyEventRequest
(訊息)UpdateMeasurementProtocolSecretRequest
(訊息)UpdatePropertyRequest
(訊息)
AnalyticsAdminService
Analytics Admin API (GA4) 服務介面。
AcknowledgeUserDataCollection |
---|
確認指定資源的使用者資料收集條款。 您必須先在 Google Analytics (分析) UI 中或透過這個 API 完成這項確認程序,才能建立 MeasurementProtocolSecret 資源。
|
ArchiveCustomDimension |
---|
封存資源中的自訂維度。
|
ArchiveCustomMetric |
---|
這個外掛程式能封存資源的自訂指標。
|
CreateConversionEvent |
---|
建立具有指定屬性的轉換事件。
|
CreateCustomDimension |
---|
建立自訂維度。
|
CreateCustomMetric |
---|
建立自訂指標。
|
CreateDataStream |
---|
建立 DataStream。
|
CreateFirebaseLink |
---|
建立 FirebaseLink。 資源最多只能有一個 FirebaseLink。
|
CreateGoogleAdsLink |
---|
建立 GoogleAdsLink。
|
CreateKeyEvent |
---|
建立重要事件。
|
CreateMeasurementProtocolSecret |
---|
建立 Measurement Protocol 密鑰。
|
CreateProperty |
---|
建立含有指定地點和屬性的「GA4」資源。
|
DeleteAccount |
---|
將目標帳戶標示為已虛刪除 (例如「已移至垃圾桶」),並傳回該帳戶。 這個 API 無法還原虛刪除的帳戶。不過,如要還原這些郵件,請使用「垃圾桶」使用者介面。 如果在到期前未還原帳戶,帳戶和所有子項資源 (例如:Properties、GoogleAdsLinks、Streams、AccessBindings) 都會遭到永久清除。https://support.google.com/analytics/answer/6154772 如果找不到目標,系統會傳回錯誤。
|
DeleteConversionEvent |
---|
刪除資源中的轉換事件。
|
DeleteDataStream |
---|
這個外掛程式能刪除屬性上的 DataStream。
|
DeleteFirebaseLink |
---|
刪除資源的 FirebaseLink
|
DeleteGoogleAdsLink |
---|
刪除資源的 GoogleAdsLink
|
DeleteKeyEvent |
---|
刪除重要事件。
|
DeleteMeasurementProtocolSecret |
---|
會刪除目標 MeasurementProtocolSecret。
|
DeleteProperty |
---|
將目標屬性標示為已虛刪除 (例如「已移至垃圾桶」),並傳回該資源。 這個 API 沒有還原虛刪除屬性的方法。不過,如要還原這些郵件,請使用「垃圾桶」使用者介面。 如果在到期前未還原資源,資源和所有子項資源 (例如 GoogleAdsLinks、Streams、AccessBindings) 都會永久遭到清除。https://support.google.com/analytics/answer/6154772 如果找不到指定目標或非 GA4 資源,系統會傳回錯誤。
|
GetAccount |
---|
查詢單一帳戶。
|
GetConversionEvent |
---|
擷取單一轉換事件。
|
GetCustomDimension |
---|
查詢單一自訂維度。
|
GetCustomMetric |
---|
查詢單一自訂指標。
|
GetDataRetentionSettings |
---|
傳回這項資源的單例模式資料保留設定。
|
GetDataSharingSettings |
---|
取得帳戶的資料共用設定。資料共用設定為單例模式。
|
GetDataStream |
---|
查詢單一 DataStream。
|
GetKeyEvent |
---|
擷取單一重要事件。
|
GetMeasurementProtocolSecret |
---|
查詢單一「GA4」MeasurementProtocolSecret。
|
GetProperty |
---|
查詢單一「GA4」資源。
|
ListAccountSummaries |
---|
傳回呼叫者可存取的所有帳戶的摘要。
|
ListAccounts |
---|
傳回呼叫端可存取的所有帳戶。 請注意,這些帳戶目前可能還沒有 GA4 資源。系統會根據預設排除虛刪除 (即「移至垃圾桶」) 帳戶。如果找不到相關帳戶,則傳回空白清單。
|
ListConversionEvents |
---|
傳回指定父項資源中的轉換事件清單。 如果找不到轉換事件,系統會傳回空白清單。
|
ListCustomDimensions |
---|
列出資源上的 CustomDimensions。
|
ListCustomMetrics |
---|
可列出資源的自訂指標。
|
ListDataStreams |
---|
可列出屬性上的 DataStreams。
|
ListFirebaseLinks |
---|
可列出資源上的 FirebaseLinks。資源最多只能有一個 FirebaseLink。
|
ListGoogleAdsLinks |
---|
列出資源上的 Google AdsLinks。
|
ListKeyEvents |
---|
傳回指定父項屬性中的 Key Event 清單。如果找不到重要事件,則傳回空白清單。
|
ListMeasurementProtocolSecrets |
---|
傳回指定父項屬性下的子 MeasurementProtocolSecret。
|
ListProperties |
---|
傳回指定上層帳戶下的子資源。 系統只會傳回「GA4」資源。如果呼叫端沒有存取權,系統就會排除該屬性。系統預設會排除虛刪除 (例如「已丟棄」) 的屬性。如果找不到相關的屬性,則傳回空白清單。
|
ProvisionAccountTicket |
---|
申請建立帳戶的票證。
|
RunAccessReport |
---|
傳回資料存取記錄的自訂報表。每次使用者讀取 Google Analytics (分析) 報表資料時,這份報表都會列出記錄。存取記錄最多會保留 2 年。 可要求資源的資料存取報表。系統可能會要求任何資源的報表,但與配額無關的維度,就只能在 Google Analytics (分析) 360 資源中要求。這個方法僅供「管理員」使用。 這些資料存取記錄包括 GA4 UI 報表、GA4 UI 探索、GA4 Data API,以及可透過連結從 Google Analytics (分析) 擷取資料的其他產品 (如 Firebase 和 AdMob)。這些記錄不包含資源設定變更 (例如新增串流或變更資源時區),如需設定變更記錄,請參閱 searchChangeHistoryEvents。
|
SearchChangeHistoryEvents |
---|
依指定篩選器組合搜尋帳戶或其子項的所有變更。
|
UpdateAccount |
---|
更新帳戶。
|
UpdateConversionEvent |
---|
更新含有指定屬性的轉換事件。
|
UpdateCustomDimension |
---|
更新資源的自訂維度。
|
UpdateCustomMetric |
---|
更新屬性的自訂指標。
|
UpdateDataRetentionSettings |
---|
更新這項資源的單例模式資料保留設定。
|
UpdateDataStream |
---|
更新屬性的 DataStream。
|
UpdateGoogleAdsLink |
---|
更新資源的 GoogleAdsLink
|
UpdateKeyEvent |
---|
更新重要事件。
|
UpdateMeasurementProtocolSecret |
---|
更新 Measurement Protocol 密鑰。
|
UpdateProperty |
---|
更新屬性。
|
AccessBetweenFilter
表示結果必須介於兩個數字 (含) 之間。
欄位 | |
---|---|
from_value |
以這個數字開頭。 |
to_value |
結尾是這個號碼。 |
AccessDateRange
連續的日期範圍:startDate、startDate + 1、...、endDate。
欄位 | |
---|---|
start_date |
查詢中包含的開始日期,格式為 |
end_date |
查詢中包含的結束日期,格式為 |
AccessDimension
維度是資料的屬性。舉例來說,userEmail
維度代表存取報表資料的使用者電子郵件。報表回應中的維度值是字串。
欄位 | |
---|---|
dimension_name |
維度的 API 名稱。如需這個 API 支援的維度清單,請參閱資料存取架構。 維度會以 |
AccessDimensionHeader
說明報表中的維度欄。報表中要求的維度會在列和 DimensionsHeaders 中產生欄項目。不過,只在篩選器或運算式內使用的維度不會產生報表中的資料欄;也就是說,這些維度不會產生標題。
欄位 | |
---|---|
dimension_name |
維度的名稱,例如「userEmail」。 |
AccessDimensionValue
維度的值。
欄位 | |
---|---|
value |
維度值。舉例來說,這個值可能會是「國家/地區」維度的「法國」。 |
AccessFilter
篩選維度或指標值的運算式。
欄位 | |
---|---|
field_name |
維度名稱或指標名稱。 |
聯集欄位 one_filter 。為 Filter 指定一種類型的篩選器。one_filter 只能採用下列其中一種設定: |
|
string_filter |
字串相關篩選器。 |
in_list_filter |
清單值中的篩選器。 |
numeric_filter |
數字或日期值的篩選器。 |
between_filter |
兩個值的篩選器。 |
AccessFilterExpression
表示維度或指標篩選器。同一個運算式中的欄位必須全部是維度或所有指標。
欄位 | |
---|---|
聯集欄位 one_expression 。為 FilterExpression 指定一種類型的篩選器運算式。one_expression 只能採用下列其中一種設定: |
|
and_group |
and_group 中的每個 FilterExpressions 每個都具有 AND 關係。 |
or_group |
or_group 中的每一個 FilterExpressions 皆具有 OR 關係。 |
not_expression |
FilterExpression 並非「not_expression」。 |
access_filter |
原始篩選器。在相同的 FilterExpression 中,所有篩選器的欄位名稱都必須是維度或所有指標。 |
AccessFilterExpressionList
篩選運算式清單。
欄位 | |
---|---|
expressions[] |
篩選運算式清單。 |
AccessInListFilter
結果必須在字串值清單中。
欄位 | |
---|---|
values[] |
字串值清單。不得空白。 |
case_sensitive |
如果設為 true,字串值會區分大小寫。 |
AccessMetric
報表的量化衡量標準。舉例來說,accessCount
指標是資料存取記錄的總數。
欄位 | |
---|---|
metric_name |
指標的 API 名稱。如需這個 API 支援的指標清單,請參閱資料存取架構。 指標會以 |
AccessMetricHeader
說明報表中的指標欄。報表中要求的可見指標,會在列和 MetricHeaders 中產生欄項目。不過,僅用於篩選器或運算式的指標不會在報表中產生資料欄;也就是說,這些指標不會產生標頭。
欄位 | |
---|---|
metric_name |
指標的名稱,例如「accessCount」。 |
AccessMetricValue
指標的值。
欄位 | |
---|---|
value |
測量值。例如,這個值可以是「13」。 |
AccessNumericFilter
數值或日期值的篩選器。
欄位 | |
---|---|
operation |
此篩選器的作業類型。 |
value |
數值或日期值。 |
作業
套用至數字篩選器的作業。
列舉 | |
---|---|
OPERATION_UNSPECIFIED |
未指明 |
EQUAL |
等於 |
LESS_THAN |
小於 |
LESS_THAN_OR_EQUAL |
小於或等於 |
GREATER_THAN |
大於 |
GREATER_THAN_OR_EQUAL |
大於或等於 |
AccessOrderBy
排序依據可定義回應中資料列的排序方式。例如,依存取次數遞減排序資料列的順序是其中一種順序,而依國家/地區字串排序的資料列則是不同的順序。
欄位 | |
---|---|
desc |
如為 true,則以遞減方式排序。如為 false 或未指定,則以遞增方式排序。 |
聯集欄位 one_order_by 。針對 OrderBy 指定一種訂單類型。one_order_by 只能採用下列其中一種設定: |
|
metric |
按照指標值排序結果。 |
dimension |
依維度值排序結果。 |
DimensionOrderBy
依維度值排序。
欄位 | |
---|---|
dimension_name |
排序要求中的維度名稱。 |
order_type |
控管維度值排序的規則。 |
OrderType
字串維度值排序規則。
列舉 | |
---|---|
ORDER_TYPE_UNSPECIFIED |
未指明 |
ALPHANUMERIC |
按萬國碼 (Unicode) 碼點排序的英數字元排序。例如「2」< "A" < "X" < "b" < "z"。 |
CASE_INSENSITIVE_ALPHANUMERIC |
不區分大小寫的英數字元排序,按照小寫的萬國碼 (Unicode) 碼點排序。例如「2」< "A" < "b" < "X" < "z"。 |
NUMERIC |
維度值會先轉換為數字,再排序。例如,以 NUMERIC 排序時,「25」< "100",而 ALPHANUMERIC 排序時,則傳回「100」< "25"。非數字維度值,排序值一律低於所有數值。 |
MetricOrderBy
依指標值排序。
欄位 | |
---|---|
metric_name |
要排序要求中的指標名稱。 |
AccessQuota
這項 Analytics (分析) 資源所有配額目前的狀態。如果資源的任何配額已用盡,則該資源的所有要求都會傳回「資源用盡」錯誤。
欄位 | |
---|---|
tokens_per_day |
資源每天可使用 25 萬個權杖。大多數要求使用的符記數量不到 10 個。 |
tokens_per_hour |
屬性每小時可使用 50,000 個符記。API 要求只會使用一組符記,該數字會從所有每小時、每日和每項專案的每小時配額中扣除。 |
concurrent_requests |
屬性最多可以使用 50 項並行要求。 |
server_errors_per_project_per_hour |
屬性和雲端專案組合每小時最多可有 50 個伺服器錯誤。 |
tokens_per_project_per_hour |
每項專案每小時最多可以使用 25% 的權杖。因此,對 Analytics (分析) 360 資源而言,每個專案每小時都可使用 12,500 個符記。API 要求只會使用一組符記,該數字會從所有每小時、每日和每項專案的每小時配額中扣除。 |
AccessQuotaStatus
特定配額群組的目前狀態。
欄位 | |
---|---|
consumed |
此要求耗用的配額。 |
remaining |
提出這項要求後的剩餘配額。 |
AccessRow
存取每一列的報表資料。
欄位 | |
---|---|
dimension_values[] |
維度值清單。這些值的順序與要求中指定的順序相同。 |
metric_values[] |
指標值清單。這些值的順序與要求中指定的順序相同。 |
AccessStringFilter
字串篩選器。
欄位 | |
---|---|
match_type |
此篩選器的比對類型。 |
value |
用於比對的字串值。 |
case_sensitive |
如果設為 true,字串值會區分大小寫。 |
MatchType
字串篩選器的比對類型。
列舉 | |
---|---|
MATCH_TYPE_UNSPECIFIED |
未指定 |
EXACT |
完全符合字串值。 |
BEGINS_WITH |
以字串值開頭。 |
ENDS_WITH |
以字串值結尾。 |
CONTAINS |
包含字串值。 |
FULL_REGEXP |
與含字串值的規則運算式完全相符。 |
PARTIAL_REGEXP |
對含字串值的規則運算式進行部分比對。 |
帳戶
代表 Google Analytics (分析) 帳戶的資源訊息。
欄位 | |
---|---|
name |
僅供輸出。此帳戶的資源名稱。格式:accounts/{account} 範例:「accounts/100」 |
create_time |
僅供輸出。這個帳戶的最初建立時間。 |
update_time |
僅供輸出。帳戶酬載欄位的上次更新時間。 |
display_name |
必要欄位。這個帳戶的顯示名稱。 |
region_code |
商家所在國家/地區。必須是 Unicode CLDR 區碼。 |
deleted |
僅供輸出。指出這個帳戶是否已虛刪除。除非明確要求,否則刪除的帳戶不會從 [清單] 結果中排除。 |
gmp_organization |
僅供輸出。Google Marketing Platform 機構組織資源的 URI。只有在這個帳戶連結到 GMP 機構組織時才需要設定。格式:marketingplatformadmin.googleapis.com/organizations/{org_id} |
AccountSummary
虛擬資源,用於代表帳戶及其所有子項 GA4 資源。
欄位 | |
---|---|
name |
此帳戶摘要的資源名稱。格式:accountSummaries/{account_id} 範例:「accountSummaries/1000」 |
account |
這個帳戶摘要參照的帳戶資源名稱。格式:accounts/{account_id},範例:「accounts/1000」 |
display_name |
此帳戶摘要中所參照帳戶的顯示名稱。 |
property_summaries[] |
此帳戶的子帳戶摘要清單。 |
AcknowledgeUserDataCollectionRequest
AcknowledgeUserDataCollection RPC 的要求訊息。
欄位 | |
---|---|
property |
必要欄位。用來確認使用者資料收集作業的資源。 |
acknowledgement |
必要欄位。這個方法的呼叫端瞭解使用者資料收集相關條款。 這個欄位必須包含確切的值:「我確認,我已針對收集和處理使用者資料作業提供必要的隱私權揭露聲明並取得使用者授權,這類資料也包括使用者資料與 Google Analytics (分析) 從我的網站和/或應用程式資源收集到的造訪資訊所建立的關聯資料。」 |
AcknowledgeUserDataCollectionResponse
這個類型沒有任何欄位。
AcknowledgeUserDataCollection RPC 的回應訊息。
ActionType
可變更資源的動作類型。
列舉 | |
---|---|
ACTION_TYPE_UNSPECIFIED |
不明或未指定動作類型。 |
CREATED |
已在這項變更中建立資源。 |
UPDATED |
已在這項變更中更新資源。 |
DELETED |
資源已在這項變更中刪除。 |
ActorType
能對 Google Analytics (分析) 資源進行變更的不同發動者。
列舉 | |
---|---|
ACTOR_TYPE_UNSPECIFIED |
不明或未指定的演員類型。 |
USER |
使用者在 actor_email 中指定的使用者所做的變更。 |
SYSTEM |
由 Google Analytics (分析) 系統所做的變更。 |
SUPPORT |
Google Analytics (分析) 支援團隊成員所做的變更。 |
ArchiveCustomDimensionRequest
ArchiveCustomDimensions RPC 的要求訊息。
欄位 | |
---|---|
name |
必要欄位。要封存的自訂維度名稱。格式範例:properties/1234/customDimensions/5678 |
ArchiveCustomMetricRequest
ArchiveCustomMetric RPC 的要求訊息。
欄位 | |
---|---|
name |
必要欄位。要封存的自訂指標名稱。格式範例:properties/1234/customMetrics/5678 |
ChangeHistoryChange
單一 Google Analytics (分析) 資源的變更說明。
欄位 | |
---|---|
resource |
此項目說明其變更的資源資源名稱。 |
action |
變更這項資源的動作類型。 |
resource_before_change |
變更前的資源內容。如果這項資源是在這項變更中建立,這個欄位將不會出現。 |
resource_after_change |
變更後的資源內容。如果這項資源在這項變更中遭到刪除,這個欄位就會遺漏。 |
ChangeHistoryResource
變更記錄異動結果前後的資源快照。
欄位 | |
---|---|
聯集欄位
|
|
account |
變更記錄中的帳戶資源數據匯報。 |
property |
變更記錄中資源資源的數據匯報。 |
firebase_link |
變更記錄中的 FirebaseLink 資源數據匯報。 |
google_ads_link |
變更記錄中的 GoogleAdsLink 資源數據匯報。 |
conversion_event |
變更記錄中的 ConversionEvent 資源數據匯報。 |
measurement_protocol_secret |
變更記錄中的 MeasurementProtocolSecret 資源快照。 |
data_retention_settings |
變更記錄中的資料保留設定資源的數據匯報。 |
data_stream |
變更記錄中的 DataStream 資源數據匯報。 |
ChangeHistoryEvent
造成相同原因的 Google Analytics (分析) 帳戶或其子資源中的一組變更。常見的原因包括在 Google Analytics (分析) 使用者介面中更新、客戶支援服務異動,或是 Google Analytics (分析) 系統自動變更。
欄位 | |
---|---|
id |
此變更記錄事件的 ID。這個 ID 在 Google Analytics (分析) 中不會重複。 |
change_time |
變更時間。 |
actor_type |
做出此變更的執行者類型。 |
user_actor_email |
進行變更的 Google 帳戶電子郵件地址。如果執行者欄位設為 USER,這個有效的電子郵件地址;如果不是,這會空白。已刪除的 Google 帳戶會導致錯誤。 |
changes_filtered |
若為 true,則傳回的變更清單會遭到篩除,不代表此事件中發生的所有變更。 |
changes[] |
根據 SearchChangeHistoryEventsRequest 指定的篩選器,在這個變更記錄事件中做出的變更清單。 |
ChangeHistoryResourceType
可從變更記錄傳回其變更的資源類型。
列舉 | |
---|---|
CHANGE_HISTORY_RESOURCE_TYPE_UNSPECIFIED |
資源類型不明或未指定。 |
ACCOUNT |
帳戶資源 |
PROPERTY |
資源資源 |
FIREBASE_LINK |
FirebaseLink 資源 |
GOOGLE_ADS_LINK |
GoogleAdsLink 資源 |
GOOGLE_SIGNALS_SETTINGS |
GoogleSignalsSettings 資源 |
CONVERSION_EVENT |
ConversionEvent 資源 |
MEASUREMENT_PROTOCOL_SECRET |
MeasurementProtocolSecret 資源 |
DATA_RETENTION_SETTINGS |
DatareservationSettings 資源 |
DISPLAY_VIDEO_360_ADVERTISER_LINK |
DisplayVideo360AdvertiserLink 資源 |
DISPLAY_VIDEO_360_ADVERTISER_LINK_PROPOSAL |
DisplayVideo360AdvertiserLinkProposal 資源 |
DATA_STREAM |
DataStream 資源 |
ATTRIBUTION_SETTINGS |
AttributionSettings 資源 |
ConversionEvent
Google Analytics (分析) 資源中的轉換事件。
欄位 | |
---|---|
name |
僅供輸出。這個轉換事件的資源名稱。格式:property/{property}/conversionEvents/{conversion_event} |
event_name |
不可變動。這個轉換事件的事件名稱。例如:「點擊」、「購買」 |
create_time |
僅供輸出。在資源中建立這個轉換事件的時間。 |
deletable |
僅供輸出。設定後,目前只能使用 DeleteConversionEvent 刪除這個事件。 |
custom |
僅供輸出。如果設為 True,這個轉換事件就會參照自訂事件。如果設為 False,這個轉換事件會在 Google Analytics (分析) 中代表預設事件。預設事件在 Google Analytics (分析) 中通常具有特殊意義。預設事件通常是由 Google Analytics (分析) 系統建立,但在某些情況下,資源管理員可以建立預設事件。自訂事件會計入每個資源可建立的自訂轉換事件數量上限。 |
counting_method |
選用設定。計算工作階段中多個事件時,計算轉換的方法。如未提供這個值,系統會設為 |
default_conversion_value |
選用設定。定義轉換事件的預設價值/貨幣。 |
ConversionCountingMethod
計算工作階段中多個事件時,計算轉換的方法。
列舉 | |
---|---|
CONVERSION_COUNTING_METHOD_UNSPECIFIED |
未指定計數方法。 |
ONCE_PER_EVENT |
每個事件事件都視為一次轉換。 |
ONCE_PER_SESSION |
在每位使用者的每個工作階段中,事件例項最多只會視為一次轉換。 |
DefaultConversionValue
定義轉換事件的預設價值/貨幣。您必須提供金額和幣別。
欄位 | |
---|---|
value |
系統會使用這個值,為指定的 event_name 填入值 (未設定事件「value」參數)。 |
currency_code |
如果這個 event_name 的轉換事件尚未設定貨幣,系統將套用這個幣別做為預設幣別。必須採用 ISO 4217 貨幣代碼格式,詳情請參閱 https://en.wikipedia.org/wiki/ISO_4217。 |
CreateConversionEventRequest
CreateConversionEvent RPC 的要求訊息
欄位 | |
---|---|
conversion_event |
必要欄位。要建立的轉換事件。 |
parent |
必要欄位。要建立這個轉換事件的父項資源的資源名稱。格式:properties/123 |
CreateCustomDimensionRequest
CreateCustomDimensions RPC 的要求訊息。
欄位 | |
---|---|
parent |
必要欄位。格式範例:properties/1234 |
custom_dimension |
必要欄位。要建立的自訂維度。 |
CreateCustomMetricRequest
CreateCustomMetric RPC 的要求訊息。
欄位 | |
---|---|
parent |
必要欄位。格式範例:properties/1234 |
custom_metric |
必要欄位。要建立的自訂指標。 |
CreateDataStreamRequest
CreateDataStream RPC 的要求訊息。
欄位 | |
---|---|
parent |
必要欄位。格式範例:properties/1234 |
data_stream |
必要欄位。要建立的 DataStream。 |
CreateFirebaseLinkRequest
CreateFirebaseLink RPC 的要求訊息
欄位 | |
---|---|
parent |
必要欄位。格式:properties/{property_id} 範例:properties/1234 |
firebase_link |
必要欄位。要建立的 Firebase 連結。 |
CreateGoogleAdsLinkRequest
CreateGoogleAdsLink RPC 請求訊息
欄位 | |
---|---|
parent |
必要欄位。格式範例:properties/1234 |
google_ads_link |
必要欄位。要建立的 Google AdsLink。 |
CreateKeyEventRequest
CreateKeyEvent RPC 的要求訊息
欄位 | |
---|---|
key_event |
必要欄位。要建立的重要事件。 |
parent |
必要欄位。要建立這個重要事件的父項資源的資源名稱。格式:properties/123 |
CreateMeasurementProtocolSecretRequest
CreateMeasurementProtocolSecret RPC 的要求訊息
欄位 | |
---|---|
parent |
必要欄位。要建立這個密鑰的父項資源。格式:properties/{property}/dataStreams/{dataStream} |
measurement_protocol_secret |
必要欄位。要建立的 Measurement Protocol 密鑰。 |
CreatePropertyRequest
CreateProperty RPC 的要求訊息。
欄位 | |
---|---|
property |
必要欄位。要建立的屬性。注意:提供的屬性必須指定其父項。 |
CustomDimension
自訂維度的定義。
欄位 | |
---|---|
name |
僅供輸出。這項自訂維度資源的資源名稱。格式:properties/{property}/customDimensions/{customDimension} |
parameter_name |
必要欄位。不可變動。這個自訂維度的代碼參數名稱。 如果是以使用者為範圍的維度,這會是使用者屬性名稱。如果這是以事件為範圍的維度,則會是事件參數名稱。 如果是以商品為範圍的維度,這就是電子商務項目陣列中的參數名稱。 只能使用英數字元和底線字元,開頭須為英文字母。以使用者為範圍的維度長度上限為 24 個字元;以事件為範圍的維度長度上限為 40 個字元。 |
display_name |
必要欄位。此自訂維度的顯示名稱 (如 Analytics (分析) 使用者介面所示)。長度上限為 82 個英數字元、空格和底線,且開頭須為英文字母。舊版系統產生的顯示名稱可包含方括號,但這個欄位的更新內容一律不允許使用方括號。 |
description |
選用設定。這個自訂維度的說明。長度上限為 150 個半形字元。 |
scope |
必要欄位。不可變動。這個維度的範圍。 |
disallow_ads_personalization |
選用設定。如果設為 True,請將這個維度設為非個人化廣告,並從廣告個人化中排除。 目前只有以使用者為範圍的自訂維度支援這項功能。 |
DimensionScope
這個維度範圍的有效值。
列舉 | |
---|---|
DIMENSION_SCOPE_UNSPECIFIED |
範圍不明或未指定。 |
EVENT |
範圍限定為事件的維度。 |
USER |
維度範圍僅限使用者。 |
ITEM |
範圍僅限電子商務項目的維度 |
CustomMetric
自訂指標的定義。
欄位 | |
---|---|
name |
僅供輸出。這項自訂指標資源的資源名稱。格式:properties/{property}/customMetrics/{customMetric} |
parameter_name |
必要欄位。不可變動。此自訂指標的標記名稱。 如果這是以事件為範圍的指標,這就是事件參數名稱。 只能使用英數字元和底線字元,開頭須為英文字母。以事件為範圍的指標長度上限為 40 個半形字元。 |
display_name |
必要欄位。這項自訂指標的顯示名稱,如 Analytics (分析) UI 中所示。長度上限為 82 個英數字元、空格和底線,且開頭須為英文字母。舊版系統產生的顯示名稱可包含方括號,但這個欄位的更新內容一律不允許使用方括號。 |
description |
選用設定。這個自訂維度的說明。長度上限為 150 個半形字元。 |
measurement_unit |
必要欄位。自訂指標值的類型。 |
scope |
必要欄位。不可變動。這個自訂指標的範圍。 |
restricted_metric_type[] |
選用設定。這項指標可能包含的受限資料類型。如為採用 CURRENCY 測量單位的指標,則為必填。如果指標不是 CURRENCY 測量單位,則必須留空。 |
MeasurementUnit
代表自訂指標值的可能類型。
貨幣表示法日後可能會變更,因此必須進行破壞性 API 變更。
列舉 | |
---|---|
MEASUREMENT_UNIT_UNSPECIFIED |
未指定或缺少 MeasurementUnit。 |
STANDARD |
這項指標使用預設單位。 |
CURRENCY |
這項指標是用於評估貨幣。 |
FEET |
這項指標會測量英尺。 |
METERS |
這項指標會測量公尺。 |
KILOMETERS |
這項指標會測量公里數。 |
MILES |
這項指標會測量英里數。 |
MILLISECONDS |
這項指標測量的是毫秒。 |
SECONDS |
這個指標代表秒。 |
MINUTES |
這項指標會測量分鐘數。 |
HOURS |
這項指標會測量小時數。 |
MetricScope
這項指標的範圍。
列舉 | |
---|---|
METRIC_SCOPE_UNSPECIFIED |
範圍不明或未指定。 |
EVENT |
指標範圍為事件。 |
RestrictedMetricType
將這項自訂指標中的資料標示為資料標籤,僅開放特定使用者存取。
列舉 | |
---|---|
RESTRICTED_METRIC_TYPE_UNSPECIFIED |
類型不明或未指定。 |
COST_DATA |
「指標」會回報費用資料。 |
REVENUE_DATA |
「指標」會回報收益資料, |
DataRetentionSettings
資料保留的設定值。這是單例模式資源。
欄位 | |
---|---|
name |
僅供輸出。這項 DatareservationSetting 資源的資源名稱。格式:property/{property}/datareservationSettings |
event_data_retention |
事件層級資料保留的時間長度。 |
reset_user_data_on_new_activity |
如果設為「true」,系統會重設該使用者每個事件的使用者 ID 保留期限。 |
RetentionDuration
資料保留時間的有效值。
列舉 | |
---|---|
RETENTION_DURATION_UNSPECIFIED |
未指定資料保留時間長度。 |
TWO_MONTHS |
資料保留時間長度為 2 個月。 |
FOURTEEN_MONTHS |
資料保留時間為 14 個月。 |
TWENTY_SIX_MONTHS |
資料保留時間為 26 個月。僅適用於 360 資源。 |
THIRTY_EIGHT_MONTHS |
資料保留時間長度為 38 個月。僅適用於 360 資源。 |
FIFTY_MONTHS |
資料保留時間為 50 個月。僅適用於 360 資源。 |
DataSharingSettings
代表 Google Analytics (分析) 帳戶資料共用設定的資源訊息。
欄位 | |
---|---|
name |
僅供輸出。資源名稱。格式:accounts/{account}/dataSharingSettings 範例:「accounts/1000/dataSharingSettings」 |
sharing_with_google_support_enabled |
允許 Google 支援團隊存取資料,以便協助排解問題。 |
sharing_with_google_assigned_sales_enabled |
允許指派給客戶的 Google 銷售團隊存取資料,以便提供設定變更建議,以改善結果。啟用後,銷售團隊限制仍然適用。 |
sharing_with_google_any_sales_enabled |
允許所有 Google 銷售代表存取資料,以便提供設定變更建議,以改善結果。 |
sharing_with_google_products_enabled |
允許 Google 運用這些資料改善其他 Google 產品或服務。 |
sharing_with_others_enabled |
允許 Google 以匿名方式與他人分享資料。 |
DataStream
代表資料串流的資源訊息。
欄位 | |
---|---|
name |
僅供輸出。這個資料串流的資源名稱。格式:properties/{property_id}/dataStreams/{stream_id},範例:「properties/1000/dataStreams/2000」 |
type |
必要欄位。不可變動。這個 DataStream 資源的類型。 |
display_name |
使用者可理解的資料串流顯示名稱。 必須用於網站資料串流。 顯示名稱的長度上限為 255 個 UTF-16 代碼單位。 |
create_time |
僅供輸出。這個串流的原始建立時間。 |
update_time |
僅供輸出。串流酬載欄位上次更新的時間。 |
聯集欄位 stream_data 。特定資料串流類型的資料。要設定的訊息會與這個串流的類型對應。stream_data 只能是下列其中一項: |
|
web_stream_data |
網頁串流專屬資料。如果類型為 WEB_DATA_STREAM,則必須填入。 |
android_app_stream_data |
Android 應用程式串流專屬的資料。如果類型為 ANDROID_APP_DATA_STREAM,就必須填入資料。 |
ios_app_stream_data |
iOS 應用程式串流專屬的資料。如果類型為 IOS_APP_DATA_STREAM,則必須填入。 |
AndroidAppStreamData
Android 應用程式串流專屬的資料。
欄位 | |
---|---|
firebase_app_id |
僅供輸出。Firebase 中相應 Android 應用程式的 ID (如果有的話)。如果 Android 應用程式遭到刪除並重新建立,這組 ID 可能會改變。 |
package_name |
不可變動。受評估應用程式的套件名稱。例如:「com.example.myandroidapp」 |
DataStreamType
資料串流的類型。
列舉 | |
---|---|
DATA_STREAM_TYPE_UNSPECIFIED |
類型不明或未指定。 |
WEB_DATA_STREAM |
網站資料串流。 |
ANDROID_APP_DATA_STREAM |
Android 應用程式資料串流。 |
IOS_APP_DATA_STREAM |
iOS 應用程式資料串流。 |
IosAppStreamData
iOS 應用程式串流專屬的資料。
欄位 | |
---|---|
firebase_app_id |
僅供輸出。Firebase 中相應 iOS 應用程式的 ID (如果有的話)。如果 iOS 應用程式遭到刪除並重新建立,這組 ID 可能會改變。 |
bundle_id |
必要欄位。不可變動。應用程式的 Apple App Store 套件 ID,例如:「com.example.myiosapp」 |
WebStreamData
網頁串流專屬資料。
欄位 | |
---|---|
measurement_id |
僅供輸出。Analytics (分析) 評估 ID。 例如:「G-1A2BCD345E」 |
firebase_app_id |
僅供輸出。Firebase 中相應網頁應用程式的 ID (如果有的話)。如果刪除並重新建立網頁應用程式,這個 ID 可能會改變。 |
default_uri |
受評估網頁應用程式的網域名稱,或空白。例如:「http://www.google.com」、「https://www.google.com」 |
DeleteAccountRequest
DeleteAccount RPC 的要求訊息。
欄位 | |
---|---|
name |
必要欄位。要虛刪除的帳戶名稱。格式:accounts/{account} 範例:「accounts/100」 |
DeleteConversionEventRequest
DeleteConversionEvent RPC 的要求訊息
欄位 | |
---|---|
name |
必要欄位。要刪除的轉換事件資源名稱。格式:properties/{property}/conversionEvents/{conversion_event} 範例:「properties/123/conversionEvents/456」 |
DeleteDataStreamRequest
DeleteDataStream RPC 的要求訊息。
欄位 | |
---|---|
name |
必要欄位。要刪除的 DataStream 名稱。格式範例:properties/1234/dataStreams/5678 |
DeleteFirebaseLinkRequest
DeleteFirebaseLink RPC 的要求訊息
欄位 | |
---|---|
name |
必要欄位。格式:properties/{property_id}/firebaseLinks/{firebase_link_id},範例:properties/1234/firebaseLinks/5678 |
DeleteGoogleAdsLinkRequest
DeleteGoogleAdsLink RPC 的要求訊息。
欄位 | |
---|---|
name |
必要欄位。格式範例:properties/1234/googleAdsLinks/5678 |
DeleteKeyEventRequest
DeleteKeyEvent RPC 的要求訊息
欄位 | |
---|---|
name |
必要欄位。要刪除的重要事件資源名稱。格式:properties/{property}/keyEvents/{key_event} 範例:「properties/123/keyEvents/456」 |
DeleteMeasurementProtocolSecretRequest
DeleteMeasurementProtocolSecret RPC 的要求訊息
欄位 | |
---|---|
name |
必要欄位。要刪除的 MeasurementProtocolSecret 名稱。格式:properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret} |
DeletePropertyRequest
DeleteProperty RPC 的要求訊息。
欄位 | |
---|---|
name |
必要欄位。要虛刪除的屬性名稱。格式:properties/{property_id},範例:「properties/1000」 |
FirebaseLink
GA4 資源與 Firebase 專案之間的連結。
欄位 | |
---|---|
name |
僅供輸出。格式範例:properties/1234/firebaseLinks/5678 |
project |
不可變動。Firebase 專案資源名稱。建立 FirebaseLink 時,可以使用專案編號或專案 ID 提供這個資源名稱。建立這項資源後,傳回的 FirebaseLinks 一律會有包含專案編號的 project_name。 格式:「projects/{project number}」,範例:「projects/1234」 |
create_time |
僅供輸出。這個 FirebaseLink 的最初建立時間。 |
GetAccountRequest
GetAccount RPC 的要求訊息。
欄位 | |
---|---|
name |
必要欄位。要查詢的帳戶名稱。格式:accounts/{account} 範例:「accounts/100」 |
GetConversionEventRequest
GetConversionEvent RPC 的要求訊息
欄位 | |
---|---|
name |
必要欄位。要擷取的轉換事件資源名稱。格式:properties/{property}/conversionEvents/{conversion_event} 範例:「properties/123/conversionEvents/456」 |
GetCustomDimensionRequest
GetCustomDimensions RPC 的要求訊息。
欄位 | |
---|---|
name |
必要欄位。要取得的自訂維度名稱。格式範例:properties/1234/customDimensions/5678 |
GetCustomMetricRequest
GetCustomMetric RPC 的要求訊息。
欄位 | |
---|---|
name |
必要欄位。要取得的自訂指標名稱。格式範例:properties/1234/customMetrics/5678 |
GetDataRetentionSettingsRequest
GetDatakeepSettings RPC 的要求訊息。
欄位 | |
---|---|
name |
必要欄位。要查詢的設定名稱。格式:properties/{property}/dataRekeepSettings 範例:「properties/1000/data 資料保留設定」 |
GetDataSharingSettingsRequest
GetData 共享 Settings RPC 的要求訊息。
欄位 | |
---|---|
name |
必要欄位。要查詢的設定名稱。格式:accounts/{account}/dataSharingSettings 範例:「accounts/1000/dataSharingSettings」 |
GetDataStreamRequest
GetDataStream RPC 的要求訊息。
欄位 | |
---|---|
name |
必要欄位。要取得的 DataStream 名稱。格式範例:properties/1234/dataStreams/5678 |
GetKeyEventRequest
GetKeyEvent RPC 的要求訊息
欄位 | |
---|---|
name |
必要欄位。要擷取的重要事件資源名稱。格式:properties/{property}/keyEvents/{key_event} 範例:「properties/123/keyEvents/456」 |
GetMeasurementProtocolSecretRequest
GetMeasurementProtocolSecret RPC 的要求訊息。
欄位 | |
---|---|
name |
必要欄位。要查詢的 Measurement Protocol 密鑰名稱。格式:properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret} |
GetPropertyRequest
GetProperty RPC 的要求訊息。
欄位 | |
---|---|
name |
必要欄位。要查詢的屬性名稱。格式:properties/{property_id},範例:「properties/1000」 |
GoogleAdsLink
GA4 資源與 Google Ads 帳戶之間的連結。
欄位 | |
---|---|
name |
僅供輸出。格式:properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} 注意:googleAdsLinkId 不是 Google Ads 客戶 ID。 |
customer_id |
不可變動。Google Ads 客戶 ID。 |
can_manage_clients |
僅供輸出。若為 true,此連結適用於 Google Ads 管理員帳戶。 |
ads_personalization_enabled |
在這次整合中啟用個人化廣告功能。自動向已連結的 Google Ads 帳戶發布我的 Google Analytics (分析) 目標對象名單和 Google Analytics (分析) 再行銷事件/參數。如未在建立/更新時設定這個欄位,系統會將其預設為 true。 |
create_time |
僅供輸出。最初建立連結的時間。 |
update_time |
僅供輸出。上次更新這個連結的時間。 |
creator_email_address |
僅供輸出。建立連結的使用者的電子郵件地址。如果無法擷取電子郵件地址,系統會傳回空字串。 |
IndustryCategory
針對此資源所選的類別,用於業界基準。
列舉 | |
---|---|
INDUSTRY_CATEGORY_UNSPECIFIED |
未指定產業類別 |
AUTOMOTIVE |
汽車業 |
BUSINESS_AND_INDUSTRIAL_MARKETS |
商業及工業市場 |
FINANCE |
財經 |
HEALTHCARE |
醫療照護業 |
TECHNOLOGY |
科技業 |
TRAVEL |
旅遊 |
OTHER |
其他 |
ARTS_AND_ENTERTAINMENT |
藝術與娛樂 |
BEAUTY_AND_FITNESS |
美容與健身 |
BOOKS_AND_LITERATURE |
圖書與文學 |
FOOD_AND_DRINK |
餐飲 |
GAMES |
遊戲 |
HOBBIES_AND_LEISURE |
興趣與休閒 |
HOME_AND_GARDEN |
家居與園藝 |
INTERNET_AND_TELECOM |
網際網路與電信 |
LAW_AND_GOVERNMENT |
法律與政府 |
NEWS |
新聞 |
ONLINE_COMMUNITIES |
網路社群 |
PEOPLE_AND_SOCIETY |
人文與社會 |
PETS_AND_ANIMALS |
寵物與動物 |
REAL_ESTATE |
房地產 |
REFERENCE |
參考資料 |
SCIENCE |
科學 |
SPORTS |
體育 |
JOBS_AND_EDUCATION |
職業和教育 |
SHOPPING |
購物廣告活動 |
KeyEvent
Google Analytics (分析) 資源中的重要事件。
欄位 | |
---|---|
name |
僅供輸出。此重要事件的資源名稱。格式:properties/{property}/keyEvents/{key_event} |
event_name |
不可變動。這個重要事件的事件名稱。例如:「點擊」、「購買」 |
create_time |
僅供輸出。在資源中建立此重要事件的時間。 |
deletable |
僅供輸出。如果設為 True,就可以刪除這個事件。 |
custom |
僅供輸出。如果設為 True,這個重要事件就會參照自訂事件。如果設為 False,這個重要事件會在 Google Analytics (分析) 中代表預設事件。預設事件在 Google Analytics (分析) 中通常具有特殊意義。預設事件通常是由 Google Analytics (分析) 系統建立,但在某些情況下,資源管理員可以建立預設事件。自訂事件會計入每個資源可建立的自訂重要事件數量上限。 |
counting_method |
必要欄位。指定重要事件在工作階段內為多個事件計算的方法。 |
default_value |
選用設定。定義重要事件的預設值/貨幣。 |
CountingMethod
指定重要事件在工作階段內為多個事件計算的方法。
列舉 | |
---|---|
COUNTING_METHOD_UNSPECIFIED |
未指定計數方法。 |
ONCE_PER_EVENT |
每個事件例項都視為一個重要事件。 |
ONCE_PER_SESSION |
在每個工作階段中,「事件」例項最多只會視為重要事件一次。 |
DefaultValue
定義重要事件的預設值/貨幣。
欄位 | |
---|---|
numeric_value |
必要欄位。系統就會在未設定參數 (由 event_name 指定) 的所有重要事件中填入「value」參數。 |
currency_code |
必要欄位。如果出現這個重要事件 (由 event_name 指定) 尚未設定的貨幣,系統將套用這個幣別做為預設值。必須採用 ISO 4217 貨幣代碼格式, |
ListAccountSummariesRequest
ListAccountSummaries RPC 的要求訊息。
欄位 | |
---|---|
page_size |
要傳回的 AccountSummary 資源數量上限。服務傳回的網頁可能會少於這個值,即使還有其他網頁也一樣。如未指定,最多將傳回 50 個資源。最大值為 200 (系統會將較高的值強制轉換為最大值) |
page_token |
屬於接收自前一個 |
ListAccountSummariesResponse
ListAccountSummaries RPC 的回應訊息。
欄位 | |
---|---|
account_summaries[] |
來電者可存取的所有帳戶的帳戶摘要。 |
next_page_token |
可做為 |
ListAccountsRequest
ListAccounts RPC 的要求訊息。
欄位 | |
---|---|
page_size |
要傳回的資源數量上限。服務傳回的網頁可能會少於這個值,即使還有其他網頁也一樣。如未指定,最多將傳回 50 個資源。最大值為 200 (系統會將較高的值強制轉換為最大值) |
page_token |
屬於接收自前一個 |
show_deleted |
是否要在搜尋結果中納入已虛刪除 (例如「垃圾桶」) 帳戶。您可以檢查帳戶,以判斷帳戶是否已刪除。 |
ListAccountsResponse
ListAccounts RPC 的要求訊息。
欄位 | |
---|---|
accounts[] |
呼叫者可存取的結果。 |
next_page_token |
可做為 |
ListConversionEventsRequest
ListConversionEvents RPC 的要求訊息
欄位 | |
---|---|
parent |
必要欄位。父項屬性的資源名稱。例如:「properties/123」 |
page_size |
要傳回的資源數量上限。如未指定,最多將傳回 50 個資源。最大值為 200 (系統會將較高的值強制轉換為最大值) |
page_token |
屬於接收自前一個 |
ListConversionEventsResponse
ListConversionEvents RPC 的回應訊息。
欄位 | |
---|---|
conversion_events[] |
要求的轉換事件 |
next_page_token |
可做為 |
ListCustomDimensionsRequest
ListCustomDimensions RPC 的要求訊息。
欄位 | |
---|---|
parent |
必要欄位。格式範例:properties/1234 |
page_size |
要傳回的資源數量上限。如未指定,最多將傳回 50 個資源。許可的最大值為 200 (上限值將強制轉換成最大值)。 |
page_token |
屬於接收自前一個 進行分頁時,提供至 |
ListCustomDimensionsResponse
ListCustomDimensions RPC 的回應訊息。
欄位 | |
---|---|
custom_dimensions[] |
自訂維度清單。 |
next_page_token |
可做為 |
ListCustomMetricsRequest
ListCustomMetrics RPC 的要求訊息。
欄位 | |
---|---|
parent |
必要欄位。格式範例:properties/1234 |
page_size |
要傳回的資源數量上限。如未指定,最多將傳回 50 個資源。許可的最大值為 200 (上限值將強制轉換成最大值)。 |
page_token |
屬於接收自前一個 進行分頁時,提供至 |
ListCustomMetricsResponse
ListCustomMetrics RPC 的回應訊息。
欄位 | |
---|---|
custom_metrics[] |
自訂指標清單。 |
next_page_token |
可做為 |
ListDataStreamsRequest
ListDataStreams RPC 的要求訊息。
欄位 | |
---|---|
parent |
必要欄位。格式範例:properties/1234 |
page_size |
要傳回的資源數量上限。如未指定,最多將傳回 50 個資源。許可的最大值為 200 (上限值將強制轉換成最大值)。 |
page_token |
屬於接收自前一個 進行分頁時,提供至 |
ListDataStreamsResponse
ListDataStreams RPC 的回應訊息。
欄位 | |
---|---|
data_streams[] |
DataStreams 清單。 |
next_page_token |
可做為 |
ListFirebaseLinksRequest
ListFirebaseLinks RPC 的要求訊息
欄位 | |
---|---|
parent |
必要欄位。格式:properties/{property_id} 範例:properties/1234 |
page_size |
要傳回的資源數量上限。服務傳回的網頁可能會少於這個值,即使還有其他網頁也一樣。如未指定,最多將傳回 50 個資源。最大值為 200 (系統會將較高的值強制轉換為最大值) |
page_token |
屬於接收自前一個 |
ListFirebaseLinksResponse
ListFirebaseLinks RPC 的回應訊息
欄位 | |
---|---|
firebase_links[] |
FirebaseLinks 清單。最多只有一個值。 |
next_page_token |
可做為 |
ListGoogleAdsLinksRequest
ListGoogleAdsLinks RPC 的要求訊息。
欄位 | |
---|---|
parent |
必要欄位。格式範例:properties/1234 |
page_size |
要傳回的資源數量上限。如未指定,最多將傳回 50 個資源。許可的最大值為 200 (上限值將強制轉換成最大值)。 |
page_token |
屬於接收自前一個 進行分頁時,提供至 |
ListGoogleAdsLinksResponse
ListGoogleAdsLinks RPC 的回應訊息。
欄位 | |
---|---|
google_ads_links[] |
Google AdsLinks 清單。 |
next_page_token |
可做為 |
ListKeyEventsRequest
ListKeyEvents RPC 的要求訊息
欄位 | |
---|---|
parent |
必要欄位。父項屬性的資源名稱。例如:「properties/123」 |
page_size |
要傳回的資源數量上限。如未指定,最多將傳回 50 個資源。最大值為 200 (系統會將較高的值強制轉換為最大值) |
page_token |
屬於接收自前一個 |
ListKeyEventsResponse
ListKeyEvents RPC 的回應訊息。
欄位 | |
---|---|
key_events[] |
要求的重要事件 |
next_page_token |
可做為 |
ListMeasurementProtocolSecretsRequest
ListMeasurementProtocolSecret RPC 的要求訊息
欄位 | |
---|---|
parent |
必要欄位。父項串流的資源名稱。格式:properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets |
page_size |
要傳回的資源數量上限。如未指定,最多將傳回 10 個資源。最大值是 10。值將強制轉換為最大值。 |
page_token |
屬於接收自前一個 |
ListMeasurementProtocolSecretsResponse
ListMeasurementProtocolSecret RPC 的回應訊息
欄位 | |
---|---|
measurement_protocol_secrets[] |
要求中指定的父項串流密鑰清單。 |
next_page_token |
可做為 |
ListPropertiesRequest
ListProperties RPC 的要求訊息。
欄位 | |
---|---|
filter |
必要欄位。用於篩選要求結果的運算式。符合篩選資格的欄位如下:
|
page_size |
要傳回的資源數量上限。服務傳回的網頁可能會少於這個值,即使還有其他網頁也一樣。如未指定,最多將傳回 50 個資源。最大值為 200 (系統會將較高的值強制轉換為最大值) |
page_token |
屬於接收自前一個 |
show_deleted |
是否要在結果中包含虛刪除 (例如「垃圾桶」) 的屬性。您可以檢查屬性,以判斷是否已刪除屬性。 |
ListPropertiesResponse
ListProperties RPC 的回應訊息。
欄位 | |
---|---|
properties[] |
符合篩選條件且呼叫者能夠存取的結果。 |
next_page_token |
可做為 |
MeasurementProtocolSecret
用來將命中傳送至 Measurement Protocol 的密鑰值。
欄位 | |
---|---|
name |
僅供輸出。這個密鑰的資源名稱。這個密鑰可能會是任何串流類型的子項。格式:properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret} |
display_name |
必要欄位。這個密鑰的使用者可理解的顯示名稱。 |
secret_value |
僅供輸出。Measurement Protocol 密鑰值。傳送命中給這個密鑰的父項資源時,請將這個值傳遞至 Measurement Protocol API 的 api_secret 欄位。 |
NumericValue
表示數字。
欄位 | |
---|---|
聯集欄位 one_value 。其中一個數值 one_value 只能是下列其中一種數值: |
|
int64_value |
整數值 |
double_value |
雙重值 |
屬性
代表 Google Analytics (分析) GA4 資源的資源訊息。
欄位 | |
---|---|
name |
僅供輸出。此屬性的資源名稱。格式:properties/{property_id},範例:「properties/1000」 |
property_type |
不可變動。此資源資源的屬性類型。建立屬性時,如果類型為「PROPERTY_TYPE_UNSPECIFIED」,則系統會隱含「ORDINARY_PROPERTY」。 |
create_time |
僅供輸出。實體的最初建立時間。 |
update_time |
僅供輸出。實體酬載欄位上次更新的時間。 |
parent |
不可變動。此屬性邏輯父項的資源名稱。 注意:屬性移動 UI 可用來變更父項。格式:accounts/{account}、property/{property} 範例:「accounts/100」、「properties/101」 |
display_name |
必要欄位。這項屬性的顯示名稱。 顯示名稱的長度上限為 100 個 UTF-16 代碼單位。 |
industry_category |
與這項資源相關的產業範例:AUTOMOTIVE、FOOD_AND_DRINK |
time_zone |
必要欄位。報表時區是報表日的邊界,不論資料來源為何。如果時區採用日光節約時間,Analytics (分析) 會自動根據變更做出調整。 注意:更改時區只會影響日後的報表資料,不會溯及既往。 格式:https://www.iana.org/time-zones。例如:「America/Los_Angeles」 |
currency_code |
貨幣金額報表所使用的貨幣類型。 格式:https://en.wikipedia.org/wiki/ISO_4217,例如「USD」、「EUR」、「JPY」 |
service_level |
僅供輸出。套用至這項資源的 Google Analytics (分析) 服務層級。 |
delete_time |
僅供輸出。如果有設定,則表示這項資源移至垃圾桶的時間。如果未設定,這個屬性目前不在垃圾桶中。 |
expire_time |
僅供輸出。設定後,這項移至垃圾桶資源的時間就會永久刪除。如果未設定,則這個屬性目前不在垃圾桶中,因此無法刪除。 |
account |
不可變動。上層帳戶的資源名稱 (格式:accounts/{account_id}),例如「accounts/123」 |
PropertySummary
代表 GA4 資源中繼資料的虛擬資源。
欄位 | |
---|---|
property |
這項資源摘要參照的資源名稱,格式:properties/{property_id},例如:「properties/1000」 |
display_name |
這項資源摘要中所參照的資源名稱。 |
property_type |
屬性的屬性類型。 |
parent |
此屬性邏輯父項的資源名稱。 注意:屬性移動 UI 可用來變更父項。格式:accounts/{account}、properties/{property} 範例:「accounts/100」、「properties/200」 |
PropertyType
屬性資源的類型。
列舉 | |
---|---|
PROPERTY_TYPE_UNSPECIFIED |
屬性類型不明或未指定 |
PROPERTY_TYPE_ORDINARY |
一般 GA4 資源 |
PROPERTY_TYPE_SUBPROPERTY |
GA4 子資源 |
PROPERTY_TYPE_ROLLUP |
GA4 綜覽資源 |
ProvisionAccountTicketRequest
ProvisionAccountTicket RPC 的要求訊息。
欄位 | |
---|---|
account |
要建立的帳戶。 |
redirect_uri |
重新導向 URI,使用者接受《服務條款》後便會導向這個 URI。必須在 Cloud 控制台中設為重新導向 URI。 |
ProvisionAccountTicketResponse
ProvisionAccountTicket RPC 的回應訊息。
欄位 | |
---|---|
account_ticket_id |
要在服務條款連結中傳遞的參數。 |
RunAccessReportRequest
針對資料存取記錄報告的要求。
欄位 | |
---|---|
entity |
資料存取報表支援在資源層級或帳戶層級提出要求。如在帳戶層級提出要求,資料存取報表就會包含該帳戶下所有資源的所有存取權。 如要在資源層級提出要求,實體應以「properties/123」為例,且「123」是您的 GA4 資源 ID。如要在帳戶層級提出要求,實體應為「accounts/1234」,例如「1234」是您的 GA4 帳戶 ID。 |
dimensions[] |
要求及顯示在回應中的維度。要求最多可包含 9 個維度。 |
metrics[] |
要求及顯示在回應中的指標。要求最多可包含 10 個指標。 |
date_ranges[] |
要讀取的存取記錄日期範圍。如果要求多個日期範圍,則每個回應列都會包含以 0 為基礎的日期範圍索引。如果兩個日期範圍重疊,這兩個日期範圍的回應列就會包含重疊日期的存取權記錄。最多可以要求 2 個日期範圍。 |
dimension_filter |
維度篩選器可讓您限制報表只傳回符合篩選器的特定維度值。例如,篩選單一使用者的存取記錄。詳情請參閱「維度篩選器基礎知識」一文。這個篩選器無法使用指標。 |
metric_filter |
指標篩選器可限制報表只會列出符合篩選條件的特定指標值。指標篩選器會在匯總報表資料列後套用,與 SQL 含子句類似。無法在這個篩選器中使用維度。 |
offset |
起始資料列的列數。第一列會計為第 0 列。如果未指定偏移量,系統會將偏移值視為 0。如果位移為零,這個方法會傳回第一頁含有 如要進一步瞭解這個分頁參數,請參閱分頁。 |
limit |
要傳回的列數。如果未指定,則會傳回 10,000 列。無論您要求的數量為何,API 每個要求最多只能傳回 100,000 個資料列。 如果剩餘的資料列比 如要進一步瞭解這個分頁參數,請參閱分頁。 |
time_zone |
這項要求的時區 (如有指定)。如果未指定,則會使用屬性的時區。請求的時區是用來解讀報表的開始和結束日期。 格式為 IANA 時區資料庫 (https://www.iana.org/time-zones) 的字串;例如「America/New_York」或「Asia/Tokyo」。 |
order_bys[] |
指定資料列在回應中的排序方式。 |
return_entity_quota |
切換是否要傳回這項 Analytics (分析) 資源的配額目前的狀態。系統會在 AccessQuota 中傳回配額。如果是帳戶層級請求,這個欄位必須設為 false。 |
include_all_users |
選用設定。決定是否要在回應中納入從未發出 API 呼叫的使用者。如果設為 true,所有可存取指定資源或帳戶的使用者,無論是否發出 API 呼叫,都會納入回應中。如果設為 False,系統只會納入已發出 API 呼叫的使用者。 |
expand_groups |
選用設定。決定是否要傳回使用者群組中的使用者。只有在 include_all_users 設為 true 時,此欄位才有效。若為 true,系統會傳回所有具有指定資源或帳戶存取權的使用者。如果設為 False,系統只會傳回具有直接存取權的使用者。 |
RunAccessReportResponse
自訂的資料存取記錄報表回應。
欄位 | |
---|---|
dimension_headers[] |
報表中對應特定維度的欄標題。DimensionsHeader 數量和 DimensionsHeader 數量的按順序與列數相符。 |
metric_headers[] |
報表中對應特定指標的欄標題。MetricHeaders 的數量和 MetricHeaders 的數量與資料列中顯示的指標相符。 |
rows[] |
報表中維度值組合和指標值的資料列。 |
row_count |
查詢結果中的資料列總數。 如要進一步瞭解這個分頁參數,請參閱分頁。 |
quota |
這項 Analytics (分析) 資源的配額狀態 (包括這項要求)。這個欄位不適用於帳戶層級請求。 |
SearchChangeHistoryEventsRequest
SearchChangeHistoryEvents RPC 的要求訊息。
欄位 | |
---|---|
account |
必要欄位。要傳回變更記錄資源的帳戶資源。格式:accounts/{account} 範例:「accounts/100」 |
property |
選用設定。子項屬性的資源名稱。設定後,僅會傳回針對這項資源或其子項資源所做的變更。格式:properties/{propertyId} 範例:「properties/100」 |
resource_type[] |
選用設定。設定後,只有在資源符合至少其中一種型別時,才會傳回變更。 |
action[] |
選用設定。設定後,系統只會傳回與上述一或多種動作類型相符的變更。 |
actor_email[] |
選用設定。設定後,只有當清單中的使用者做了變更時,系統才會傳回這些變更。 |
earliest_change_time |
選用設定。如有設定,則僅傳回這個時間之後的變更 (含)。 |
latest_change_time |
選用設定。如果設定此設定,則只會傳回這個時間之前所做的變更 (含)。 |
page_size |
選用設定。要傳回的 ChangeHistoryEvent 項目數量上限。服務傳回的網頁可能會少於這個值,即使還有其他網頁也一樣。如未指定,最多將傳回 50 個項目。許可的最大值為 200 (上限值將強制轉換成最大值)。 |
page_token |
選用設定。屬於接收自前一個 |
SearchChangeHistoryEventsResponse
SearchAccounts RPC 的回應訊息。
欄位 | |
---|---|
change_history_events[] |
呼叫者可存取的結果。 |
next_page_token |
可做為 |
ServiceLevel
Google Analytics (分析) 提供多種服務層級。
列舉 | |
---|---|
SERVICE_LEVEL_UNSPECIFIED |
服務等級未指定或無效。 |
GOOGLE_ANALYTICS_STANDARD |
標準版 Google Analytics (分析)。 |
GOOGLE_ANALYTICS_360 |
付費版 Google Analytics (分析)。 |
UpdateAccountRequest
UpdateAccount RPC 的要求訊息。
欄位 | |
---|---|
account |
必要欄位。要更新的帳戶。帳戶的 |
update_mask |
必要欄位。要更新的欄位清單。欄位名稱必須採用 snake 格式 (例如「field_to_update」)。系統不會更新已略過的欄位。如要取代整個實體,請使用單一路徑搭配「*」字串,比對所有欄位。 |
UpdateConversionEventRequest
UpdateConversionEvent RPC 的要求訊息
欄位 | |
---|---|
conversion_event |
必要欄位。要更新的轉換事件。 |
update_mask |
必要欄位。要更新的欄位清單。欄位名稱必須採用 snake 大寫 (例如「field_to_update」)。系統不會更新已略過的欄位。如要取代整個實體,請使用單一路徑搭配「*」字串,比對所有欄位。 |
UpdateCustomDimensionRequest
UpdateCustomDimensions RPC 的要求訊息。
欄位 | |
---|---|
custom_dimension |
要更新的自訂維度 |
update_mask |
必要欄位。要更新的欄位清單。系統不會更新已略過的欄位。如要取代整個實體,請使用單一路徑搭配「*」字串,比對所有欄位。 |
UpdateCustomMetricRequest
UpdateCustomMetric RPC 的要求訊息。
欄位 | |
---|---|
custom_metric |
要更新的自訂指標 |
update_mask |
必要欄位。要更新的欄位清單。系統不會更新已略過的欄位。如要取代整個實體,請使用單一路徑搭配「*」字串,比對所有欄位。 |
UpdateDataRetentionSettingsRequest
UpdateDatareservationSettings RPC 的要求訊息。
欄位 | |
---|---|
data_retention_settings |
必要欄位。要更新的設定。 |
update_mask |
必要欄位。要更新的欄位清單。欄位名稱必須採用 snake 大寫 (例如「field_to_update」)。系統不會更新已略過的欄位。如要取代整個實體,請使用單一路徑搭配「*」字串,比對所有欄位。 |
UpdateDataStreamRequest
UpdateDataStream RPC 的要求訊息。
欄位 | |
---|---|
data_stream |
要更新的 DataStream |
update_mask |
必要欄位。要更新的欄位清單。系統不會更新已略過的欄位。如要取代整個實體,請使用單一路徑搭配「*」字串,比對所有欄位。 |
UpdateGoogleAdsLinkRequest
UpdateGoogleAdsLink RPC 的要求訊息
欄位 | |
---|---|
google_ads_link |
要更新的 Google AdsLink |
update_mask |
必要欄位。要更新的欄位清單。欄位名稱必須採用 snake 大寫 (例如「field_to_update」)。系統不會更新已略過的欄位。如要取代整個實體,請使用單一路徑搭配「*」字串,比對所有欄位。 |
UpdateKeyEventRequest
UpdateKeyEvent RPC 的要求訊息
欄位 | |
---|---|
key_event |
必要欄位。要更新的重要事件。 |
update_mask |
必要欄位。要更新的欄位清單。欄位名稱必須採用 snake 大寫 (例如「field_to_update」)。系統不會更新已略過的欄位。如要取代整個實體,請使用單一路徑搭配「*」字串,比對所有欄位。 |
UpdateMeasurementProtocolSecretRequest
UpdateMeasurementProtocolSecret RPC 的要求訊息
欄位 | |
---|---|
measurement_protocol_secret |
必要欄位。要更新的 Measurement Protocol 密鑰。 |
update_mask |
必要欄位。要更新的欄位清單。系統不會更新已略過的欄位。 |
UpdatePropertyRequest
UpdateProperty RPC 的要求訊息。
欄位 | |
---|---|
property |
必要欄位。要更新的屬性。這個屬性的 |
update_mask |
必要欄位。要更新的欄位清單。欄位名稱必須採用 snake 大寫 (例如「field_to_update」)。系統不會更新已略過的欄位。如要取代整個實體,請使用單一路徑搭配「*」字串,比對所有欄位。 |