Package google.analytics.admin.v1alpha

索引

AnalyticsAdminService

Google Analytics Admin API 的服務介面。

AcknowledgeUserDataCollection

rpc AcknowledgeUserDataCollection(AcknowledgeUserDataCollectionRequest) returns (AcknowledgeUserDataCollectionResponse)

確認指定資源的使用者資料收集條款。

您必須先完成這項確認程序 (透過 Google Analytics 使用者介面或這個 API),才能建立 MeasurementProtocolSecret 資源。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.edit
ApproveDisplayVideo360AdvertiserLinkProposal

rpc ApproveDisplayVideo360AdvertiserLinkProposal(ApproveDisplayVideo360AdvertiserLinkProposalRequest) returns (ApproveDisplayVideo360AdvertiserLinkProposalResponse)

核准 DisplayVideo360AdvertiserLinkProposal。系統會刪除 DisplayVideo360AdvertiserLinkProposal,並建立新的 DisplayVideo360AdvertiserLink。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.edit
ArchiveAudience

rpc ArchiveAudience(ArchiveAudienceRequest) returns (Empty)

封存資源中的目標對象。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.edit
ArchiveCustomDimension

rpc ArchiveCustomDimension(ArchiveCustomDimensionRequest) returns (Empty)

封存資源中的 CustomDimension。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.edit
ArchiveCustomMetric

rpc ArchiveCustomMetric(ArchiveCustomMetricRequest) returns (Empty)

封存資源中的 CustomMetric。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.edit
BatchCreateAccessBindings

rpc BatchCreateAccessBindings(BatchCreateAccessBindingsRequest) returns (BatchCreateAccessBindingsResponse)

為帳戶或資源建立多個存取權繫結的相關資訊。

這個方法是交易式方法。如果無法建立任何 AccessBinding,系統就不會建立任何 AccessBinding。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.manage.users
BatchDeleteAccessBindings

rpc BatchDeleteAccessBindings(BatchDeleteAccessBindingsRequest) returns (Empty)

刪除多位使用者與帳戶或資源的連結資訊。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.manage.users
BatchGetAccessBindings

rpc BatchGetAccessBindings(BatchGetAccessBindingsRequest) returns (BatchGetAccessBindingsResponse)

取得帳戶或資源的多個存取權繫結相關資訊。

授權範圍

需要下列其中一種 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.manage.users.readonly
  • https://www.googleapis.com/auth/analytics.manage.users
BatchUpdateAccessBindings

rpc BatchUpdateAccessBindings(BatchUpdateAccessBindingsRequest) returns (BatchUpdateAccessBindingsResponse)

更新帳戶或資源的多個存取權繫結資訊。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.manage.users
CancelDisplayVideo360AdvertiserLinkProposal

rpc CancelDisplayVideo360AdvertiserLinkProposal(CancelDisplayVideo360AdvertiserLinkProposalRequest) returns (DisplayVideo360AdvertiserLinkProposal)

取消 DisplayVideo360AdvertiserLinkProposal。取消提案有兩種情況:- 拒絕從 Display & Video 360 發起的提案 - 撤銷從 Google Analytics 發起的提案 取消後,提案最終會自動刪除。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.edit
CreateAccessBinding

rpc CreateAccessBinding(CreateAccessBindingRequest) returns (AccessBinding)

在帳戶或資源上建立存取權繫結。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.manage.users
CreateAudience

rpc CreateAudience(CreateAudienceRequest) returns (Audience)

建立目標對象。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.edit
CreateCalculatedMetric

rpc CreateCalculatedMetric(CreateCalculatedMetricRequest) returns (CalculatedMetric)

建立 CalculatedMetric。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.edit
CreateChannelGroup

rpc CreateChannelGroup(CreateChannelGroupRequest) returns (ChannelGroup)

建立 ChannelGroup。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.edit
CreateConversionEvent

rpc CreateConversionEvent(CreateConversionEventRequest) returns (ConversionEvent)

已淘汰:請改用 CreateKeyEvent。使用指定屬性建立轉換事件。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.edit
CreateCustomDimension

rpc CreateCustomDimension(CreateCustomDimensionRequest) returns (CustomDimension)

建立 CustomDimension。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.edit
CreateCustomMetric

rpc CreateCustomMetric(CreateCustomMetricRequest) returns (CustomMetric)

建立 CustomMetric。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.edit
CreateDataStream

rpc CreateDataStream(CreateDataStreamRequest) returns (DataStream)

建立資料串流。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.edit
CreateDisplayVideo360AdvertiserLinkProposal

rpc CreateDisplayVideo360AdvertiserLinkProposal(CreateDisplayVideo360AdvertiserLinkProposalRequest) returns (DisplayVideo360AdvertiserLinkProposal)

建立 DisplayVideo360AdvertiserLinkProposal。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.edit
CreateEventCreateRule

rpc CreateEventCreateRule(CreateEventCreateRuleRequest) returns (EventCreateRule)

建立 EventCreateRule。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.edit
CreateEventEditRule

rpc CreateEventEditRule(CreateEventEditRuleRequest) returns (EventEditRule)

建立 EventEditRule。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.edit
CreateExpandedDataSet

rpc CreateExpandedDataSet(CreateExpandedDataSetRequest) returns (ExpandedDataSet)

建立 ExpandedDataSet。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.edit
CreateKeyEvent

rpc CreateKeyEvent(CreateKeyEventRequest) returns (KeyEvent)

建立重要事件。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.edit
CreateMeasurementProtocolSecret

rpc CreateMeasurementProtocolSecret(CreateMeasurementProtocolSecretRequest) returns (MeasurementProtocolSecret)

建立 Measurement Protocol 密鑰。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.edit
CreateProperty

rpc CreateProperty(CreatePropertyRequest) returns (Property)

建立具有指定位置和屬性的 Google Analytics 資源。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.edit
CreateReportingDataAnnotation

rpc CreateReportingDataAnnotation(CreateReportingDataAnnotationRequest) returns (ReportingDataAnnotation)

建立報表資料註解。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.edit
CreateRollupProperty

rpc CreateRollupProperty(CreateRollupPropertyRequest) returns (CreateRollupPropertyResponse)

建立綜覽資源和所有綜覽資源來源連結。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.edit
CreateSKAdNetworkConversionValueSchema

rpc CreateSKAdNetworkConversionValueSchema(CreateSKAdNetworkConversionValueSchemaRequest) returns (SKAdNetworkConversionValueSchema)

建立 SKAdNetworkConversionValueSchema。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.edit
CreateSubpropertyEventFilter

rpc CreateSubpropertyEventFilter(CreateSubpropertyEventFilterRequest) returns (SubpropertyEventFilter)

建立子資源事件篩選器。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.edit
DeleteAccessBinding

rpc DeleteAccessBinding(DeleteAccessBindingRequest) returns (Empty)

刪除帳戶或資源的存取權繫結。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.manage.users
DeleteAccount

rpc DeleteAccount(DeleteAccountRequest) returns (Empty)

將目標帳戶標示為軟刪除 (即「已刪除」),並傳回該帳戶。

這個 API 沒有還原暫時刪除帳戶的方法。不過,您可以使用「垃圾桶」使用者介面還原這些檔案。

如果未在到期時間前還原帳戶,系統會永久清除帳戶和所有子資源 (例如資源、GoogleAdsLinks、串流、AccessBindings)。https://support.google.com/analytics/answer/6154772

如果找不到目標,則會傳回錯誤。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.edit
DeleteCalculatedMetric

rpc DeleteCalculatedMetric(DeleteCalculatedMetricRequest) returns (Empty)

刪除資源中的 CalculatedMetric。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.edit
DeleteChannelGroup

rpc DeleteChannelGroup(DeleteChannelGroupRequest) returns (Empty)

刪除資源的 ChannelGroup。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.edit
DeleteConversionEvent

rpc DeleteConversionEvent(DeleteConversionEventRequest) returns (Empty)

已淘汰:請改用 DeleteKeyEvent。刪除資源中的轉換事件。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.edit
DeleteDataStream

rpc DeleteDataStream(DeleteDataStreamRequest) returns (Empty)

刪除資源中的資料串流。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.edit
DeleteDisplayVideo360AdvertiserLinkProposal

rpc DeleteDisplayVideo360AdvertiserLinkProposal(DeleteDisplayVideo360AdvertiserLinkProposalRequest) returns (Empty)

刪除資源中的 DisplayVideo360AdvertiserLinkProposal。這項功能僅適用於已取消的提案。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.edit
DeleteEventCreateRule

rpc DeleteEventCreateRule(DeleteEventCreateRuleRequest) returns (Empty)

刪除 EventCreateRule。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.edit
DeleteEventEditRule

rpc DeleteEventEditRule(DeleteEventEditRuleRequest) returns (Empty)

刪除 EventEditRule。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.edit
DeleteExpandedDataSet

rpc DeleteExpandedDataSet(DeleteExpandedDataSetRequest) returns (Empty)

刪除資源中的 ExpandedDataSet。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.edit
DeleteKeyEvent

rpc DeleteKeyEvent(DeleteKeyEventRequest) returns (Empty)

刪除重要事件。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.edit
DeleteMeasurementProtocolSecret

rpc DeleteMeasurementProtocolSecret(DeleteMeasurementProtocolSecretRequest) returns (Empty)

刪除目標 MeasurementProtocolSecret。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.edit
DeleteProperty

rpc DeleteProperty(DeletePropertyRequest) returns (Property)

將目標資源標示為已軟刪除 (即「已刪除」),然後傳回該資源。

這個 API 沒有還原虛刪除資源的方法。不過,您可以使用「垃圾桶」使用者介面還原這些檔案。

如果未在期限前還原資源,系統會永久清除資源和所有子資源 (例如 GoogleAdsLinks、Streams、AccessBindings)。https://support.google.com/analytics/answer/6154772

如果找不到目標,則會傳回錯誤。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.edit
DeleteReportingDataAnnotation

rpc DeleteReportingDataAnnotation(DeleteReportingDataAnnotationRequest) returns (Empty)

刪除報表資料註解。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.edit
DeleteSKAdNetworkConversionValueSchema

rpc DeleteSKAdNetworkConversionValueSchema(DeleteSKAdNetworkConversionValueSchemaRequest) returns (Empty)

刪除目標 SKAdNetworkConversionValueSchema。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.edit
DeleteSubpropertyEventFilter

rpc DeleteSubpropertyEventFilter(DeleteSubpropertyEventFilterRequest) returns (Empty)

刪除子資源事件篩選器。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.edit
GetAccessBinding

rpc GetAccessBinding(GetAccessBindingRequest) returns (AccessBinding)

取得存取權繫結的相關資訊。

授權範圍

需要下列其中一種 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.manage.users.readonly
  • https://www.googleapis.com/auth/analytics.manage.users
GetAccount

rpc GetAccount(GetAccountRequest) returns (Account)

查詢單一帳戶。

授權範圍

需要下列其中一種 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetAttributionSettings

rpc GetAttributionSettings(GetAttributionSettingsRequest) returns (AttributionSettings)

查閱 AttributionSettings 單例模式。

授權範圍

需要下列其中一種 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetAudience

rpc GetAudience(GetAudienceRequest) returns (Audience)

查詢單一目標對象。系統可能不支援 2020 年前建立的目標對象。預設目標對象不會顯示篩選條件定義。

授權範圍

需要下列其中一種 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetCalculatedMetric

rpc GetCalculatedMetric(GetCalculatedMetricRequest) returns (CalculatedMetric)

查詢單一 CalculatedMetric。

授權範圍

需要下列其中一種 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetChannelGroup

rpc GetChannelGroup(GetChannelGroupRequest) returns (ChannelGroup)

查詢單一 ChannelGroup。

授權範圍

需要下列其中一種 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetConversionEvent

rpc GetConversionEvent(GetConversionEventRequest) returns (ConversionEvent)

已淘汰:請改用 GetKeyEvent。擷取單一轉換事件。

授權範圍

需要下列其中一種 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetCustomDimension

rpc GetCustomDimension(GetCustomDimensionRequest) returns (CustomDimension)

查詢單一 CustomDimension。

授權範圍

需要下列其中一種 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetCustomMetric

rpc GetCustomMetric(GetCustomMetricRequest) returns (CustomMetric)

查詢單一 CustomMetric。

授權範圍

需要下列其中一種 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetDataRedactionSettings

rpc GetDataRedactionSettings(GetDataRedactionSettingsRequest) returns (DataRedactionSettings)

查詢單一 DataRedactionSettings。

授權範圍

需要下列其中一種 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetDataRetentionSettings

rpc GetDataRetentionSettings(GetDataRetentionSettingsRequest) returns (DataRetentionSettings)

傳回這個資源的單例資料保留設定。

授權範圍

需要下列其中一種 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetDataSharingSettings

rpc GetDataSharingSettings(GetDataSharingSettingsRequest) returns (DataSharingSettings)

取得帳戶的資料共用設定。資料共用設定是單例模式。

授權範圍

需要下列其中一種 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetDataStream

rpc GetDataStream(GetDataStreamRequest) returns (DataStream)

查詢單一 DataStream。

授權範圍

需要下列其中一種 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetDisplayVideo360AdvertiserLinkProposal

rpc GetDisplayVideo360AdvertiserLinkProposal(GetDisplayVideo360AdvertiserLinkProposalRequest) returns (DisplayVideo360AdvertiserLinkProposal)

查詢單一 DisplayVideo360AdvertiserLinkProposal。

授權範圍

需要下列其中一種 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetEnhancedMeasurementSettings

rpc GetEnhancedMeasurementSettings(GetEnhancedMeasurementSettingsRequest) returns (EnhancedMeasurementSettings)

傳回這個資料串流的加強型評估設定。請注意,資料串流必須啟用加強型評估功能,這些設定才會生效。

授權範圍

需要下列其中一種 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetEventCreateRule

rpc GetEventCreateRule(GetEventCreateRuleRequest) returns (EventCreateRule)

查詢單一 EventCreateRule。

授權範圍

需要下列其中一種 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetEventEditRule

rpc GetEventEditRule(GetEventEditRuleRequest) returns (EventEditRule)

查詢單一 EventEditRule。

授權範圍

需要下列其中一種 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetExpandedDataSet

rpc GetExpandedDataSet(GetExpandedDataSetRequest) returns (ExpandedDataSet)

查閱單一 ExpandedDataSet。

授權範圍

需要下列其中一種 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetGlobalSiteTag

rpc GetGlobalSiteTag(GetGlobalSiteTagRequest) returns (GlobalSiteTag)

傳回指定網站資料串流的網站代碼。網站代碼是不可變更的單例項。

授權範圍

需要下列其中一種 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetGoogleSignalsSettings

rpc GetGoogleSignalsSettings(GetGoogleSignalsSettingsRequest) returns (GoogleSignalsSettings)

查詢資源的 Google 信號設定。

授權範圍

需要下列其中一種 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetKeyEvent

rpc GetKeyEvent(GetKeyEventRequest) returns (KeyEvent)

擷取單一重要事件。

授權範圍

需要下列其中一種 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetMeasurementProtocolSecret

rpc GetMeasurementProtocolSecret(GetMeasurementProtocolSecretRequest) returns (MeasurementProtocolSecret)

查詢單一 MeasurementProtocolSecret。

授權範圍

需要下列其中一種 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetProperty

rpc GetProperty(GetPropertyRequest) returns (Property)

查詢單一 Google Analytics 資源。

授權範圍

需要下列其中一種 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetReportingDataAnnotation

rpc GetReportingDataAnnotation(GetReportingDataAnnotationRequest) returns (ReportingDataAnnotation)

查詢單一報表資料註解。

授權範圍

需要下列其中一種 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetReportingIdentitySettings

rpc GetReportingIdentitySettings(GetReportingIdentitySettingsRequest) returns (ReportingIdentitySettings)

傳回這項資源的報表識別資訊設定。

授權範圍

需要下列其中一種 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetSKAdNetworkConversionValueSchema

rpc GetSKAdNetworkConversionValueSchema(GetSKAdNetworkConversionValueSchemaRequest) returns (SKAdNetworkConversionValueSchema)

查詢單一 SKAdNetworkConversionValueSchema。

授權範圍

需要下列其中一種 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetSubpropertyEventFilter

rpc GetSubpropertyEventFilter(GetSubpropertyEventFilterRequest) returns (SubpropertyEventFilter)

查詢單一子資源事件篩選器。

授權範圍

需要下列其中一種 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetSubpropertySyncConfig

rpc GetSubpropertySyncConfig(GetSubpropertySyncConfigRequest) returns (SubpropertySyncConfig)

查詢單一 SubpropertySyncConfig

授權範圍

需要下列其中一種 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListAccessBindings

rpc ListAccessBindings(ListAccessBindingsRequest) returns (ListAccessBindingsResponse)

列出帳戶或資源的所有存取權繫結。

授權範圍

需要下列其中一種 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.manage.users.readonly
  • https://www.googleapis.com/auth/analytics.manage.users
ListAccountSummaries

rpc ListAccountSummaries(ListAccountSummariesRequest) returns (ListAccountSummariesResponse)

傳回呼叫者可存取的所有帳戶摘要。

授權範圍

需要下列其中一種 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListAccounts

rpc ListAccounts(ListAccountsRequest) returns (ListAccountsResponse)

傳回呼叫者可存取的所有帳戶。

請注意,這些帳戶目前可能沒有 Google Analytics 資源。系統預設會排除虛刪除 (即「已移至垃圾桶」) 的帳戶。如果找不到相關帳戶,則會傳回空白清單。

授權範圍

需要下列其中一種 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListAudiences

rpc ListAudiences(ListAudiencesRequest) returns (ListAudiencesResponse)

列出資源中的目標對象。系統可能不支援 2020 年前建立的目標對象。預設目標對象不會顯示篩選條件定義。

授權範圍

需要下列其中一種 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListCalculatedMetrics

rpc ListCalculatedMetrics(ListCalculatedMetricsRequest) returns (ListCalculatedMetricsResponse)

列出資源的 CalculatedMetrics。

授權範圍

需要下列其中一種 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListChannelGroups

rpc ListChannelGroups(ListChannelGroupsRequest) returns (ListChannelGroupsResponse)

列出資源上的 ChannelGroups。

授權範圍

需要下列其中一種 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListConversionEvents

rpc ListConversionEvents(ListConversionEventsRequest) returns (ListConversionEventsResponse)

已淘汰:請改用 ListKeyEvents。傳回指定父項資源中的轉換事件清單。

如果找不到任何轉換事件,則傳回空白清單。

授權範圍

需要下列其中一種 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListCustomDimensions

rpc ListCustomDimensions(ListCustomDimensionsRequest) returns (ListCustomDimensionsResponse)

列出資源的 CustomDimensions。

授權範圍

需要下列其中一種 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListCustomMetrics

rpc ListCustomMetrics(ListCustomMetricsRequest) returns (ListCustomMetricsResponse)

列出資源的 CustomMetrics。

授權範圍

需要下列其中一種 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListDataStreams

rpc ListDataStreams(ListDataStreamsRequest) returns (ListDataStreamsResponse)

列出資源中的 DataStream。

授權範圍

需要下列其中一種 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListDisplayVideo360AdvertiserLinkProposals

rpc ListDisplayVideo360AdvertiserLinkProposals(ListDisplayVideo360AdvertiserLinkProposalsRequest) returns (ListDisplayVideo360AdvertiserLinkProposalsResponse)

列出資源中的 DisplayVideo360AdvertiserLinkProposals。

授權範圍

需要下列其中一種 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListEventCreateRules

rpc ListEventCreateRules(ListEventCreateRulesRequest) returns (ListEventCreateRulesResponse)

列出網站資料串流的 EventCreateRules。

授權範圍

需要下列其中一種 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListEventEditRules

rpc ListEventEditRules(ListEventEditRulesRequest) returns (ListEventEditRulesResponse)

列出網站資料串流的 EventEditRules。

授權範圍

需要下列其中一種 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListExpandedDataSets

rpc ListExpandedDataSets(ListExpandedDataSetsRequest) returns (ListExpandedDataSetsResponse)

列出資源中的 ExpandedDataSet。

授權範圍

需要下列其中一種 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListKeyEvents

rpc ListKeyEvents(ListKeyEventsRequest) returns (ListKeyEventsResponse)

傳回指定上層資源中的重要事件清單。如果找不到任何按鍵事件,則傳回空白清單。

授權範圍

需要下列其中一種 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListMeasurementProtocolSecrets

rpc ListMeasurementProtocolSecrets(ListMeasurementProtocolSecretsRequest) returns (ListMeasurementProtocolSecretsResponse)

傳回指定父項資源下的子項 MeasurementProtocolSecrets。

授權範圍

需要下列其中一種 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListProperties

rpc ListProperties(ListPropertiesRequest) returns (ListPropertiesResponse)

傳回指定父項帳戶下的子項資源。

如果來電者沒有存取權,系統會排除相關資源。系統預設會排除虛刪除 (即「已刪除」) 的資源。如果找不到相關資源,則會傳回空白清單。

授權範圍

需要下列其中一種 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListReportingDataAnnotations

rpc ListReportingDataAnnotations(ListReportingDataAnnotationsRequest) returns (ListReportingDataAnnotationsResponse)

列出資源的所有報表資料註解。

授權範圍

需要下列其中一種 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListSKAdNetworkConversionValueSchemas

rpc ListSKAdNetworkConversionValueSchemas(ListSKAdNetworkConversionValueSchemasRequest) returns (ListSKAdNetworkConversionValueSchemasResponse)

列出串流中的 SKAdNetworkConversionValueSchema。每項資源最多只能有一個 SKAdNetworkConversionValueSchema。

授權範圍

需要下列其中一種 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListSubpropertyEventFilters

rpc ListSubpropertyEventFilters(ListSubpropertyEventFiltersRequest) returns (ListSubpropertyEventFiltersResponse)

列出資源中的所有子資源事件篩選器。

授權範圍

需要下列其中一種 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListSubpropertySyncConfigs

rpc ListSubpropertySyncConfigs(ListSubpropertySyncConfigsRequest) returns (ListSubpropertySyncConfigsResponse)

列出資源的所有 SubpropertySyncConfig 屬性。

授權範圍

需要下列其中一種 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ProvisionAccountTicket

rpc ProvisionAccountTicket(ProvisionAccountTicketRequest) returns (ProvisionAccountTicketResponse)

要求建立帳戶的工單。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.edit
ProvisionSubproperty

rpc ProvisionSubproperty(ProvisionSubpropertyRequest) returns (ProvisionSubpropertyResponse)

建立子資源和適用於所建子資源的子資源事件篩選器。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.edit
ReorderEventEditRules

rpc ReorderEventEditRules(ReorderEventEditRulesRequest) returns (Empty)

變更指定資料串流的事件編輯規則處理順序。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.edit
RunAccessReport

rpc RunAccessReport(RunAccessReportRequest) returns (RunAccessReportResponse)

傳回資料存取記錄的自訂報表。這份報表會記錄使用者每次讀取 Google Analytics 報表資料的時間。存取記錄最多會保留 2 年。

您可以為資源要求提供資料存取報表。您可以為任何資源索取報表,但與配額無關的維度只能在 Google Analytics 360 資源中索取。只有管理員才能使用這個方法。

這些資料存取記錄包括 Google Analytics 使用者介面報表、Google Analytics 使用者介面探索、Google Analytics Data API,以及可透過連結從 Google Analytics 擷取資料的其他產品 (例如 Firebase 和 AdMob)。這些記錄不包括資源設定變更,例如新增資料串流或變更資源時區。如要查看設定變更記錄,請參閱 searchChangeHistoryEvents

如要提供這個 API 的意見回饋,請填寫 Google Analytics 存取報表意見回饋表單。

授權範圍

需要下列其中一種 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
SearchChangeHistoryEvents

rpc SearchChangeHistoryEvents(SearchChangeHistoryEventsRequest) returns (SearchChangeHistoryEventsResponse)

根據指定的一組篩選器,搜尋帳戶或其子項的所有變更。

僅傳回 API 支援的變更子集。使用者介面可能會傳回其他變更。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.edit
SubmitUserDeletion

rpc SubmitUserDeletion(SubmitUserDeletionRequest) returns (SubmitUserDeletionResponse)

為資源提交使用者刪除要求。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.edit
UpdateAccessBinding

rpc UpdateAccessBinding(UpdateAccessBindingRequest) returns (AccessBinding)

更新帳戶或資源的存取權繫結。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.manage.users
UpdateAccount

rpc UpdateAccount(UpdateAccountRequest) returns (Account)

更新帳戶。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.edit
UpdateAttributionSettings

rpc UpdateAttributionSettings(UpdateAttributionSettingsRequest) returns (AttributionSettings)

更新資源的歸因設定。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.edit
UpdateAudience

rpc UpdateAudience(UpdateAudienceRequest) returns (Audience)

更新資源中的目標對象。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.edit
UpdateCalculatedMetric

rpc UpdateCalculatedMetric(UpdateCalculatedMetricRequest) returns (CalculatedMetric)

更新資源中的 CalculatedMetric。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.edit
UpdateChannelGroup

rpc UpdateChannelGroup(UpdateChannelGroupRequest) returns (ChannelGroup)

更新 ChannelGroup。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.edit
UpdateConversionEvent

rpc UpdateConversionEvent(UpdateConversionEventRequest) returns (ConversionEvent)

已淘汰:請改用 UpdateKeyEvent。更新具有指定屬性的轉換事件。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.edit
UpdateCustomDimension

rpc UpdateCustomDimension(UpdateCustomDimensionRequest) returns (CustomDimension)

更新資源的 CustomDimension。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.edit
UpdateCustomMetric

rpc UpdateCustomMetric(UpdateCustomMetricRequest) returns (CustomMetric)

更新資源的 CustomMetric。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.edit
UpdateDataRedactionSettings

rpc UpdateDataRedactionSettings(UpdateDataRedactionSettingsRequest) returns (DataRedactionSettings)

更新資源的 DataRedactionSettings。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.edit
UpdateDataRetentionSettings

rpc UpdateDataRetentionSettings(UpdateDataRetentionSettingsRequest) returns (DataRetentionSettings)

更新這個資源的單例資料保留設定。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.edit
UpdateDataStream

rpc UpdateDataStream(UpdateDataStreamRequest) returns (DataStream)

更新資源中的 DataStream。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.edit
UpdateEnhancedMeasurementSettings

rpc UpdateEnhancedMeasurementSettings(UpdateEnhancedMeasurementSettingsRequest) returns (EnhancedMeasurementSettings)

更新這個資料串流的加強型評估設定。請注意,資料串流必須啟用加強型評估功能,這些設定才會生效。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.edit
UpdateEventCreateRule

rpc UpdateEventCreateRule(UpdateEventCreateRuleRequest) returns (EventCreateRule)

更新 EventCreateRule。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.edit
UpdateEventEditRule

rpc UpdateEventEditRule(UpdateEventEditRuleRequest) returns (EventEditRule)

更新 EventEditRule。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.edit
UpdateExpandedDataSet

rpc UpdateExpandedDataSet(UpdateExpandedDataSetRequest) returns (ExpandedDataSet)

更新資源的 ExpandedDataSet。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.edit
UpdateGoogleSignalsSettings

rpc UpdateGoogleSignalsSettings(UpdateGoogleSignalsSettingsRequest) returns (GoogleSignalsSettings)

更新資源的 Google 信號設定。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.edit
UpdateKeyEvent

rpc UpdateKeyEvent(UpdateKeyEventRequest) returns (KeyEvent)

更新重要事件。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.edit
UpdateMeasurementProtocolSecret

rpc UpdateMeasurementProtocolSecret(UpdateMeasurementProtocolSecretRequest) returns (MeasurementProtocolSecret)

更新 Measurement Protocol 密鑰。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.edit
UpdateProperty

rpc UpdateProperty(UpdatePropertyRequest) returns (Property)

更新屬性。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.edit
UpdateReportingDataAnnotation

rpc UpdateReportingDataAnnotation(UpdateReportingDataAnnotationRequest) returns (ReportingDataAnnotation)

更新報表資料註解。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.edit
UpdateSKAdNetworkConversionValueSchema

rpc UpdateSKAdNetworkConversionValueSchema(UpdateSKAdNetworkConversionValueSchemaRequest) returns (SKAdNetworkConversionValueSchema)

更新 SKAdNetworkConversionValueSchema。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.edit
UpdateSubpropertyEventFilter

rpc UpdateSubpropertyEventFilter(UpdateSubpropertyEventFilterRequest) returns (SubpropertyEventFilter)

更新子資源事件篩選器。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.edit
UpdateSubpropertySyncConfig

rpc UpdateSubpropertySyncConfig(UpdateSubpropertySyncConfigRequest) returns (SubpropertySyncConfig)

更新 SubpropertySyncConfig

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/analytics.edit

AccessBetweenFilter

表示結果必須介於兩個數字之間 (含首尾)。

欄位
from_value

NumericValue

開頭為這個數字。

to_value

NumericValue

結尾為這個數字。

AccessBinding

將使用者繫結至一組角色。

欄位
name

string

僅供輸出。這個繫結的資源名稱。

格式:accounts/{account}/accessBindings/{access_binding} 或 properties/{property}/accessBindings/{access_binding}

例如:「accounts/100/accessBindings/200」

roles[]

string

要授予父項資源的角色清單。

有效值:predefinedRoles/viewer、predefinedRoles/analyst、predefinedRoles/editor、predefinedRoles/admin、predefinedRoles/no-cost-data、predefinedRoles/no-revenue-data

如果為使用者設定空白的角色清單,系統會刪除這個 AccessBinding。

聯集欄位 access_target。要為其設定角色的目標。access_target 只能是下列其中一項:
user

string

如果已設定,則為要設定角色的使用者電子郵件地址。格式:「someuser@gmail.com」

AccessDateRange

連續的天數範圍:startDate、startDate + 1、...、endDate。

欄位
start_date

string

查詢的開始日期 (含此日期),格式為 YYYY-MM-DD。不得晚於 endDate。系統也接受 NdaysAgoyesterdaytoday 格式,在這種情況下,系統會根據要求時區的目前時間推斷日期。

end_date

string

查詢的結束日期 (含此日期),格式為 YYYY-MM-DD。不得早於 startDate。系統也接受 NdaysAgoyesterdaytoday 格式,在這種情況下,系統會根據要求時區的目前時間推斷日期。

AccessDimension

維度是資料的屬性。舉例來說,維度 userEmail 會指出存取報表資料的使用者電子郵件地址。報表回應中的維度值是字串。

欄位
dimension_name

string

維度的 API 名稱。如需這個 API 支援的維度清單,請參閱「資料存取結構定義」。

維度會在 dimensionFilterorderBys 中依名稱參照。

AccessDimensionHeader

說明報表中的維度資料欄。報表中要求的維度會在列和 DimensionHeaders 中產生資料欄項目。不過,如果維度僅用於篩選器或運算式,就不會在報表中產生資料欄,因此也不會產生標題。

欄位
dimension_name

string

維度的名稱,例如「userEmail」。

AccessDimensionValue

維度的值。

欄位
value

string

維度值。舉例來說,如果維度是「國家/地區」,這個值可能是「法國」。

AccessFilter

用來篩選維度或指標值的運算式。

欄位
field_name

string

維度名稱或指標名稱。

聯集欄位 one_filter。為 Filter 指定一種篩選條件類型。one_filter 只能是下列其中一項:
string_filter

AccessStringFilter

與字串相關的篩選器。

in_list_filter

AccessInListFilter

用於篩選清單中的值。

numeric_filter

AccessNumericFilter

用於篩選數值或日期值的篩選條件。

between_filter

AccessBetweenFilter

兩個值的篩選器。

AccessFilterExpression

表示維度或指標篩選條件。同一運算式中的欄位必須全為維度或全為指標。

欄位
聯集欄位 one_expression。為 FilterExpression 指定一種篩選器運算式。one_expression 只能是下列其中一項:
and_group

AccessFilterExpressionList

and_group 中的每個 FilterExpression 都有 AND 關係。

or_group

AccessFilterExpressionList

or_group 中的每個 FilterExpression 都有 OR 關係。

not_expression

AccessFilterExpression

FilterExpression 不是 not_expression。

access_filter

AccessFilter

原始篩選器。在同一個 FilterExpression 中,篩選器的所有欄位名稱都必須是維度或指標。

AccessFilterExpressionList

篩選運算式清單。

欄位
expressions[]

AccessFilterExpression

篩選運算式清單。

AccessInListFilter

結果必須是字串值清單。

欄位
values[]

string

字串值清單。不得留空。

case_sensitive

bool

如為 true,字串值會區分大小寫。

AccessMetric

報表的量化評估方式。舉例來說,指標 accessCount 是資料存取記錄的總數。

欄位
metric_name

string

指標的 API 名稱。如需這項 API 支援的指標清單,請參閱「資料存取結構定義」。

指標會以名稱在 metricFilterorderBys中參照。

AccessMetricHeader

說明報表中的指標欄。報表中要求的顯示指標會在列和 MetricHeaders 中產生資料欄項目。不過,如果指標僅用於篩選器或運算式,就不會在報表中產生資料欄,因此也不會產生標題。

欄位
metric_name

string

指標名稱,例如「accessCount」。

AccessMetricValue

指標的值。

欄位
value

string

測量值。例如,這個值可能是「13」。

AccessNumericFilter

篩選數值或日期值。

欄位
operation

Operation

這個篩選器的操作類型。

value

NumericValue

數字值或日期值。

作業

套用至數值篩選器的運算。

列舉
OPERATION_UNSPECIFIED 未指明
EQUAL 等於
LESS_THAN 小於
LESS_THAN_OR_EQUAL 小於或等於
GREATER_THAN 大於
GREATER_THAN_OR_EQUAL 大於或等於

AccessOrderBy

排序依據會定義回應中的資料列排序方式。舉例來說,依存取次數遞減排序資料列是一種排序方式,依國家/地區字串排序資料列則是另一種排序方式。

欄位
desc

bool

如為 true,則依遞減順序排序。如果為 false 或未指定,則會依遞增順序排序。

聯集欄位 one_order_by。為 OrderBy 指定一種排序依據。one_order_by 只能是下列其中一項:
metric

MetricOrderBy

依指標值排序結果。

dimension

DimensionOrderBy

依維度的值排序結果。

DimensionOrderBy

依維度值排序。

欄位
dimension_name

string

要求中用於排序的維度名稱。

order_type

OrderType

控管維度值排序規則。

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

string

要求中用於排序的指標名稱。

AccessQuota

這個 Analytics 資源的所有配額目前狀態。如果資源的任何配額用盡,對該資源的所有要求都會傳回「Resource Exhausted」錯誤。

欄位
tokens_per_day

AccessQuotaStatus

資源每天最多可使用 250,000 個符記。大多數要求使用的符記數量不到 10 個。

tokens_per_hour

AccessQuotaStatus

每個資源每小時最多可使用 50,000 個權杖。API 要求會耗用一定數量的權杖,並從每小時、每日和每個專案每小時的配額中扣除。

concurrent_requests

AccessQuotaStatus

房源最多可使用 50 個並行要求。

server_errors_per_project_per_hour

AccessQuotaStatus

每個屬性和 Cloud 專案配對每小時最多可發生 50 個伺服器錯誤。

tokens_per_project_per_hour

AccessQuotaStatus

每個資源每小時最多可使用每個專案 25% 的權杖。也就是說,Analytics 360 資源每小時每個專案可使用 12,500 個權杖。API 要求會耗用一定數量的權杖,並從每小時、每日和每個專案每小時的配額中扣除。

AccessQuotaStatus

特定配額群組的目前狀態。

欄位
consumed

int32

這項要求消耗的配額。

remaining

int32

這項要求完成後剩餘的配額。

AccessRow

存取每個資料列的報表資料。

欄位
dimension_values[]

AccessDimensionValue

維度值清單。這些值的順序與要求中指定的順序相同。

metric_values[]

AccessMetricValue

指標值清單。這些值的順序與要求中指定的順序相同。

AccessStringFilter

字串的篩選器。

欄位
match_type

MatchType

這個篩選器的比對類型。

value

string

用於比對的字串值。

case_sensitive

bool

如為 true,字串值會區分大小寫。

MatchType

字串篩選器的比對類型。

列舉
MATCH_TYPE_UNSPECIFIED 未指定
EXACT 字串值完全相符。
BEGINS_WITH 以字串值開頭。
ENDS_WITH 結尾為字串值。
CONTAINS 包含字串值。
FULL_REGEXP 字串值與規則運算式完全相符。
PARTIAL_REGEXP 字串值與規則運算式部分相符。

帳戶

代表 Google Analytics 帳戶的資源訊息。

欄位
name

string

僅供輸出。這個帳戶的資源名稱。格式:accounts/{account} 範例:「accounts/100」

create_time

Timestamp

僅供輸出。這個帳戶的原始建立時間。

update_time

Timestamp

僅供輸出。上次更新帳戶酬載欄位的時間。

display_name

string

必要欄位。這個帳戶的使用者可讀顯示名稱。

region_code

string

商家所在國家/地區。必須是 Unicode CLDR 區域代碼。

deleted

bool

僅供輸出。指出這個帳戶是否已軟刪除。除非特別要求,否則清單結果會排除已刪除的帳戶。

gmp_organization

string

僅供輸出。Google Marketing Platform 機構資源的 URI。只有在帳戶連結至 GMP 機構時才會設定。格式:marketingplatformadmin.googleapis.com/organizations/{org_id}

AccountSummary

虛擬資源,代表帳戶和所有子項 Google Analytics 資源的總覽。

欄位
name

string

這個帳戶摘要的資源名稱。格式:accountSummaries/{account_id} 範例:「accountSummaries/1000」

account

string

這個帳戶摘要所指帳戶的資源名稱。格式:accounts/{account_id}。範例:「accounts/1000」

display_name

string

這個帳戶摘要中提及的帳戶顯示名稱。

property_summaries[]

PropertySummary

這個帳戶的子帳戶摘要清單。

AcknowledgeUserDataCollectionRequest

AcknowledgeUserDataCollection RPC 的要求訊息。

欄位
property

string

必要欄位。要確認使用者資料收集聲明的資源。

acknowledgement

string

必要欄位。確認這個方法的呼叫端瞭解使用者資料收集條款。

這個欄位必須包含確切值:「我確認,我已針對收集和處理使用者資料作業提供必要的隱私揭露聲明並取得使用者授權,這類資料也包括使用者資料與 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 支援團隊人員所做的變更。

ApproveDisplayVideo360AdvertiserLinkProposalRequest

ApproveDisplayVideo360AdvertiserLinkProposal RPC 的要求訊息。

欄位
name

string

必要欄位。要核准的 DisplayVideo360AdvertiserLinkProposal 名稱。格式範例:properties/1234/displayVideo360AdvertiserLinkProposals/5678

ApproveDisplayVideo360AdvertiserLinkProposalResponse

ApproveDisplayVideo360AdvertiserLinkProposal RPC 的回應訊息。

欄位

ArchiveAudienceRequest

ArchiveAudience RPC 的要求訊息。

欄位
name

string

必要欄位。格式範例:properties/1234/audiences/5678

ArchiveCustomDimensionRequest

ArchiveCustomDimension RPC 的要求訊息。

欄位
name

string

必要欄位。要封存的 CustomDimension 名稱。格式範例:properties/1234/customDimensions/5678

ArchiveCustomMetricRequest

ArchiveCustomMetric RPC 的要求訊息。

欄位
name

string

必要欄位。要封存的 CustomMetric 名稱。格式範例:properties/1234/customMetrics/5678

AttributionSettings

用於特定資源的歸因設定。這是單例資源。

欄位
name

string

僅供輸出。這個歸因設定資源的資源名稱。格式:properties/{property_id}/attributionSettings 範例:「properties/1000/attributionSettings」

acquisition_conversion_event_lookback_window

AcquisitionConversionEventLookbackWindow

必要欄位。獲取新客轉換事件的回溯期設定。預設回溯期為 30 天。

other_conversion_event_lookback_window

OtherConversionEventLookbackWindow

必要欄位。所有其他非獲客轉換事件的回溯期。預設回溯期為 90 天。

reporting_attribution_model

ReportingAttributionModel

必要欄位。報表歸因模式用於計算這項資源報表中的轉換功勞。

請注意,變更歸因模式會影響歷來資料和未來資料。這些變更會反映在內含轉換和收益資料的報表中。使用者和工作階段資料,則不受影響。

ads_web_conversion_data_export_scope

AdsWebConversionDataExportScope

必要欄位。匯出至已連結 Google Ads 帳戶的資料轉換匯出範圍。

AcquisitionConversionEventLookbackWindow

系統應回溯多久時間,將事件納入轉換路徑,該路徑會導向應用程式的首次安裝或網站的首次造訪。

列舉
ACQUISITION_CONVERSION_EVENT_LOOKBACK_WINDOW_UNSPECIFIED 未指定回溯期長度。
ACQUISITION_CONVERSION_EVENT_LOOKBACK_WINDOW_7_DAYS 7 天回溯期。
ACQUISITION_CONVERSION_EVENT_LOOKBACK_WINDOW_30_DAYS 30 天的回溯期。

AdsWebConversionDataExportScope

匯出至已連結 Google Ads 帳戶的資料轉換匯出範圍。

列舉
ADS_WEB_CONVERSION_DATA_EXPORT_SCOPE_UNSPECIFIED 預設值。這個值不會使用。
NOT_SELECTED_YET 尚未選取任何資料匯出範圍。匯出範圍永遠無法改回這個值。
PAID_AND_ORGANIC_CHANNELS 付費和自然管道都可獲得轉換功勞,但 Google Ads 帳戶只會顯示分配給 Google Ads 管道的功勞。詳情請參閱「付費和自然管道」。
GOOGLE_PAID_CHANNELS 只有 Google Ads 付費管道可獲得轉換功勞。詳情請參閱「Google 付費頻道」。

OtherConversionEventLookbackWindow

對於初次安裝應用程式/初次造訪網站以外的所有轉換,系統應回溯多久時間,將事件納入轉換路徑。

列舉
OTHER_CONVERSION_EVENT_LOOKBACK_WINDOW_UNSPECIFIED 未指定回溯期長度。
OTHER_CONVERSION_EVENT_LOOKBACK_WINDOW_30_DAYS 30 天的回溯期。
OTHER_CONVERSION_EVENT_LOOKBACK_WINDOW_60_DAYS 60 天回溯期。
OTHER_CONVERSION_EVENT_LOOKBACK_WINDOW_90_DAYS 90 天回溯期。

ReportingAttributionModel

報表歸因模式用於計算這項資源報表中的轉換功勞。

列舉
REPORTING_ATTRIBUTION_MODEL_UNSPECIFIED 未指定報表歸因模式。
PAID_AND_ORGANIC_CHANNELS_DATA_DRIVEN 以數據為準歸因模式會根據每個轉換事件的資料分配轉換功勞。因此,每個廣告主和轉換事件的以數據為準歸因模式都不太一樣。先前為 CROSS_CHANNEL_DATA_DRIVEN
PAID_AND_ORGANIC_CHANNELS_LAST_CLICK 忽略直接流量,並將所有轉換價值歸給消費者在轉換前點擊的最後一個管道 (YouTube 則為互動瀏覽後轉換)。先前為 CROSS_CHANNEL_LAST_CLICK
GOOGLE_PAID_CHANNELS_LAST_CLICK 將 100% 的轉換價值都歸給消費者在完成轉換前點按的最後一個 Google 付費管道。先前為 ADS_PREFERRED_LAST_CLICK

觀眾

代表目標對象的資源訊息。

欄位
name

string

僅供輸出。這個目標對象資源的資源名稱。格式:properties/{propertyId}/audiences/{audienceId}

display_name

string

必要欄位。目標對象的顯示名稱。

description

string

必要欄位。目標對象的說明。

membership_duration_days

int32

必要欄位。不可變更。使用者應留在目標對象中的時間長度。最多只能設為 540 天。

ads_personalization_enabled

bool

僅供輸出。如果這是非個人化廣告目標對象,且已從廣告個人化中排除,Google Analytics 就會自動將這項屬性設為 false。

event_trigger

AudienceEventTrigger

(選用步驟) 指定使用者加入目標對象時要記錄的事件。如果未設定,使用者加入目標對象時,系統不會記錄任何事件。

exclusion_duration_mode

AudienceExclusionDurationMode

不可變更。指定符合排除篩選條件的使用者要排除多久。這項設定會套用至所有「排除」篩選條件子句,如果目標對象中沒有「排除」篩選條件子句,系統就會忽略這項設定。

filter_clauses[]

AudienceFilterClause

必要欄位。不可變更。未排序的清單。篩選定義目標對象的子句。所有子句都會以 AND 連結。

create_time

Timestamp

僅供輸出。目標對象的建立時間。

AudienceExclusionDurationMode

指定符合排除篩選條件的使用者排除時間長度。

列舉
AUDIENCE_EXCLUSION_DURATION_MODE_UNSPECIFIED 不指定。
EXCLUDE_TEMPORARILY 在使用者符合篩選條件子句的期間,將他們從目標對象中排除。
EXCLUDE_PERMANENTLY 只要使用者曾符合篩選器子句,就將他們從目標對象中排除。

AudienceDimensionOrMetricFilter

單一維度或指標的特定篩選器。

欄位
field_name

string

必要欄位。不可變更。要篩選的維度名稱或指標名稱。如果欄位名稱是指自訂維度或指標,系統會在自訂維度或指標名稱前方加上範圍前置字串。如要進一步瞭解範圍前置字元或自訂維度/指標,請參閱 Google Analytics Data API 說明文件

at_any_point_in_time

bool

(選用步驟) 指出這個篩選器是否需要動態評估。如果設為 true,只要使用者曾經符合條件,就會加入目標對象 (靜態評估)。如果未設定或設為 false,系統會採用動態的評估方式,目標對象符合條件時就加進名單,不符條件時則移除。

只有在「目標對象範圍」為「ACROSS_ALL_SESSIONS」時,才能設定這項屬性。

in_any_n_day_period

int32

(選用步驟) 如果已設定,請指定評估資料的時間範圍 (以天為單位)。如未設定,系統會根據生命週期資料評估目標對象資料 (例如無限時間範圍)。

舉例來說,如果設為 1 天,系統只會評估當天的資料。如果未設定 at_any_point_in_time 或設為 false,參考點就是當天。

只有在目標對象範圍為 ACROSS_ALL_SESSIONS 時才能設定,且不得超過 60 天。

聯集欄位 one_filter。上述任一篩選器。one_filter 只能是下列其中一項:
string_filter

StringFilter

字串類型維度的篩選器,符合特定模式。

in_list_filter

InListFilter

字串維度的篩選器,符合特定選項清單。

numeric_filter

NumericFilter

針對維度或指標的數值或日期值設定篩選條件。

between_filter

BetweenFilter

篩選維度或指標上介於特定值之間的數值或日期值。

BetweenFilter

篩選維度或指標上介於特定值之間的數值或日期值。

欄位
from_value

NumericValue

必要欄位。起始數字 (包含在內)。

to_value

NumericValue

必要欄位。結尾為這個數字 (含)。

InListFilter

字串維度的篩選器,符合特定選項清單。

欄位
values[]

string

必要欄位。要比對的可能字串值清單。不得留空。

case_sensitive

bool

(選用步驟) 如果是 true,比對時會區分大小寫。如果設為 False,比對時不區分大小寫。

NumericFilter

針對維度或指標的數值或日期值設定篩選條件。

欄位
operation

Operation

必要欄位。套用至數值篩選器的運算。

value

NumericValue

必要欄位。要比對的數值或日期值。

作業

套用至數值篩選器的運算。

列舉
OPERATION_UNSPECIFIED 未指明
EQUAL 相等。
LESS_THAN 小於。
GREATER_THAN 大於。

NumericValue

代表數字。

欄位
聯集欄位 one_value。數值。one_value 只能是下列其中一項:
int64_value

int64

整數值。

double_value

double

雙重值。

StringFilter

字串類型維度的篩選器,符合特定模式。

欄位
match_type

MatchType

必要欄位。字串篩選器的比對類型。

value

string

必要欄位。要比對的字串值。

case_sensitive

bool

(選用步驟) 如果是 true,比對時會區分大小寫。如果設為 False,比對時不區分大小寫。

MatchType

字串篩選器的比對類型。

列舉
MATCH_TYPE_UNSPECIFIED 未指定
EXACT 字串值完全相符。
BEGINS_WITH 以字串值開頭。
ENDS_WITH 結尾為字串值。
CONTAINS 包含字串值。
FULL_REGEXP 完整規則運算式與字串值相符。

AudienceEventFilter

篩選器會比對單一事件名稱的事件。如果指定事件參數,只有符合單一事件名稱和參數篩選器運算式的事件子集,才會符合這個事件篩選器。

欄位
event_name

string

必要欄位。不可變更。要比對的事件名稱。

event_parameter_filter_expression

AudienceFilterExpression

(選用步驟) 如果指定了這項篩選器,系統會比對符合單一事件名稱和參數篩選器運算式的事件。無法在參數篩選器運算式中設定 AudienceEventFilter (例如,不支援巢狀事件篩選器)。這應該是 dimension_or_metric_filter 或 not_expression 的單一 and_group;系統不支援 OR 的 AND。此外,如果包含「eventCount」的篩選器,系統只會考量該篩選器,並忽略所有其他篩選器。

AudienceEventTrigger

指定使用者加入目標對象時要記錄的事件。

欄位
event_name

string

必要欄位。系統記錄的事件名稱。

log_condition

LogCondition

必要欄位。何時記錄事件。

LogCondition

決定何時記錄事件。

列舉
LOG_CONDITION_UNSPECIFIED 未指定記錄條件。
AUDIENCE_JOINED 只有在使用者加入時,才應記錄事件。
AUDIENCE_MEMBERSHIP_RENEWED 只要符合目標對象條件,就應記錄事件,即使使用者已是目標對象成員也一樣。

AudienceFilterClause

定義簡單或序列篩選器的子句。篩選器可以是包含性 (例如,符合篩選器子句的使用者會納入目標對象),也可以是排除性 (例如,符合篩選器子句的使用者會從目標對象中排除)。

欄位
clause_type

AudienceClauseType

必要欄位。指定這是納入或排除篩選器子句。

聯集欄位 filter

filter 只能是下列其中一項:

simple_filter

AudienceSimpleFilter

使用者必須符合的簡單篩選條件,才能成為目標對象成員。

sequence_filter

AudienceSequenceFilter

使用者必須符合特定順序的篩選條件,才能成為目標對象的成員。

AudienceClauseType

指定這是納入或排除篩選器子句。

列舉
AUDIENCE_CLAUSE_TYPE_UNSPECIFIED 未指定子句類型。
INCLUDE 只要符合篩選器子句,使用者就會納入目標對象。
EXCLUDE 如果符合篩選器子句,系統就會將使用者排除在目標對象之外。

AudienceFilterExpression

目標對象維度、指標或事件篩選器的邏輯運算式。

欄位
聯集欄位 expr。套用至篩選器的運算式。expr 只能是下列其中一項:
and_group

AudienceFilterExpressionList

要以 AND 運算符合併的運算式清單。只能包含具有 or_group 的 AudienceFilterExpressions。頂層 AudienceFilterExpression 必須設定此值。

or_group

AudienceFilterExpressionList

要以 OR 運算子合併的運算式清單。不得包含具有 and_group 或 or_group 的 AudienceFilterExpressions。

not_expression

AudienceFilterExpression

要 NOT 運算的篩選器運算式 (例如反轉、補足)。只能包含 dimension_or_metric_filter。這項設定無法在頂層 AudienceFilterExpression 中設定。

dimension_or_metric_filter

AudienceDimensionOrMetricFilter

單一維度或指標的篩選條件。這項設定無法在頂層 AudienceFilterExpression 中設定。

event_filter

AudienceEventFilter

建立符合特定事件的篩選條件。這項設定無法在頂層 AudienceFilterExpression 中設定。

AudienceFilterExpressionList

目標對象篩選運算式清單。

欄位
filter_expressions[]

AudienceFilterExpression

目標對象篩選運算式清單。

AudienceFilterScope

指定評估使用者是否加入目標對象的方式。

列舉
AUDIENCE_FILTER_SCOPE_UNSPECIFIED 未指定範圍。
AUDIENCE_FILTER_SCOPE_WITHIN_SAME_EVENT 如果使用者在一個事件中符合篩選器條件,系統就會將他們納入目標對象。
AUDIENCE_FILTER_SCOPE_WITHIN_SAME_SESSION 如果使用者在一個工作階段內符合篩選器條件,就會加入目標對象。
AUDIENCE_FILTER_SCOPE_ACROSS_ALL_SESSIONS 只要任何工作階段中的任何事件符合篩選條件,使用者就會加入目標對象。

AudienceSequenceFilter

定義篩選條件,使用者必須依特定順序符合這些條件,才能成為目標對象的成員。

欄位
scope

AudienceFilterScope

必要欄位。不可變更。指定這個篩選器的範圍。

sequence_maximum_duration

Duration

(選用步驟) 定義整個序列必須發生在哪個時間範圍內。

sequence_steps[]

AudienceSequenceStep

必要欄位。一系列有順序的步驟。使用者必須完成每個步驟,才能加入序列篩選條件。

AudienceSequenceStep

使用者必須符合的條件,且須按照指定步驟順序發生,才能符合序列。

欄位
scope

AudienceFilterScope

必要欄位。不可變更。指定這個步驟的範圍。

immediately_follows

bool

(選用步驟) 如果為 true,滿足這個步驟的事件必須是滿足上一個步驟的事件之後的下一個事件。如果未設定或設為 false,這個步驟會間接接續前一個步驟;舉例來說,前一個步驟和這個步驟之間可能會有事件。在第一個步驟中,系統會忽略這項資訊。

constraint_duration

Duration

(選用步驟) 設定後,這個步驟必須在先前步驟的 constraint_duration 內完成 (例如 t[i] - t[i-1] <= constraint_duration)。如未設定,則沒有時間長度限制 (時間長度實際上不受限制)。在第一個步驟中,系統會忽略這項資訊。

filter_expression

AudienceFilterExpression

必要欄位。不可變更。每個步驟中目標對象維度、指標或事件篩選條件的邏輯運算式。

AudienceSimpleFilter

定義使用者必須滿足的簡單篩選條件,才能成為目標對象的成員。

欄位
scope

AudienceFilterScope

必要欄位。不可變更。指定這個篩選器的範圍。

filter_expression

AudienceFilterExpression

必要欄位。不可變更。目標對象維度、指標或事件篩選器的邏輯運算式。

BatchCreateAccessBindingsRequest

BatchCreateAccessBindings RPC 的要求訊息。

欄位
parent

string

必要欄位。擁有存取權繫結的帳戶或資源。CreateAccessBindingRequest 訊息中的父項欄位必須留空或與這個欄位相符。格式:- accounts/{account} - properties/{property}

requests[]

CreateAccessBindingRequest

必要欄位。指定要建立存取權繫結的要求。您最多可以批次建立 1,000 個存取繫結。

BatchCreateAccessBindingsResponse

BatchCreateAccessBindings RPC 的回應訊息。

欄位
access_bindings[]

AccessBinding

已建立存取繫結。

BatchDeleteAccessBindingsRequest

BatchDeleteAccessBindings RPC 的要求訊息。

欄位
parent

string

必要欄位。擁有存取權繫結的帳戶或資源。DeleteAccessBindingRequest 訊息中「names」欄位的所有提供值,其父項都必須與這個欄位相符。格式:- accounts/{account} - properties/{property}

requests[]

DeleteAccessBindingRequest

必要欄位。指定要刪除存取權繫結的要求。一次最多可刪除 1000 個存取權繫結。

BatchGetAccessBindingsRequest

BatchGetAccessBindings RPC 的要求訊息。

欄位
parent

string

必要欄位。擁有存取權繫結的帳戶或資源。「names」欄位的所有提供值父項都必須與這個欄位相符。格式:- accounts/{account} - properties/{property}

names[]

string

必要欄位。要擷取的存取權繫結名稱。一次最多可擷取 1,000 個存取權繫結。格式:- accounts/{account}/accessBindings/{accessBinding} - properties/{property}/accessBindings/{accessBinding}

BatchGetAccessBindingsResponse

BatchGetAccessBindings RPC 的回應訊息。

欄位
access_bindings[]

AccessBinding

要求的存取權繫結。

BatchUpdateAccessBindingsRequest

BatchUpdateAccessBindings RPC 的要求訊息。

欄位
parent

string

必要欄位。擁有存取權繫結的帳戶或資源。UpdateAccessBindingRequest 訊息中所有提供的 AccessBinding 父項都必須與這個欄位相符。格式:- accounts/{account} - properties/{property}

requests[]

UpdateAccessBindingRequest

必要欄位。指定要更新存取權繫結的要求。一次最多可更新 1000 個存取權繫結。

BatchUpdateAccessBindingsResponse

BatchUpdateAccessBindings RPC 的回應訊息。

欄位
access_bindings[]

AccessBinding

已更新存取權繫結。

CalculatedMetric

計算指標的定義。

欄位
name

string

僅供輸出。這個 CalculatedMetric 的資源名稱。格式:「properties/{property_id}/calculatedMetrics/{calculated_metric_id}」

description

string

(選用步驟) 這項計算指標的說明。長度上限為 4,096 個字元。

display_name

string

必要欄位。這個計算指標在 Google Analytics 使用者介面中顯示的名稱。長度上限為 82 個半形字元。

calculated_metric_id

string

僅供輸出。計算指標要使用的 ID。在使用者介面中,這項配額稱為「API 名稱」。

從外部 API 參照這個計算指標時,會使用 calculated_metric_id。例如「calcMetric:{calculated_metric_id}」。

metric_unit

MetricUnit

必要欄位。計算指標值的類型。

restricted_metric_type[]

RestrictedMetricType

僅供輸出。這項指標包含的受限資料類型。

formula

string

必要欄位。計算指標的定義。最多只能參照 5 個不重複的自訂指標。公式支援下列運算:+ (加法)、- (減法)、- (負數)、* (乘法)、/ (除法)、() (括號)。只要是符合 Long (64 位元整數) 或 Double (64 位元浮點數) 的有效實數,系統都會接受。公式範例:「( customEvent:parameter_name + cartPurchaseQuantity ) / 2.0」

invalid_metric_reference

bool

僅供輸出。如為 true,表示這項計算指標的指標參照無效。如果計算指標的 invalid_metric_reference 設為 true,使用該指標的任何項目都可能失敗、產生警告或產生非預期的結果。

MetricUnit

可能代表計算指標值的類型。

列舉
METRIC_UNIT_UNSPECIFIED 未指定或缺少 MetricUnit。
STANDARD 這項指標使用預設單位。
CURRENCY 這項指標會評估貨幣。
FEET 這項指標會測量英尺。
MILES 這項指標以英里為單位。
METERS 這項指標會測量公尺。
KILOMETERS 這項指標以公里為單位。
MILLISECONDS 這項指標以毫秒為單位。
SECONDS 這項指標的測量單位為秒。
MINUTES 這項指標以分鐘為單位。
HOURS 這項指標以小時為單位。

RestrictedMetricType

標籤會標示計算指標中的資料,並搭配使用者角色使用,限制費用和/或收益指標的存取權。

列舉
RESTRICTED_METRIC_TYPE_UNSPECIFIED 類型不明或未指定。
COST_DATA 指標報表會提供費用資料。
REVENUE_DATA 指標會回報收益資料。

CancelDisplayVideo360AdvertiserLinkProposalRequest

CancelDisplayVideo360AdvertiserLinkProposal RPC 的要求訊息。

欄位
name

string

必要欄位。要取消的 DisplayVideo360AdvertiserLinkProposal 名稱。格式範例:properties/1234/displayVideo360AdvertiserLinkProposals/5678

ChangeHistoryChange

單一 Google Analytics 資源的變更說明。

欄位
resource

string

資源名稱,此項目說明該資源的變更。

action

ActionType

變更這項資源的動作類型。

resource_before_change

ChangeHistoryResource

變更前的資源內容。如果這項資源是在這項變更中建立,系統就不會顯示這個欄位。

resource_after_change

ChangeHistoryResource

變更後資源的內容。如果這項資源已在此變更中刪除,系統就會省略這個欄位。

ChangeHistoryResource

資源在變更記錄中變更前後的快照。

欄位

聯集欄位 resource

resource 只能是下列其中一項:

account

Account

變更記錄中的帳戶資源快照。

property

Property

變更記錄中的資源快照。

google_signals_settings

GoogleSignalsSettings

變更記錄中的 GoogleSignalsSettings 資源快照。

conversion_event

ConversionEvent

變更記錄中的 ConversionEvent 資源快照。

measurement_protocol_secret

MeasurementProtocolSecret

變更記錄中的 MeasurementProtocolSecret 資源快照。

custom_dimension

CustomDimension

變更記錄中的 CustomDimension 資源快照。

custom_metric

CustomMetric

變更記錄中的 CustomMetric 資源快照。

data_retention_settings

DataRetentionSettings

變更記錄中資料保留設定資源的快照。

data_stream

DataStream

變更記錄中的 DataStream 資源快照。

attribution_settings

AttributionSettings

變更記錄中的 AttributionSettings 資源快照。

expanded_data_set

ExpandedDataSet

變更記錄中的 ExpandedDataSet 資源快照。

channel_group

ChannelGroup

變更記錄中的 ChannelGroup 資源快照。

enhanced_measurement_settings

EnhancedMeasurementSettings

變更記錄中的 EnhancedMeasurementSettings 資源快照。

data_redaction_settings

DataRedactionSettings

變更記錄中的 DataRedactionSettings 資源快照。

skadnetwork_conversion_value_schema

SKAdNetworkConversionValueSchema

變更記錄中的 SKAdNetworkConversionValueSchema 資源快照。

audience

Audience

變更記錄中的目標對象資源快照。

event_create_rule

EventCreateRule

變更記錄中的 EventCreateRule 資源快照。

key_event

KeyEvent

變更記錄中的 KeyEvent 資源快照。

calculated_metric

CalculatedMetric

變更記錄中的 CalculatedMetric 資源快照。

reporting_data_annotation

ReportingDataAnnotation

變更記錄中的 ReportingDataAnnotation 資源快照。

subproperty_sync_config

SubpropertySyncConfig

變更記錄中的 SubpropertySyncConfig 資源快照。

reporting_identity_settings

ReportingIdentitySettings

變更記錄中的 ReportingIdentitySettings 資源快照。

ChangeHistoryEvent

Google Analytics 帳戶或子項資源中,由相同原因造成的一系列變更。常見原因包括在 Google Analytics 使用者介面中進行更新、客戶服務人員進行變更,或是 Google Analytics 系統自動變更。

欄位
id

string

這項變更記錄事件的 ID。這個 ID 在 Google Analytics 中是唯一的。

change_time

Timestamp

變更時間。

actor_type

ActorType

進行這項變更的行為人類型。

user_actor_email

string

執行變更的 Google 帳戶電子郵件地址。如果 actor 欄位設為 USER,則為有效電子郵件地址,否則為空白。如果 Google 帳戶已刪除,就會發生錯誤。

changes_filtered

bool

如果為 true,表示傳回的變更清單經過篩選,並未列出此事件中的所有變更。

changes[]

ChangeHistoryChange

變更清單,列出符合 SearchChangeHistoryEventsRequest 中指定篩選條件的變更記錄事件。

ChangeHistoryResourceType

變更記錄可能會傳回變更的資源類型。

列舉
CHANGE_HISTORY_RESOURCE_TYPE_UNSPECIFIED 資源類型不明或未指定。
ACCOUNT 帳戶資源
PROPERTY 資源資源
GOOGLE_SIGNALS_SETTINGS GoogleSignalsSettings 資源
CONVERSION_EVENT ConversionEvent 資源
MEASUREMENT_PROTOCOL_SECRET MeasurementProtocolSecret 資源
CUSTOM_DIMENSION CustomDimension 資源
CUSTOM_METRIC CustomMetric 資源
DATA_RETENTION_SETTINGS DataRetentionSettings 資源
DATA_STREAM DataStream 資源
ATTRIBUTION_SETTINGS AttributionSettings 資源
EXPANDED_DATA_SET ExpandedDataSet 資源
CHANNEL_GROUP ChannelGroup 資源
ENHANCED_MEASUREMENT_SETTINGS EnhancedMeasurementSettings 資源
DATA_REDACTION_SETTINGS DataRedactionSettings 資源
SKADNETWORK_CONVERSION_VALUE_SCHEMA SKAdNetworkConversionValueSchema 資源
AUDIENCE 目標對象資源
EVENT_CREATE_RULE EventCreateRule 資源
KEY_EVENT KeyEvent 資源
CALCULATED_METRIC CalculatedMetric 資源
REPORTING_DATA_ANNOTATION ReportingDataAnnotation 資源
SUBPROPERTY_SYNC_CONFIG SubpropertySyncConfig 資源
REPORTING_IDENTITY_SETTINGS ReportingIdentitySettings 資源

ChannelGroup

代表管道群組的資源訊息。

欄位
name

string

僅供輸出。這個管道群組資源的資源名稱。格式:properties/{property}/channelGroups/{channel_group}

display_name

string

必要欄位。管道群組的顯示名稱。長度上限為 80 個字元。

description

string

管道群組的說明。長度上限為 256 個字元。

grouping_rule[]

GroupingRule

必要欄位。管道的分組規則。最多只能有 50 條規則。

system_defined

bool

僅供輸出。如果為 true,則這個管道群組是 Google Analytics 預先定義的預設管道群組。這個管道群組的顯示名稱和分組規則無法更新。

primary

bool

(選用步驟) 如果為 true,這個管道群組就會做為報表的預設管道群組。你隨時只能將一個頻道群組設為 primary。如果為管道群組設定 primary 欄位,系統會取消先前的主要管道群組設定。

預設情況下,Google Analytics 預先定義的管道群組是主要管道群組。

ChannelGroupFilter

單一維度的特定篩選器。

欄位
field_name

string

必要欄位。不可變更。要篩選的維度名稱。

聯集欄位 value_filter。定義這個篩選器行為的 StringFilter 或 InListFilter。value_filter 只能是下列其中一項:
string_filter

StringFilter

字串類型維度的篩選器,符合特定模式。

in_list_filter

InListFilter

字串維度的篩選器,符合特定選項清單。

InListFilter

字串維度的篩選器,符合特定選項清單。比對時不區分大小寫。

欄位
values[]

string

必要欄位。要比對的可能字串值清單。不得留空。

StringFilter

篩選條件為欄位值是字串。比對時不區分大小寫。

欄位
match_type

MatchType

必要欄位。字串篩選器的比對類型。

value

string

必要欄位。要比對的字串值。

MatchType

篩選器如何用於判斷是否相符。

列舉
MATCH_TYPE_UNSPECIFIED 預設比對類型。
EXACT 字串值完全相符。
BEGINS_WITH 以字串值開頭。
ENDS_WITH 結尾為字串值。
CONTAINS 包含字串值。
FULL_REGEXP 與字串值完全相符的規則運算式。
PARTIAL_REGEXP 與字串值部分相符的規則運算式。

ChannelGroupFilterExpression

管道群組維度篩選器的邏輯運算式。

欄位
聯集欄位 expr。套用至篩選器的運算式。expr 只能是下列其中一項:
and_group

ChannelGroupFilterExpressionList

要以 AND 運算符合併的運算式清單。只能包含具有 or_group 的 ChannelGroupFilterExpressions。必須為頂層 ChannelGroupFilterExpression 設定這個值。

or_group

ChannelGroupFilterExpressionList

要以 OR 運算子合併的運算式清單。不得包含具有 and_group 或 or_group 的 ChannelGroupFilterExpressions。

not_expression

ChannelGroupFilterExpression

要進行 NOT 運算的篩選運算式 (即反轉、補數)。只能包含 dimension_or_metric_filter。這項設定無法在頂層 ChannelGroupFilterExpression 中設定。

filter

ChannelGroupFilter

單一維度的篩選器。這項設定無法在頂層 ChannelGroupFilterExpression 中設定。

ChannelGroupFilterExpressionList

管道群組篩選運算式清單。

欄位
filter_expressions[]

ChannelGroupFilterExpression

管道群組篩選運算式清單。

CoarseValue

滿足 ConversionValues.event_mappings 條件時,在 updatePostbackConversionValue SDK 呼叫中設定的粗略轉換價值。詳情請參閱 SKAdNetwork.CoarseConversionValue

列舉
COARSE_VALUE_UNSPECIFIED 未指定粗略值。
COARSE_VALUE_LOW 粗略值為低。
COARSE_VALUE_MEDIUM 媒體的粗略值。
COARSE_VALUE_HIGH 高值的粗略值。

ConversionEvent

Google Analytics 資源中的轉換事件。

欄位
name

string

僅供輸出。這項轉換事件的資源名稱。格式:properties/{property}/conversionEvents/{conversion_event}

event_name

string

不可變更。這項轉換事件的事件名稱。例如:「click」、「purchase」

create_time

Timestamp

僅供輸出。在資源中建立這個轉換事件的時間。

deletable

bool

僅供輸出。如果已設定,目前可以使用 DeleteConversionEvent 刪除這個事件。

custom

bool

僅供輸出。如果設為 true,這個轉換事件是指自訂事件。如果設為 false,這個轉換事件是指 Google Analytics 中的預設事件。預設事件通常在 Google Analytics 中具有特殊意義。預設事件通常是由 Google Analytics 系統為您建立,但有時資源管理員也會建立預設事件。自訂事件會計入每個資源可建立的自訂轉換事件數量上限。

counting_method

ConversionCountingMethod

(選用步驟) 系統在一個工作階段中計算多個事件轉換的方法。如未提供這個值,系統會設為 ONCE_PER_EVENT

default_conversion_value

DefaultConversionValue

(選用步驟) 定義轉換事件的預設價值/幣別。

ConversionCountingMethod

系統在一個工作階段中,計算多個事件轉換次數的方法。

列舉
CONVERSION_COUNTING_METHOD_UNSPECIFIED 未指定計算方法。
ONCE_PER_EVENT 每個事件例項都會視為一次轉換。
ONCE_PER_SESSION 每個使用者在每個工作階段中,最多只會將一個事件例項視為轉換。

DefaultConversionValue

定義轉換事件的預設價值/幣別。必須提供值和幣別。

欄位
value

double

如果指定 event_name 的事件未設定「value」參數,系統就會使用這個值填入所有轉換的價值。

currency_code

string

如果這個 event_name 的轉換事件未設定貨幣,系統會套用這個貨幣做為預設值。必須採用 ISO 4217 貨幣代碼格式,詳情請參閱 https://en.wikipedia.org/wiki/ISO_4217

ConversionValues

SKAdNetwork 轉換價值結構定義的回傳期轉換價值設定。

欄位
display_name

string

SKAdNetwork 轉換價值的顯示名稱。顯示名稱長度上限為 50 個 UTF-16 程式碼單元。

coarse_value

CoarseValue

必要欄位。粗略轉換價值。

這個值不保證不會重複。

event_mappings[]

EventMapping

必須符合的事件條件,才能達成這個轉換價值。這份清單中的條件會以 AND 運算子連結。如果啟用回傳視窗,則必須至少有 1 個項目,最多 3 個項目。

lock_enabled

bool

如果為 true,SDK 應鎖定目前回傳期的這個轉換價值。

fine_value

int32

精細轉換價值。這項功能僅適用於第一個回傳視窗。有效值為 [0,63],包括 0 和 63。必須為回傳期 1 設定,且不得為回傳期 2 和 3 設定。這個值不保證不會重複。

如果第二或第三個回傳期沿用第一個回傳期的設定,這個欄位就不會生效。

CreateAccessBindingRequest

CreateAccessBinding RPC 的要求訊息。

欄位
parent

string

必要欄位。格式:- accounts/{account} - properties/{property}

access_binding

AccessBinding

必要欄位。要建立的存取繫結。

CreateAdSenseLinkRequest

要傳遞至 CreateAdSenseLink 方法的要求訊息。

欄位
parent

string

必要欄位。要建立 AdSense 連結的資源。格式:properties/{propertyId} 範例:properties/1234

CreateAudienceRequest

CreateAudience RPC 的要求訊息。

欄位
parent

string

必要欄位。格式範例:properties/1234

audience

Audience

必要欄位。要建立的目標對象。

CreateBigQueryLinkRequest

CreateBigQueryLink RPC 的要求訊息。

欄位
parent

string

必要欄位。格式範例:properties/1234

CreateCalculatedMetricRequest

CreateCalculatedMetric RPC 的要求訊息。

欄位
parent

string

必要欄位。格式:properties/{property_id} 範例:properties/1234

calculated_metric_id

string

必要欄位。要用於計算指標的 ID,會成為計算指標資源名稱的最終元件。

這個值的長度應為 1 至 80 個字元,有效字元為 /[a-zA-Z0-9_]/,不得有空格。資源中所有計算指標的 calculated_metric_id 必須不重複。從外部 API 參照這個計算指標時,會使用 calculated_metric_id,例如「calcMetric:{calculated_metric_id}」。

calculated_metric

CalculatedMetric

必要欄位。要建立的 CalculatedMetric。

CreateChannelGroupRequest

CreateChannelGroup RPC 的要求訊息。

欄位
parent

string

必要欄位。要建立 ChannelGroup 的資源。格式範例:properties/1234

channel_group

ChannelGroup

必要欄位。要建立的 ChannelGroup。

CreateConversionEventRequest

CreateConversionEvent RPC 的要求訊息

欄位
conversion_event

ConversionEvent

必要欄位。要建立的轉換事件。

parent

string

必要欄位。要建立這個轉換事件的父項資源名稱。格式:properties/123

CreateCustomDimensionRequest

CreateCustomDimension RPC 的要求訊息。

欄位
parent

string

必要欄位。格式範例:properties/1234

custom_dimension

CustomDimension

必要欄位。要建立的 CustomDimension。

CreateCustomMetricRequest

CreateCustomMetric RPC 的要求訊息。

欄位
parent

string

必要欄位。格式範例:properties/1234

custom_metric

CustomMetric

必要欄位。要建立的 CustomMetric。

CreateDataStreamRequest

CreateDataStream RPC 的要求訊息。

欄位
parent

string

必要欄位。格式範例:properties/1234

data_stream

DataStream

必要欄位。要建立的 DataStream。

CreateDisplayVideo360AdvertiserLinkProposalRequest

CreateDisplayVideo360AdvertiserLinkProposal RPC 的要求訊息。

欄位
parent

string

必要欄位。格式範例:properties/1234

CreateDisplayVideo360AdvertiserLinkRequest

CreateDisplayVideo360AdvertiserLink RPC 的要求訊息。

欄位
parent

string

必要欄位。格式範例:properties/1234

CreateEventCreateRuleRequest

CreateEventCreateRule RPC 的要求訊息。

欄位
parent

string

必要欄位。格式範例:properties/123/dataStreams/456

event_create_rule

EventCreateRule

必要欄位。要建立的 EventCreateRule。

CreateEventEditRuleRequest

CreateEventEditRule RPC 的要求訊息。

欄位
parent

string

必要欄位。格式範例:properties/123/dataStreams/456

event_edit_rule

EventEditRule

必要欄位。要建立的 EventEditRule。

CreateExpandedDataSetRequest

CreateExpandedDataSet RPC 的要求訊息。

欄位
parent

string

必要欄位。格式範例:properties/1234

expanded_data_set

ExpandedDataSet

必要欄位。要建立的 ExpandedDataSet。

CreateFirebaseLinkRequest

CreateFirebaseLink RPC 的要求訊息

欄位
parent

string

必要欄位。格式:properties/{property_id}

範例:properties/1234

CreateGoogleAdsLinkRequest

CreateGoogleAdsLink RPC 的要求訊息

欄位
parent

string

必要欄位。格式範例:properties/1234

CreateKeyEventRequest

CreateKeyEvent RPC 的要求訊息

欄位
key_event

KeyEvent

必要欄位。要建立的重要事件。

parent

string

必要欄位。要建立重要事件的父項資源名稱。格式:properties/123

CreateMeasurementProtocolSecretRequest

CreateMeasurementProtocolSecret RPC 的要求訊息

欄位
parent

string

必要欄位。表示將建立這個密鑰的父項資源。格式:properties/{property}/dataStreams/{dataStream}

measurement_protocol_secret

MeasurementProtocolSecret

必要欄位。要建立的 Measurement Protocol 密鑰。

CreatePropertyRequest

CreateProperty RPC 的要求訊息。

欄位
property

Property

必要欄位。要建立的資源。注意:提供的屬性必須指定父項。

CreateReportingDataAnnotationRequest

CreateReportingDataAnnotation RPC 的要求訊息。

欄位
parent

string

必要欄位。要建立報表資料註解的資源。格式:properties/property_id 範例:properties/123

reporting_data_annotation

ReportingDataAnnotation

必要欄位。要建立的報表資料註解。

CreateRollupPropertyRequest

CreateRollupProperty RPC 的要求訊息。

欄位
rollup_property

Property

必要欄位。要建立的綜覽資源。

source_properties[]

string

(選用步驟) 做為所建立綜覽資源來源的資源名稱。

CreateRollupPropertyResponse

CreateRollupProperty RPC 的回應訊息。

欄位
rollup_property

Property

建立的綜覽資源。

CreateRollupPropertySourceLinkRequest

CreateRollupPropertySourceLink RPC 的要求訊息。

欄位
parent

string

必要欄位。格式:properties/{property_id} 範例:properties/1234

CreateSKAdNetworkConversionValueSchemaRequest

CreateSKAdNetworkConversionValueSchema RPC 的要求訊息。

欄位
parent

string

必要欄位。表示將建立這個結構定義的父項資源。格式:properties/{property}/dataStreams/{dataStream}

skadnetwork_conversion_value_schema

SKAdNetworkConversionValueSchema

必要欄位。要建立的 SKAdNetwork 轉換價值結構定義。

CreateSearchAds360LinkRequest

CreateSearchAds360Link RPC 的要求訊息。

欄位
parent

string

必要欄位。格式範例:properties/1234

CreateSubpropertyEventFilterRequest

CreateSubpropertyEventFilter RPC 的要求訊息。

欄位
parent

string

必要欄位。要為其建立子資源事件篩選器的一般資源。格式:properties/property_id 範例:properties/123

subproperty_event_filter

SubpropertyEventFilter

必要欄位。要建立的子資源事件篩選器。

CustomDimension

CustomDimension 的定義。

欄位
name

string

僅供輸出。這個 CustomDimension 資源的資源名稱。格式:properties/{property}/customDimensions/{customDimension}

parameter_name

string

必要欄位。不可變更。這個自訂維度的標記參數名稱。

如果是以使用者為範圍的維度,則這是使用者屬性名稱。如果是以事件為範圍的維度,則這是事件參數名稱。

如果是以項目為範圍的維度,則這是電子商務項目陣列中的參數名稱。

只能使用英數字元和底線,開頭須為英文字母,使用者範圍維度的長度上限為 24 個字元,事件範圍維度的長度上限為 40 個字元。

display_name

string

必要欄位。這個自訂維度的顯示名稱,會顯示在 Analytics 使用者介面中。最多 82 個字元,只能使用英數字元、空格和底線,且開頭須為英文字母。舊版系統產生的顯示名稱可能包含方括號,但更新這個欄位時,一律不允許使用方括號。

description

string

(選用步驟) 這個自訂維度的說明。長度上限為 150 個字元。

scope

DimensionScope

必要欄位。不可變更。這個維度的範圍。

disallow_ads_personalization

bool

(選用步驟) 如果設為 true,系統會將這個維度設為非個人化廣告,並從廣告個人化設定中排除。

目前僅支援使用者範圍的自訂維度。

DimensionScope

這項維度範圍的有效值。

列舉
DIMENSION_SCOPE_UNSPECIFIED 範圍不明或未指定。
EVENT 以事件為範圍的維度。
USER 以使用者為範圍的維度。
ITEM 以電子商務商品為範圍的維度

CustomMetric

自訂指標的定義。

欄位
name

string

僅供輸出。這個 CustomMetric 資源的資源名稱。格式:properties/{property}/customMetrics/{customMetric}

parameter_name

string

必要欄位。不可變更。這個自訂指標的標記名稱。

如果是以事件為範圍的指標,則這是事件參數名稱。

只能使用英數字元和底線,開頭須為英文字母,以事件為範圍的指標長度上限為 40 個字元。

display_name

string

必要欄位。Analytics 使用者介面中顯示的自訂指標顯示名稱。最多 82 個字元,只能使用英數字元、空格和底線,且開頭須為英文字母。舊版系統產生的顯示名稱可能包含方括號,但更新這個欄位時,一律不允許使用方括號。

description

string

(選用步驟) 這個自訂維度的說明。長度上限為 150 個字元。

measurement_unit

MeasurementUnit

必要欄位。自訂指標值的類型。

scope

MetricScope

必要欄位。不可變更。這個自訂指標的範圍。

restricted_metric_type[]

RestrictedMetricType

(選用步驟) 這項指標可能包含的受限資料類型。如果指標的測量單位為「貨幣」,則必須提供這項資訊。如果指標的測量單位不是「貨幣」,則必須留空。

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 指標會回報收益資料。

DataRedactionSettings

用戶端資料遮蓋設定。網站串流下的單例資源。

欄位
name

string

僅供輸出。這項資料遮蓋設定資源的名稱。格式:properties/{property_id}/dataStreams/{data_stream}/dataRedactionSettings 範例:「properties/1000/dataStreams/2000/dataRedactionSettings」

email_redaction_enabled

bool

啟用後,系統會將任何看起來像電子郵件的事件參數或使用者屬性值遮蓋。

query_parameter_redaction_enabled

bool

如果查詢參數位於設定的查詢參數集中,查詢參數修訂功能會移除查詢參數的鍵和值部分。

如果啟用,系統會對串流執行網址查詢替換邏輯。系統會遮蓋 query_parameter_keys 中定義的所有查詢參數。

query_parameter_keys[]

string

如果網址中含有這些查詢參數鍵,系統就會套用遮蓋邏輯。查詢參數比對不區分大小寫。

如果 query_parameter_replacement_enabled 為 true,則必須包含至少一個元素。鍵不得包含半形逗號。

DataRetentionSettings

資料保留設定值。這是單例資源。

欄位
name

string

僅供輸出。這個 DataRetentionSetting 資源的資源名稱。格式:properties/{property}/dataRetentionSettings

event_data_retention

RetentionDuration

必要欄位。事件層級資料的保留時間長度。

user_data_retention

RetentionDuration

必要欄位。保留使用者層級資料的時間長度。

reset_user_data_on_new_activity

bool

如果為 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

string

僅供輸出。資源名稱。格式:accounts/{account}/dataSharingSettings。範例:「accounts/1000/dataSharingSettings」

sharing_with_google_support_enabled

bool

允許 Google 技術支援代表在必要時存取您的 Google Analytics 資料和帳戶,以提供服務並尋求技術問題的解決方法。

這個欄位會對應至 Google Analytics 管理使用者介面中的「技術支援」欄位。

sharing_with_google_assigned_sales_enabled

bool

允許 Google 存取您的 Google Analytics 帳戶資料,包括帳戶使用情形和設定資料、產品支出,以及與 Google Analytics 帳戶連結的使用者,以便 Google 在 Google Analytics 和其他商用 Google 產品中,提供洞察資料、優惠、最佳化建議和最佳化提示,協助您全面發揮 Google 產品的效益。

這個欄位會對應至 Google Analytics 管理使用者介面中的「為貴商家提供的建議」欄位。

sharing_with_google_any_sales_enabled
(deprecated)

bool

已淘汰,這個欄位已停用,一律會傳回 false。

sharing_with_google_products_enabled

bool

允許 Google 使用資料改善其他 Google 產品或服務。

這個欄位會對應至 Google Analytics 管理 UI 中的「Google 產品和服務」欄位。

sharing_with_others_enabled

bool

提供匯總評估資料,系統就能啟用預測、模擬資料和基準化等功能,為您提供更豐富的業務洞察資料。您提供的資料 (包括共用資源的相關資訊) 會經過匯總和去識別化,然後才用來產生業務洞察資料。

這個欄位會對應至 Google Analytics 管理使用者介面中的「根據輸入內容和業務洞察資料建立模型」欄位。

DataStream

代表資料串流的資源訊息。

欄位
name

string

僅供輸出。這個資料串流的資源名稱。格式:properties/{property_id}/dataStreams/{stream_id} 範例:「properties/1000/dataStreams/2000」

type

DataStreamType

必要欄位。不可變更。這個 DataStream 資源的類型。

display_name

string

使用者可理解的資料串流顯示名稱。

網站資料串流必須提供這項資訊。

顯示名稱長度上限為 255 個 UTF-16 程式碼單元。

create_time

Timestamp

僅供輸出。這個串流的原始建立時間。

update_time

Timestamp

僅供輸出。上次更新串流酬載欄位的時間。

聯集欄位 stream_data。特定資料串流類型的資料。系統會根據這個串流的類型設定訊息。stream_data 只能是下列其中一項:
web_stream_data

WebStreamData

網站串流專屬資料。如果類型為 WEB_DATA_STREAM,則必須填入這個欄位。

android_app_stream_data

AndroidAppStreamData

Android 應用程式串流專屬資料。如果類型為 ANDROID_APP_DATA_STREAM,則必須填入這個欄位。

ios_app_stream_data

IosAppStreamData

iOS 應用程式資料串流專屬資料。如果類型為 IOS_APP_DATA_STREAM,則必須填寫。

AndroidAppStreamData

Android 應用程式串流專屬資料。

欄位
firebase_app_id

string

僅供輸出。Firebase 中相應 Android 應用程式的 ID (如有)。如果刪除並重新建立 Android 應用程式,這個 ID 就會變更。

package_name

string

不可變更。要評估的應用程式套件名稱。例如:「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

string

僅供輸出。Firebase 中對應 iOS 應用程式的 ID (如有)。如果刪除並重新建立 iOS 應用程式,這個 ID 就會變更。

bundle_id

string

必要欄位。不可變更。應用程式的 Apple App Store 軟體包 ID,例如「com.example.myiosapp」

WebStreamData

網站串流專屬資料。

欄位
measurement_id

string

僅供輸出。Analytics 評估 ID。

例如:「G-1A2BCD345E」

firebase_app_id

string

僅供輸出。Firebase 中對應網頁應用程式的 ID (如有)。如果刪除並重新建立網頁應用程式,這個 ID 就會變更。

default_uri

string

要評估的網頁應用程式網域名稱,或空白。範例:「http://www.google.com」、「https://www.google.com」

DeleteAccessBindingRequest

DeleteAccessBinding RPC 的要求訊息。

欄位
name

string

必要欄位。格式:- accounts/{account}/accessBindings/{accessBinding} - properties/{property}/accessBindings/{accessBinding}

DeleteAccountRequest

DeleteAccount RPC 的要求訊息。

欄位
name

string

必要欄位。要軟刪除的帳戶名稱。格式:accounts/{account} 範例:「accounts/100」

DeleteAdSenseLinkRequest

要傳遞至 DeleteAdSenseLink 方法的要求訊息。

欄位
name

string

必要欄位。要刪除的 AdSense 連結專屬 ID。格式:properties/{propertyId}/adSenseLinks/{linkId} 範例:properties/1234/adSenseLinks/5678

DeleteBigQueryLinkRequest

DeleteBigQueryLink RPC 的要求訊息。

欄位
name

string

必要欄位。要刪除的 BigQueryLink。格式範例:properties/1234/bigQueryLinks/5678

DeleteCalculatedMetricRequest

DeleteCalculatedMetric RPC 的要求訊息。

欄位
name

string

必要欄位。要刪除的 CalculatedMetric 名稱。格式:properties/{property_id}/calculatedMetrics/{calculated_metric_id} 範例:properties/1234/calculatedMetrics/Metric01

DeleteChannelGroupRequest

DeleteChannelGroup RPC 的要求訊息。

欄位
name

string

必要欄位。要刪除的 ChannelGroup。格式範例:properties/1234/channelGroups/5678

DeleteConversionEventRequest

DeleteConversionEvent RPC 的要求訊息

欄位
name

string

必要欄位。要刪除的轉換事件資源名稱。格式:properties/{property}/conversionEvents/{conversion_event} 範例:「properties/123/conversionEvents/456」

DeleteDataStreamRequest

DeleteDataStream RPC 的要求訊息。

欄位
name

string

必要欄位。要刪除的 DataStream 名稱。格式範例:properties/1234/dataStreams/5678

DeleteDisplayVideo360AdvertiserLinkProposalRequest

DeleteDisplayVideo360AdvertiserLinkProposal RPC 的要求訊息。

欄位
name

string

必要欄位。要刪除的 DisplayVideo360AdvertiserLinkProposal 名稱。格式範例:properties/1234/displayVideo360AdvertiserLinkProposals/5678

DeleteDisplayVideo360AdvertiserLinkRequest

DeleteDisplayVideo360AdvertiserLink RPC 的要求訊息。

欄位
name

string

必要欄位。要刪除的 DisplayVideo360AdvertiserLink 名稱。格式範例:properties/1234/displayVideo360AdvertiserLinks/5678

DeleteEventCreateRuleRequest

DeleteEventCreateRule RPC 的要求訊息。

欄位
name

string

必要欄位。格式範例:properties/123/dataStreams/456/eventCreateRules/789

DeleteEventEditRuleRequest

DeleteEventEditRule RPC 的要求訊息。

欄位
name

string

必要欄位。格式範例:properties/123/dataStreams/456/eventEditRules/789

DeleteExpandedDataSetRequest

DeleteExpandedDataSet RPC 的要求訊息。

欄位
name

string

必要欄位。格式範例:properties/1234/expandedDataSets/5678

DeleteFirebaseLinkRequest

DeleteFirebaseLink RPC 的要求訊息

欄位
name

string

必要欄位。格式:properties/{property_id}/firebaseLinks/{firebase_link_id}

範例:properties/1234/firebaseLinks/5678

DeleteGoogleAdsLinkRequest

DeleteGoogleAdsLink RPC 的要求訊息。

欄位
name

string

必要欄位。格式範例:properties/1234/googleAdsLinks/5678

DeleteKeyEventRequest

DeleteKeyEvent RPC 的要求訊息

欄位
name

string

必要欄位。要刪除的 Key Event 資源名稱。格式:properties/{property}/keyEvents/{key_event} 範例:「properties/123/keyEvents/456」

DeleteMeasurementProtocolSecretRequest

DeleteMeasurementProtocolSecret RPC 的要求訊息

欄位
name

string

必要欄位。要刪除的 MeasurementProtocolSecret 名稱。格式:properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}

DeletePropertyRequest

DeleteProperty RPC 的要求訊息。

欄位
name

string

必要欄位。要軟刪除的資源名稱。格式:properties/{property_id}。範例:「properties/1000」

DeleteReportingDataAnnotationRequest

DeleteReportingDataAnnotation RPC 的要求訊息。

欄位
name

string

必要欄位。要刪除的報表資料註解資源名稱。格式:properties/property_id/reportingDataAnnotations/reporting_data_annotation 範例:properties/123/reportingDataAnnotations/456

DeleteRollupPropertySourceLinkRequest

DeleteRollupPropertySourceLink RPC 的要求訊息。

欄位
name

string

必要欄位。格式:properties/{property_id}/rollupPropertySourceLinks/{rollup_property_source_link_id} 範例:properties/1234/rollupPropertySourceLinks/5678

DeleteSKAdNetworkConversionValueSchemaRequest

DeleteSKAdNetworkConversionValueSchema RPC 的要求訊息。

欄位
name

string

必要欄位。要刪除的 SKAdNetworkConversionValueSchema 名稱。格式:properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema/{skadnetwork_conversion_value_schema}

DeleteSearchAds360LinkRequest

DeleteSearchAds360Link RPC 的要求訊息。

欄位
name

string

必要欄位。要刪除的 SearchAds360Link 名稱。格式範例:properties/1234/SearchAds360Links/5678

DeleteSubpropertyEventFilterRequest

DeleteSubpropertyEventFilter RPC 的要求訊息。

欄位
name

string

必要欄位。要刪除的子資源事件篩選器的資源名稱,格式:properties/property_id/subpropertyEventFilters/subproperty_event_filter 範例:properties/123/subpropertyEventFilters/456

DisplayVideo360AdvertiserLinkProposal

Google Analytics 資源和 Display & Video 360 廣告主之間的連結提案。

提案獲得核准後,就會轉換為 DisplayVideo360AdvertiserLink。Google Analytics 管理員負責核准傳入提案,Display & Video 360 管理員則負責核准傳出提案。

欄位
name

string

僅供輸出。這個 DisplayVideo360AdvertiserLinkProposal 資源的資源名稱。格式:properties/{propertyId}/displayVideo360AdvertiserLinkProposals/{proposalId}

注意:proposalId 不是 Display & Video 360 廣告主 ID

advertiser_id

string

不可變更。Display & Video 360 廣告主的廣告主 ID。

advertiser_display_name

string

僅供輸出。Display & Video 廣告主的顯示名稱。僅適用於來自 Display & Video 360 的提案。

validation_email

string

僅限輸入。提案傳送至 Display & Video 360 時,這個欄位必須設為目標廣告主的管理員電子郵件地址。這項資訊可用於驗證 Google Analytics 管理員是否知道 Display & Video 360 廣告主至少有一位管理員。這不會將提案核准權限限制在單一使用者身上。Display & Video 360 廣告主管理員可以核准提案。

ads_personalization_enabled

BoolValue

不可變更。在這次整合中啟用個人化廣告功能。如未在建立時設定這個欄位,系統會預設為 true。

campaign_data_sharing_enabled

BoolValue

不可變更。啟用後,即可匯入 Display & Video 360 的廣告活動資料。如未在建立時設定這個欄位,系統會預設為 true。

cost_data_sharing_enabled

BoolValue

不可變更。啟用後,系統會匯入 Display & Video 360 的費用資料。只有在啟用 campaign_data_sharing_enabled 時,才能啟用這項功能。如未在建立時設定這個欄位,系統會預設為 true。

EnhancedMeasurementSettings

網站資料串流下的單例資源,用於設定其他網站互動和內容的評估作業。

欄位
name

string

僅供輸出。加強型評估設定的資源名稱。格式:properties/{property_id}/dataStreams/{data_stream}/enhancedMeasurementSettings 範例:「properties/1000/dataStreams/2000/enhancedMeasurementSettings」

stream_enabled

bool

指出是否使用加強型評估設定,自動評估這個網站資料串流的互動和內容。

變更這個值不會影響設定本身,但會決定是否要遵守設定。

scrolls_enabled

bool

啟用後,每次訪客瀏覽至網頁底部時,系統都會記錄捲動事件。

outbound_clicks_enabled

bool

啟用後,每次訪客點擊將他們帶離您網域的連結時,即記錄一次外連點擊事件。

site_search_enabled

bool

啟用後,每當訪客在您網站上執行搜尋 (出現查詢參數) 時,系統就會記錄一次瀏覽搜尋結果事件。

video_engagement_enabled

bool

啟用後,每當訪客瀏覽您網站上內嵌的影片時,系統即會記錄一次影片開始播放、播放中和播完事件。

file_downloads_enabled

bool

啟用後,每次具有一般文件、壓縮檔、應用程式、影片或音訊副檔名的連結獲得點擊時,即記錄一次檔案下載事件。

page_changes_enabled

bool

啟用後,每次網站變更瀏覽器記錄狀態時,即記錄一次網頁瀏覽事件。

form_interactions_enabled

bool

啟用後,每次訪客與網站上的表單互動時,即記錄一次表單互動事件。預設為 False。

search_query_parameter

string

必要欄位。要解讀為網站搜尋參數的網址查詢參數。長度上限為 1024 個半形字元。不得留空。

uri_query_parameter

string

其他網址查詢參數。長度上限為 1024 個半形字元。

EventCreateRule

事件建立規則會定義條件,根據來源事件的相符條件觸發全新事件。您可以定義來源事件參數的其他變動。

與事件編輯規則不同,事件建立規則沒有定義順序。這些作業都會獨立執行。

「編輯活動」和「建立活動」規則無法用來修改根據「建立活動」規則建立的活動。

欄位
name

string

僅供輸出。這個 EventCreateRule 資源的資源名稱。格式:properties/{property}/dataStreams/{data_stream}/eventCreateRules/{event_create_rule}

destination_event

string

必要欄位。要建立的新事件名稱。

這個值必須:* 不超過 40 個字元 * 僅包含英文字母、數字或底線「_」* 以英文字母開頭

event_conditions[]

MatchingCondition

必要欄位。至少須有一個條件,最多可有 10 個條件。來源事件的條件必須相符,系統才會套用這項規則。

source_copy_parameters

bool

若為 true,系統會將來源參數複製到新事件。如果設為 false 或未設定,系統就不會從來源事件複製所有非內部參數。複製參數後,系統會套用參數突變。

parameter_mutations[]

ParameterMutation

參數變動會定義新事件的參數行為,並依序套用。最多可套用 20 個變動。

EventEditRule

事件編輯規則會定義條件,根據來源事件的相符條件觸發建立全新事件。您可以定義來源事件參數的其他變動。

與事件建立規則不同,事件編輯規則會按照定義的順序套用。

事件編輯規則無法用來修改根據事件建立規則建立的事件。

欄位
name

string

ID。這個 EventEditRule 資源的資源名稱。Format: properties/{property}/dataStreams/{data_stream}/eventEditRules/{event_edit_rule}

display_name

string

必要欄位。這項事件編輯規則的顯示名稱。長度上限為 255 個半形字元。

event_conditions[]

MatchingCondition

必要欄位。來源事件必須符合條件,系統才會套用這項規則。至少須有一個條件,最多可有 10 個條件。

parameter_mutations[]

ParameterMutation

必要欄位。參數變動會定義新事件的參數行為,並依序套用。最多可套用 20 個變動。

processing_order

int64

僅供輸出。要處理這項規則的訂單。訂單價值低於此值的規則會先處理,訂單價值高於此值的規則則會稍後處理。新的事件編輯規則會在訂單結尾指派訂單價值。

這個值不適用於事件建立規則。

EventMapping

事件設定條件,用來比對事件。

欄位
event_name

string

必要欄位。Google Analytics 事件名稱。這個欄位必須一律設定。顯示名稱長度上限為 40 個 UTF-16 碼元。

min_event_count

int64

至少須設定下列四個最小值/最大值之一。系統會將設定的值以 AND 運算符合併,以判斷事件是否符合條件。事件發生的最少次數。如未設定,系統就不會檢查最低事件數。

max_event_count

int64

事件發生的次數上限。如未設定,系統就不會檢查事件數量上限。

min_event_value

double

活動帶來的最低收益。收益幣別會在房源層級定義。如未設定,系統就不會檢查事件價值是否達到最低門檻。

max_event_value

double

活動帶來的最高收益。收益幣別會在房源層級定義。如未設定,系統不會檢查事件價值上限。

ExpandedDataSet

代表 ExpandedDataSet 的資源訊息。

欄位
name

string

僅供輸出。這個 ExpandedDataSet 資源的資源名稱。格式:properties/{property_id}/expandedDataSets/{expanded_data_set}

display_name

string

必要欄位。ExpandedDataSet 的顯示名稱。最多 200 個半形字元。

description

string

(選用步驟) ExpandedDataSet 的說明。最多 50 個字元。

dimension_names[]

string

不可變更。ExpandedDataSet 中包含的維度清單。如需維度名稱清單,請參閱「API 維度」。

metric_names[]

string

不可變更。ExpandedDataSet 中包含的指標清單。如需維度名稱清單,請參閱「API 指標」。

dimension_filter_expression

ExpandedDataSetFilterExpression

不可變更。套用至 ExpandedDataSet 所含維度的 ExpandedDataSet 篩選器邏輯運算式。這個篩選器用於減少資料列數量,因此可降低遇到 other 資料列的機率。

data_collection_start_time

Timestamp

僅供輸出。擴展資料集開始 (或即將開始) 收集資料的時間。

ExpandedDataSetFilter

單一維度的特定篩選條件

欄位
field_name

string

必要欄位。要篩選的維度名稱。

聯集欄位 one_filter。上述任一篩選器。one_filter 只能是下列其中一項:
string_filter

StringFilter

字串類型維度的篩選器,符合特定模式。

in_list_filter

InListFilter

字串維度的篩選器,符合特定選項清單。

InListFilter

字串維度的篩選器,符合特定選項清單。

欄位
values[]

string

必要欄位。要比對的可能字串值清單。不得留空。

case_sensitive

bool

(選用步驟) 如果是 true,比對時會區分大小寫。如果設為 False,比對時不區分大小寫。必須為 true。

StringFilter

字串類型維度的篩選器,符合特定模式。

欄位
match_type

MatchType

必要欄位。字串篩選器的比對類型。

value

string

必要欄位。要比對的字串值。

case_sensitive

bool

(選用步驟) 如果是 true,比對時會區分大小寫。如果設為 False,比對時不區分大小寫。如果 match_type 為 EXACT,則必須為 true。如果 match_type 為 CONTAINS,則必須為 false。

MatchType

字串篩選器的比對類型。

列舉
MATCH_TYPE_UNSPECIFIED 未指定
EXACT 字串值完全相符。
CONTAINS 包含字串值。

ExpandedDataSetFilterExpression

EnhancedDataSet 維度篩選器的邏輯運算式。

欄位
聯集欄位 expr。套用至篩選器的運算式。expr 只能是下列其中一項:
and_group

ExpandedDataSetFilterExpressionList

要以 AND 運算符合併的運算式清單。其中必須包含 ExpandedDataSetFilterExpression,且含有 not_expression 或 dimension_filter。頂層 ExpandedDataSetFilterExpression 必須設定此值。

not_expression

ExpandedDataSetFilterExpression

要進行 NOT 運算的篩選器運算式 (即反轉、補數)。其中必須包含 dimension_filter。這項設定無法在頂層 ExpandedDataSetFilterExpression 中設定。

filter

ExpandedDataSetFilter

單一維度的篩選器。這項設定無法在頂層 ExpandedDataSetFilterExpression 中設定。

ExpandedDataSetFilterExpressionList

ExpandedDataSet 篩選器運算式清單。

欄位
filter_expressions[]

ExpandedDataSetFilterExpression

ExpandedDataSet 篩選器運算式清單。

GetAccessBindingRequest

GetAccessBinding RPC 的要求訊息。

欄位
name

string

必要欄位。要擷取的存取權繫結名稱。格式:- accounts/{account}/accessBindings/{accessBinding} - properties/{property}/accessBindings/{accessBinding}

GetAccountRequest

GetAccount RPC 的要求訊息。

欄位
name

string

必要欄位。要查詢的帳戶名稱。格式:accounts/{account} 範例:「accounts/100」

GetAdSenseLinkRequest

要傳遞至 GetAdSenseLink 方法的要求訊息。

欄位
name

string

必要欄位。所要求 AdSense 連結的專屬 ID。格式:properties/{propertyId}/adSenseLinks/{linkId} 範例:properties/1234/adSenseLinks/5678

GetAttributionSettingsRequest

GetAttributionSettings RPC 的要求訊息。

欄位
name

string

必要欄位。要擷取的歸因設定名稱,格式:properties/{property}/attributionSettings

GetAudienceRequest

GetAudience RPC 的要求訊息。

欄位
name

string

必要欄位。要取得的目標對象名稱。格式範例:properties/1234/audiences/5678

GetBigQueryLinkRequest

GetBigQueryLink RPC 的要求訊息。

欄位
name

string

必要欄位。要查閱的 BigQuery 連結名稱。格式:properties/{property_id}/bigQueryLinks/{bigquery_link_id} 範例:properties/123/bigQueryLinks/456

GetCalculatedMetricRequest

GetCalculatedMetric RPC 的要求訊息。

欄位
name

string

必要欄位。要取得的 CalculatedMetric 名稱。格式:properties/{property_id}/calculatedMetrics/{calculated_metric_id} 範例:properties/1234/calculatedMetrics/Metric01

GetChannelGroupRequest

GetChannelGroup RPC 的要求訊息。

欄位
name

string

必要欄位。要取得的 ChannelGroup。格式範例:properties/1234/channelGroups/5678

GetConversionEventRequest

GetConversionEvent RPC 的要求訊息

欄位
name

string

必要欄位。要擷取轉換事件的資源名稱。格式:properties/{property}/conversionEvents/{conversion_event} 範例:「properties/123/conversionEvents/456」

GetCustomDimensionRequest

GetCustomDimension RPC 的要求訊息。

欄位
name

string

必要欄位。要取得的 CustomDimension 名稱。格式範例:properties/1234/customDimensions/5678

GetCustomMetricRequest

GetCustomMetric RPC 的要求訊息。

欄位
name

string

必要欄位。要取得的 CustomMetric 名稱。格式範例:properties/1234/customMetrics/5678

GetDataRedactionSettingsRequest

GetDataRedactionSettings RPC 的要求訊息。

欄位
name

string

必要欄位。要查詢的設定名稱。格式:properties/{property}/dataStreams/{data_stream}/dataRedactionSettings 範例:「properties/1000/dataStreams/2000/dataRedactionSettings」

GetDataRetentionSettingsRequest

GetDataRetentionSettings RPC 的要求訊息。

欄位
name

string

必要欄位。要查詢的設定名稱。格式:properties/{property}/dataRetentionSettings。範例:「properties/1000/dataRetentionSettings」

GetDataSharingSettingsRequest

GetDataSharingSettings RPC 的要求訊息。

欄位
name

string

必要欄位。要查詢的設定名稱。格式:accounts/{account}/dataSharingSettings

範例:accounts/1000/dataSharingSettings

GetDataStreamRequest

GetDataStream RPC 的要求訊息。

欄位
name

string

必要欄位。要取得的 DataStream 名稱。格式範例:properties/1234/dataStreams/5678

GetDisplayVideo360AdvertiserLinkProposalRequest

GetDisplayVideo360AdvertiserLinkProposal RPC 的要求訊息。

欄位
name

string

必要欄位。要取得的 DisplayVideo360AdvertiserLinkProposal 名稱。格式範例:properties/1234/displayVideo360AdvertiserLinkProposals/5678

GetDisplayVideo360AdvertiserLinkRequest

GetDisplayVideo360AdvertiserLink RPC 的要求訊息。

欄位
name

string

必要欄位。要取得的 DisplayVideo360AdvertiserLink 名稱。格式範例:properties/1234/displayVideo360AdvertiserLink/5678

GetEnhancedMeasurementSettingsRequest

GetEnhancedMeasurementSettings RPC 的要求訊息。

欄位
name

string

必要欄位。要查詢的設定名稱。格式:properties/{property}/dataStreams/{data_stream}/enhancedMeasurementSettings 範例:「properties/1000/dataStreams/2000/enhancedMeasurementSettings」

GetEventCreateRuleRequest

GetEventCreateRule RPC 的要求訊息。

欄位
name

string

必要欄位。要取得的 EventCreateRule 名稱。格式範例:properties/123/dataStreams/456/eventCreateRules/789

GetEventEditRuleRequest

GetEventEditRule RPC 的要求訊息。

欄位
name

string

必要欄位。要擷取的 EventEditRule 名稱。格式範例:properties/123/dataStreams/456/eventEditRules/789

GetExpandedDataSetRequest

GetExpandedDataSet RPC 的要求訊息。

欄位
name

string

必要欄位。要取得的 ExpandedDataSet 名稱。格式範例:properties/1234/expandedDataSets/5678

GetGlobalSiteTagRequest

GetGlobalSiteTag RPC 的要求訊息。

欄位
name

string

必要欄位。要查詢的網站代碼名稱。請注意,網站代碼是單例,沒有專屬 ID。格式:properties/{property_id}/dataStreams/{stream_id}/globalSiteTag

範例:properties/123/dataStreams/456/globalSiteTag

GetGoogleSignalsSettingsRequest

GetGoogleSignalsSettings RPC 的要求訊息

欄位
name

string

必要欄位。要擷取的 Google 信號設定名稱。格式:properties/{property}/googleSignalsSettings

GetKeyEventRequest

GetKeyEvent RPC 的要求訊息

欄位
name

string

必要欄位。要擷取的重大事件資源名稱。格式:properties/{property}/keyEvents/{key_event} 範例:「properties/123/keyEvents/456」

GetMeasurementProtocolSecretRequest

GetMeasurementProtocolSecret RPC 的要求訊息。

欄位
name

string

必要欄位。要查詢的評估工作階段通訊協定密鑰名稱。格式:properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}

GetPropertyRequest

GetProperty RPC 的要求訊息。

欄位
name

string

必要欄位。要查詢的房源名稱。格式:properties/{property_id}。範例:「properties/1000」

GetReportingDataAnnotationRequest

GetReportingDataAnnotation RPC 的要求訊息。

欄位
name

string

必要欄位。要查閱的報表資料註解資源名稱。格式:properties/property_id/reportingDataAnnotations/reportingDataAnnotation 範例:properties/123/reportingDataAnnotations/456

GetReportingIdentitySettingsRequest

GetReportingIdentitySettings RPC 的要求訊息。

欄位
name

string

必要欄位。要查詢的設定名稱。格式:properties/{property}/reportingIdentitySettings。範例:「properties/1000/reportingIdentitySettings」

GetRollupPropertySourceLinkRequest

GetRollupPropertySourceLink RPC 的要求訊息。

欄位
name

string

必要欄位。要查詢的綜覽資源來源連結名稱。格式:properties/{property_id}/rollupPropertySourceLinks/{rollup_property_source_link_id} 範例:properties/123/rollupPropertySourceLinks/456

GetSKAdNetworkConversionValueSchemaRequest

GetSKAdNetworkConversionValueSchema RPC 的要求訊息。

欄位
name

string

必要欄位。要查詢的 SKAdNetwork 轉換價值結構定義的資源名稱。格式:properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema/{skadnetwork_conversion_value_schema}

GetSearchAds360LinkRequest

GetSearchAds360Link RPC 的要求訊息。

欄位
name

string

必要欄位。要擷取的 SearchAds360Link 名稱。格式範例:properties/1234/SearchAds360Link/5678

GetSubpropertyEventFilterRequest

GetSubpropertyEventFilter RPC 的要求訊息。

欄位
name

string

必要欄位。要查閱的子資源事件篩選器資源名稱。格式:properties/property_id/subpropertyEventFilters/subproperty_event_filter 範例:properties/123/subpropertyEventFilters/456

GetSubpropertySyncConfigRequest

GetSubpropertySyncConfig RPC 的要求訊息。

欄位
name

string

必要欄位。要查詢的 SubpropertySyncConfig 資源名稱。格式:properties/{ordinary_property_id}/subpropertySyncConfigs/{subproperty_id} 範例:properties/1234/subpropertySyncConfigs/5678

GlobalSiteTag

唯讀資源,內含用於將網站資料傳送至 DataStream 的代碼。僅適用於網站資料串流資源。

欄位
name

string

僅供輸出。這個 GlobalSiteTag 資源的資源名稱。格式:properties/{property_id}/dataStreams/{stream_id}/globalSiteTag 範例:「properties/123/dataStreams/456/globalSiteTag」

snippet

string

不可變更。請複製這段 JavaScript 程式碼片段,並在要評估的每個網頁中,將這段程式碼貼到 head 代碼中做為第一個項目。

GoogleSignalsConsent

Google 信號設定的同意聲明欄位。

列舉

GoogleSignalsSettings

Google 信號的設定值。這是單例資源。

欄位
name

string

僅供輸出。這項設定的資源名稱。格式:properties/{property_id}/googleSignalsSettings 範例:「properties/1000/googleSignalsSettings」

state

GoogleSignalsState

這項設定的狀態。

consent

GoogleSignalsConsent

僅供輸出。接受《服務條款》。

GoogleSignalsState

Google 信號設定的狀態。

列舉
GOOGLE_SIGNALS_STATE_UNSPECIFIED Google 信號狀態預設為 GOOGLE_SIGNALS_STATE_UNSPECIFIED,表示使用者尚未明確選擇。
GOOGLE_SIGNALS_ENABLED 已啟用 Google 信號。
GOOGLE_SIGNALS_DISABLED Google 信號已停用。

GroupingRule

這些規則會決定如何將流量歸入單一管道。

欄位
display_name

string

必要欄位。客戶為管道定義的顯示名稱。

expression

ChannelGroupFilterExpression

必要欄位。定義分組規則的篩選器運算式。

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

string

僅供輸出。這項重要事件的資源名稱。格式:properties/{property}/keyEvents/{key_event}

event_name

string

不可變更。這項重要事件的事件名稱。例如:「click」、「purchase」

create_time

Timestamp

僅供輸出。在資源中建立這項重要事件的時間。

deletable

bool

僅供輸出。如果設為 true,即可刪除這項活動。

custom

bool

僅供輸出。如果設為 true,這個重要事件是指自訂事件。如果設為 false,這個重要事件是指 Google Analytics 中的預設事件。預設事件通常在 Google Analytics 中具有特殊意義。預設事件通常是由 Google Analytics 系統為您建立,但有時資源管理員也會建立預設事件。自訂事件會計入每個資源可建立的自訂重要事件數量上限。

counting_method

CountingMethod

必要欄位。計算工作階段中多個事件的重要事件時所用的方法。

default_value

DefaultValue

(選用步驟) 定義重要事件的預設價值/幣別。

CountingMethod

計算工作階段中多個事件的重要事件時所用的方法。

列舉
COUNTING_METHOD_UNSPECIFIED 未指定計算方法。
ONCE_PER_EVENT 每個 Event 執行個體都會視為重要事件。
ONCE_PER_SESSION 每個使用者在每個工作階段中,最多只會將一個事件例項視為重要事件。

DefaultValue

定義重要事件的預設價值/幣別。

欄位
numeric_value

double

必要欄位。如果「value」參數未設定,系統就會使用這個值,填入所有出現這個重要事件 (由 event_name 指定) 的「value」參數。

currency_code

string

必要欄位。如果這個重要事件 (由 event_name 指定) 的發生次數未設定幣別,系統會套用這個幣別做為預設值。必須採用 ISO 4217 貨幣代碼格式。

詳情請參閱 https://en.wikipedia.org/wiki/ISO_4217

LinkProposalInitiatingProduct

指出使用者從哪個產品發起連結提案。

列舉
GOOGLE_ANALYTICS 這份提案是由 Google Analytics 使用者建立。
LINKED_PRODUCT 這項提案是由連結產品 (而非 Google Analytics) 的使用者建立。

LinkProposalState

連結提案資源的狀態。

列舉
AWAITING_REVIEW_FROM_GOOGLE_ANALYTICS 這項提案尚待 Google Analytics 使用者審查。這項提案會在一段時間後自動失效。
AWAITING_REVIEW_FROM_LINKED_PRODUCT 這項提案正在等待連結產品的使用者審查。這項提案會在一段時間後自動失效。
WITHDRAWN 提案已由發起產品的管理員撤銷。這項提案會在一段時間後自動刪除。
DECLINED 接收產品的管理員已拒絕這項提案。這項提案會在一段時間後自動刪除。
EXPIRED 由於接收產品的管理員未回覆,這項提案已過期。這項提案會在一段時間後自動刪除。
OBSOLETE 由於系統已直接建立連結至此提案指定的相同外部產品資源,因此這項提案已過時。這項提案會在一段時間後自動刪除。

LinkProposalStatusDetails

連結提案的狀態資訊。

欄位
requestor_email

string

僅供輸出。提議連結的使用者電子郵件地址。

ListAccessBindingsRequest

ListAccessBindings RPC 的要求訊息。

欄位
parent

string

必要欄位。格式:- accounts/{account} - properties/{property}

page_size

int32

要傳回的存取權繫結數量上限。服務傳回的產品數量可能會少於這個值。如未指定,最多將傳回 200 個存取權繫結。許可的最大值為 500;超出的數值將一律指定為 500。

page_token

string

屬於接收自前一個 ListAccessBindings 呼叫的網頁權杖。提供此項目即可擷取後續網頁。進行分頁時,提供至 ListAccessBindings 的所有其他參數須與提供網頁權杖的呼叫相符。

ListAccessBindingsResponse

ListAccessBindings RPC 的回應訊息。

欄位
access_bindings[]

AccessBinding

AccessBinding 清單。這些項目會穩定排序,但順序任意。

next_page_token

string

可做為 page_token 傳送的權杖,用於擷取後續網頁。如果省略這個欄位,就不會有後續頁面。

ListAccountSummariesRequest

ListAccountSummaries RPC 的要求訊息。

欄位
page_size

int32

要傳回的 AccountSummary 資源數上限。即使有其他頁面,服務傳回的產品數量也可能會少於這個值。如未指定,最多將傳回 50 項資源。最大值為 200 (超過最大值的值會強制設為最大值)

page_token

string

屬於接收自前一個 ListAccountSummaries 呼叫的網頁權杖。提供此項目即可擷取後續網頁。進行分頁時,提供至 ListAccountSummaries 的所有其他參數須與提供網頁權杖的呼叫相符。

ListAccountSummariesResponse

ListAccountSummaries RPC 的回應訊息。

欄位
account_summaries[]

AccountSummary

呼叫方有權存取的所有帳戶摘要。

next_page_token

string

可做為 page_token 傳送的權杖,用於擷取後續網頁。如果省略這個欄位,就不會有後續頁面。

ListAccountsRequest

ListAccounts RPC 的要求訊息。

欄位
page_size

int32

要傳回的資源數上限。即使有其他頁面,服務傳回的產品數量也可能會少於這個值。如未指定,最多將傳回 50 項資源。最大值為 200 (超過最大值的值會強制設為最大值)

page_token

string

屬於接收自前一個 ListAccounts 呼叫的網頁權杖。提供此項目即可擷取後續網頁。進行分頁時,提供至 ListAccounts 的所有其他參數須與提供網頁權杖的呼叫相符。

show_deleted

bool

是否要在結果中納入虛刪除 (即「已刪除」) 的帳戶。您可以檢查帳戶是否已刪除。

ListAccountsResponse

ListAccounts RPC 的要求訊息。

欄位
accounts[]

Account

呼叫者可存取的結果。

next_page_token

string

可做為 page_token 傳送的權杖,用於擷取後續網頁。如果省略這個欄位,就不會有後續頁面。

ListAdSenseLinksRequest

要求訊息會傳遞至 ListAdSenseLinks 方法。

欄位
parent

string

必要欄位。父項資源的資源名稱。格式:properties/{propertyId} 範例:properties/1234

page_size

int32

要傳回的資源數上限。如未指定,最多將傳回 50 項資源。最大值為 200 (如果值大於 200,系統會強制設為最大值)。

page_token

string

接收自前一個 ListAdSenseLinks 呼叫的網頁權杖。提供此項目即可擷取後續網頁。

進行分頁時,提供至 ListAdSenseLinks 的所有其他參數須與提供網頁權杖的呼叫相符。

ListAdSenseLinksResponse

ListAdSenseLinks 方法的回應訊息。

欄位
next_page_token

string

可做為 page_token 傳送的權杖,用於擷取後續網頁。如果省略這個欄位,就不會有後續頁面。

ListAudiencesRequest

ListAudiences 遠端程序呼叫的要求訊息。

欄位
parent

string

必要欄位。格式範例:properties/1234

page_size

int32

要傳回的資源數上限。如未指定,最多將傳回 50 項資源。最大值為 200 (如果值大於 200,系統會強制設為最大值)。

page_token

string

屬於接收自前一個 ListAudiences 呼叫的網頁權杖。提供此項目即可擷取後續網頁。

進行分頁時,提供至 ListAudiences 的所有其他參數須與提供網頁權杖的呼叫相符。

ListAudiencesResponse

ListAudiences 遠端程序呼叫的回應訊息。

欄位
audiences[]

Audience

目標對象清單。

next_page_token

string

可做為 page_token 傳送的權杖,用於擷取後續網頁。如果省略這個欄位,就不會有後續頁面。

ListBigQueryLinksRequest

ListBigQueryLinks RPC 的要求訊息。

欄位
parent

string

必要欄位。要列出 BigQuery 連結的資源名稱。格式:properties/{property_id} 範例:properties/1234

page_size

int32

要傳回的資源數上限。即使有其他頁面,服務傳回的產品數量也可能會少於這個值。如未指定,最多將傳回 50 項資源。最大值為 200 (超過最大值的值會強制設為最大值)

page_token

string

屬於接收自前一個 ListBigQueryLinks 呼叫的網頁權杖。提供此項目即可擷取後續網頁。進行分頁時,提供至 ListBigQueryLinks 的所有其他參數須與提供網頁權杖的呼叫相符。

ListBigQueryLinksResponse

ListBigQueryLinks RPC 的回應訊息

欄位
next_page_token

string

可做為 page_token 傳送的權杖,用於擷取後續網頁。如果省略這個欄位,就不會有後續頁面。

ListCalculatedMetricsRequest

ListCalculatedMetrics RPC 的要求訊息。

欄位
parent

string

必要欄位。格式範例:properties/1234

page_size

int32

(選用步驟) 要傳回的資源數上限。如未指定,最多將傳回 50 項資源。最大值為 200 (如果值大於 200,系統會強制設為最大值)。

page_token

string

(選用步驟) 屬於接收自前一個 ListCalculatedMetrics 呼叫的網頁權杖。提供此項目即可擷取後續網頁。

進行分頁時,提供至 ListCalculatedMetrics 的所有其他參數須與提供網頁權杖的呼叫相符。

ListCalculatedMetricsResponse

ListCalculatedMetrics RPC 的回應訊息。

欄位
calculated_metrics[]

CalculatedMetric

CalculatedMetrics 清單。

next_page_token

string

可做為 page_token 傳送的權杖,用於擷取後續網頁。如果省略這個欄位,就不會有後續頁面。

ListChannelGroupsRequest

ListChannelGroups RPC 的要求訊息。

欄位
parent

string

必要欄位。要列出 ChannelGroups 的屬性。格式範例:properties/1234

page_size

int32

要傳回的資源數上限。如未指定,最多將傳回 50 項資源。最大值為 200 (如果值大於 200,系統會強制設為最大值)。

page_token

string

屬於接收自前一個 ListChannelGroups 呼叫的網頁權杖。提供此項目即可擷取後續網頁。

進行分頁時,提供至 ListChannelGroups 的所有其他參數須與提供網頁權杖的呼叫相符。

ListChannelGroupsResponse

ListChannelGroups RPC 的回應訊息。

欄位
channel_groups[]

ChannelGroup

ChannelGroup 清單。這些項目會穩定排序,但順序任意。

next_page_token

string

可做為 page_token 傳送的權杖,用於擷取後續網頁。如果省略這個欄位,就不會有後續頁面。

ListConversionEventsRequest

ListConversionEvents RPC 的要求訊息

欄位
parent

string

必要欄位。父項資源的資源名稱。例如:「properties/123」

page_size

int32

要傳回的資源數上限。如未指定,最多將傳回 50 項資源。最大值為 200 (超過最大值的值會強制設為最大值)

page_token

string

屬於接收自前一個 ListConversionEvents 呼叫的網頁權杖。提供此項目即可擷取後續網頁。進行分頁時,提供至 ListConversionEvents 的所有其他參數須與提供網頁權杖的呼叫相符。

ListConversionEventsResponse

ListConversionEvents 遠端程序呼叫的回應訊息。

欄位
conversion_events[]

ConversionEvent

要求的轉換事件

next_page_token

string

可做為 page_token 傳送的權杖,用於擷取後續網頁。如果省略這個欄位,就不會有後續頁面。

ListCustomDimensionsRequest

ListCustomDimensions RPC 的要求訊息。

欄位
parent

string

必要欄位。格式範例:properties/1234

page_size

int32

要傳回的資源數上限。如未指定,最多將傳回 50 項資源。最大值為 200 (如果值大於 200,系統會強制設為最大值)。

page_token

string

屬於接收自前一個 ListCustomDimensions 呼叫的網頁權杖。提供此項目即可擷取後續網頁。

進行分頁時,提供至 ListCustomDimensions 的所有其他參數須與提供網頁權杖的呼叫相符。

ListCustomDimensionsResponse

ListCustomDimensions RPC 的回應訊息。

欄位
custom_dimensions[]

CustomDimension

CustomDimensions 清單。

next_page_token

string

可做為 page_token 傳送的權杖,用於擷取後續網頁。如果省略這個欄位,就不會有後續頁面。

ListCustomMetricsRequest

ListCustomMetrics RPC 的要求訊息。

欄位
parent

string

必要欄位。格式範例:properties/1234

page_size

int32

要傳回的資源數上限。如未指定,最多將傳回 50 項資源。最大值為 200 (如果值大於 200,系統會強制設為最大值)。

page_token

string

屬於接收自前一個 ListCustomMetrics 呼叫的網頁權杖。提供此項目即可擷取後續網頁。

進行分頁時,提供至 ListCustomMetrics 的所有其他參數須與提供網頁權杖的呼叫相符。

ListCustomMetricsResponse

ListCustomMetrics RPC 的回應訊息。

欄位
custom_metrics[]

CustomMetric

CustomMetrics 清單。

next_page_token

string

可做為 page_token 傳送的權杖,用於擷取後續網頁。如果省略這個欄位,就不會有後續頁面。

ListDataStreamsRequest

ListDataStreams RPC 的要求訊息。

欄位
parent

string

必要欄位。格式範例:properties/1234

page_size

int32

要傳回的資源數上限。如未指定,最多將傳回 50 項資源。最大值為 200 (如果值大於 200,系統會強制設為最大值)。

page_token

string

屬於接收自前一個 ListDataStreams 呼叫的網頁權杖。提供此項目即可擷取後續網頁。

進行分頁時,提供至 ListDataStreams 的所有其他參數須與提供網頁權杖的呼叫相符。

ListDataStreamsResponse

ListDataStreams RPC 的回應訊息。

欄位
data_streams[]

DataStream

資料串流清單。

next_page_token

string

可做為 page_token 傳送的權杖,用於擷取後續網頁。如果省略這個欄位,就不會有後續頁面。

ListDisplayVideo360AdvertiserLinkProposalsRequest

ListDisplayVideo360AdvertiserLinkProposals RPC 的要求訊息。

欄位
parent

string

必要欄位。格式範例:properties/1234

page_size

int32

要傳回的資源數上限。如未指定,最多將傳回 50 項資源。最大值為 200 (如果值大於 200,系統會強制設為最大值)。

page_token

string

屬於接收自前一個 ListDisplayVideo360AdvertiserLinkProposals 呼叫的網頁權杖。提供此項目即可擷取後續網頁。

進行分頁時,提供至 ListDisplayVideo360AdvertiserLinkProposals 的所有其他參數須與提供網頁權杖的呼叫相符。

ListDisplayVideo360AdvertiserLinkProposalsResponse

ListDisplayVideo360AdvertiserLinkProposals RPC 的回應訊息。

欄位
next_page_token

string

可做為 page_token 傳送的權杖,用於擷取後續網頁。如果省略這個欄位,就不會有後續頁面。

ListDisplayVideo360AdvertiserLinksRequest

ListDisplayVideo360AdvertiserLinks RPC 的要求訊息。

欄位
parent

string

必要欄位。格式範例:properties/1234

page_size

int32

要傳回的資源數上限。如未指定,最多將傳回 50 項資源。最大值為 200 (如果值大於 200,系統會強制設為最大值)。

page_token

string

屬於接收自前一個 ListDisplayVideo360AdvertiserLinks 呼叫的網頁權杖。提供此項目即可擷取後續網頁。

進行分頁時,提供至 ListDisplayVideo360AdvertiserLinks 的所有其他參數須與提供網頁權杖的呼叫相符。

ListDisplayVideo360AdvertiserLinksResponse

ListDisplayVideo360AdvertiserLinks RPC 的回應訊息。

欄位
next_page_token

string

可做為 page_token 傳送的權杖,用於擷取後續網頁。如果省略這個欄位,就不會有後續頁面。

ListEventCreateRulesRequest

ListEventCreateRules RPC 的要求訊息。

欄位
parent

string

必要欄位。格式範例:properties/123/dataStreams/456

page_size

int32

要傳回的資源數上限。如未指定,最多將傳回 50 項資源。最大值為 200 (如果值大於 200,系統會強制設為最大值)。

page_token

string

屬於接收自前一個 ListEventCreateRules 呼叫的網頁權杖。提供此項目即可擷取後續網頁。

進行分頁時,提供至 ListEventCreateRules 的所有其他參數須與提供網頁權杖的呼叫相符。

ListEventCreateRulesResponse

ListEventCreateRules RPC 的回應訊息。

欄位
event_create_rules[]

EventCreateRule

EventCreateRule 清單。這些項目會穩定排序,但順序任意。

next_page_token

string

可做為 page_token 傳送的權杖,用於擷取後續網頁。如果省略這個欄位,就不會有後續頁面。

ListEventEditRulesRequest

ListEventEditRules RPC 的要求訊息。

欄位
parent

string

必要欄位。格式範例:properties/123/dataStreams/456

page_size

int32

(選用步驟) 要傳回的資源數上限。如未指定,最多將傳回 50 項資源。最大值為 200 (如果值大於 200,系統會強制設為最大值)。

page_token

string

(選用步驟) 屬於接收自前一個 ListEventEditRules 呼叫的網頁權杖。提供此項目即可擷取後續網頁。

進行分頁時,提供至 ListEventEditRules 的所有其他參數須與提供網頁權杖的呼叫相符。

ListEventEditRulesResponse

ListEventEditRules RPC 的回應訊息。

欄位
event_edit_rules[]

EventEditRule

EventEditRule 清單。這些項目會穩定排序,但順序任意。

next_page_token

string

可做為 page_token 傳送的權杖,用於擷取後續網頁。如果省略這個欄位,就不會有後續頁面。

ListExpandedDataSetsRequest

ListExpandedDataSets RPC 的要求訊息。

欄位
parent

string

必要欄位。格式範例:properties/1234

page_size

int32

要傳回的資源數上限。如未指定,最多將傳回 50 項資源。最大值為 200 (如果值大於 200,系統會強制設為最大值)。

page_token

string

屬於接收自前一個 ListExpandedDataSets 呼叫的網頁權杖。提供此項目即可擷取後續網頁。

進行分頁時,提供至 ListExpandedDataSet 的所有其他參數須與提供網頁權杖的呼叫相符。

ListExpandedDataSetsResponse

ListExpandedDataSets RPC 的回應訊息。

欄位
expanded_data_sets[]

ExpandedDataSet

ExpandedDataSet 清單。這些項目會穩定排序,但順序任意。

next_page_token

string

可做為 page_token 傳送的權杖,用於擷取後續網頁。如果省略這個欄位,就不會有後續頁面。

ListFirebaseLinksRequest

ListFirebaseLinks RPC 的要求訊息

欄位
parent

string

必要欄位。格式:properties/{property_id}

範例:properties/1234

page_size

int32

要傳回的資源數上限。即使有其他頁面,服務傳回的產品數量也可能會少於這個值。如未指定,最多將傳回 50 項資源。最大值為 200 (超過最大值的值會強制設為最大值)

page_token

string

屬於接收自前一個 ListFirebaseLinks 呼叫的網頁權杖。提供此項目即可擷取後續網頁。進行分頁時,提供至 ListFirebaseLinks 的所有其他參數須與提供網頁權杖的呼叫相符。

ListFirebaseLinksResponse

ListFirebaseLinks 遠端程序呼叫的回應訊息

欄位
next_page_token

string

可做為 page_token 傳送的權杖,用於擷取後續網頁。如果省略這個欄位,就不會有後續頁面。目前 Google Analytics 每個資源只支援一個 FirebaseLink,因此這個欄位永遠不會填入資料。

ListGoogleAdsLinksRequest

ListGoogleAdsLinks RPC 的要求訊息。

欄位
parent

string

必要欄位。格式範例:properties/1234

page_size

int32

要傳回的資源數上限。如未指定,最多將傳回 50 項資源。最大值為 200 (如果值大於 200,系統會強制設為最大值)。

page_token

string

屬於接收自前一個 ListGoogleAdsLinks 呼叫的網頁權杖。提供此項目即可擷取後續網頁。

進行分頁時,提供至 ListGoogleAdsLinks 的所有其他參數須與提供網頁權杖的呼叫相符。

ListGoogleAdsLinksResponse

ListGoogleAdsLinks RPC 的回應訊息。

欄位
next_page_token

string

可做為 page_token 傳送的權杖,用於擷取後續網頁。如果省略這個欄位,就不會有後續頁面。

ListKeyEventsRequest

ListKeyEvents RPC 的要求訊息

欄位
parent

string

必要欄位。父項資源的資源名稱。例如:「properties/123」

page_size

int32

要傳回的資源數上限。如未指定,最多將傳回 50 項資源。最大值為 200 (超過最大值的值會強制設為最大值)

page_token

string

屬於接收自前一個 ListKeyEvents 呼叫的網頁權杖。提供此項目即可擷取後續網頁。進行分頁時,提供至 ListKeyEvents 的所有其他參數須與提供網頁權杖的呼叫相符。

ListKeyEventsResponse

ListKeyEvents 遠端程序呼叫的回應訊息。

欄位
key_events[]

KeyEvent

要求的「重要事件」

next_page_token

string

可做為 page_token 傳送的權杖,用於擷取後續網頁。如果省略這個欄位,就不會有後續頁面。

ListMeasurementProtocolSecretsRequest

ListMeasurementProtocolSecret RPC 的要求訊息

欄位
parent

string

必要欄位。父項串流的資源名稱。格式:properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets

page_size

int32

要傳回的資源數上限。如未指定,最多將傳回 10 個資源。值的上限為 10。如果值超過上限,系統會強制設為上限。

page_token

string

屬於接收自前一個 ListMeasurementProtocolSecrets 呼叫的網頁權杖。提供此項目即可擷取後續網頁。進行分頁時,提供至 ListMeasurementProtocolSecrets 的所有其他參數須與提供網頁權杖的呼叫相符。

ListMeasurementProtocolSecretsResponse

ListMeasurementProtocolSecret RPC 的回應訊息

欄位
measurement_protocol_secrets[]

MeasurementProtocolSecret

要求中指定父項串流的密鑰清單。

next_page_token

string

可做為 page_token 傳送的權杖,用於擷取後續網頁。如果省略這個欄位,就不會有後續頁面。

ListPropertiesRequest

ListProperties RPC 的要求訊息。

欄位
filter

string

必要欄位。用於篩選要求結果的運算式。適用篩選功能的欄位包括:parent:(上層帳戶/資源的資源名稱)、ancestor:(上層帳戶的資源名稱) 或 firebase_project:(已連結 Firebase 專案的 ID 或編號)。篩選器範例:

| Filter                      | Description                               |
|-----------------------------|-------------------------------------------|
| parent:accounts/123         | The account with account id: 123.       |
| parent:properties/123       | The property with property id: 123.       |
| ancestor:accounts/123       | The account with account id: 123.         |
| firebase_project:project-id | The firebase project with id: project-id. |
| firebase_project:123        | The firebase project with number: 123.    |
page_size

int32

要傳回的資源數上限。即使有其他頁面,服務傳回的產品數量也可能會少於這個值。如未指定,最多將傳回 50 項資源。最大值為 200 (超過最大值的值會強制設為最大值)

page_token

string

屬於接收自前一個 ListProperties 呼叫的網頁權杖。提供此項目即可擷取後續網頁。進行分頁時,提供至 ListProperties 的所有其他參數須與提供網頁權杖的呼叫相符。

show_deleted

bool

是否要在結果中納入已軟刪除 (即「已移至垃圾桶」) 的資源。您可以檢查屬性,判斷是否已刪除。

ListPropertiesResponse

ListProperties 遠端程序呼叫的回應訊息。

欄位
properties[]

Property

符合篩選條件且來電者可存取的結果。

next_page_token

string

可做為 page_token 傳送的權杖,用於擷取後續網頁。如果省略這個欄位,就不會有後續頁面。

ListReportingDataAnnotationsRequest

ListReportingDataAnnotation RPC 的要求訊息。

欄位
parent

string

必要欄位。房源的資源名稱。格式:properties/property_id 範例:properties/123

filter

string

(選用步驟) 篩選器,可限制列出父項資源下的哪些報表資料註解。

支援的欄位如下:

  • 「名稱」
  • title
  • description
  • annotation_date
  • annotation_date_range
  • color

此外,這個 API 還提供下列輔助函式:

  • annotation_duration():這個註解標記的時間長度,即 durations。請輸入秒數的數字表示法,並加上 s 後置字元。
  • is_annotation_in_range(start_date, end_date):如果註解位於 start_dateend_date 指定的範圍內。日期採用 ISO-8601 格式,例如 2031-06-28

支援的作業:

  • =:等於
  • !=:不等於
  • <:小於
  • >:大於
  • <=:小於或等於
  • >=:大於或等於
  • ::有運算子
  • =~規則運算式比對
  • !~規則運算式不相符
  • NOT:邏輯 NOT
  • AND:邏輯 AND
  • OR:邏輯 OR

範例:

  1. title="Holiday Sale"
  2. description=~"[Bb]ig [Gg]ame.*[Ss]ale"
  3. is_annotation_in_range("2025-12-25", "2026-01-16") = true
  4. annotation_duration() >= 172800s AND title:BOGO
page_size

int32

(選用步驟) 要傳回的資源數上限。即使有其他頁面,服務傳回的產品數量也可能會少於這個值。如未指定,最多將傳回 50 項資源。最大值為 200 (超過最大值的值會強制設為最大值)

page_token

string

(選用步驟) 屬於接收自前一個 ListReportingDataAnnotations 呼叫的網頁權杖。提供此項目即可擷取後續網頁。進行分頁時,提供至 ListReportingDataAnnotations 的所有其他參數須與提供網頁權杖的呼叫相符。

ListReportingDataAnnotationsResponse

ListReportingDataAnnotation RPC 的回應訊息。

欄位
reporting_data_annotations[]

ReportingDataAnnotation

報表資料註解清單。

next_page_token

string

可做為 page_token 傳送的權杖,用於擷取後續網頁。如果省略這個欄位,就不會有後續頁面。

ListRollupPropertySourceLinksRequest

ListRollupPropertySourceLinks RPC 的要求訊息。

欄位
parent

string

必要欄位。要列出綜覽資源來源連結的綜覽資源名稱。格式:properties/{property_id} 範例:properties/1234

page_size

int32

(選用步驟) 要傳回的資源數上限。即使有其他頁面,服務傳回的產品數量也可能會少於這個值。如未指定,最多將傳回 50 項資源。最大值為 200 (超過最大值的值會強制設為最大值)

page_token

string

(選用步驟) 屬於接收自前一個 ListRollupPropertySourceLinks 呼叫的網頁權杖。提供此項目即可擷取後續網頁。進行分頁時,提供至 ListRollupPropertySourceLinks 的所有其他參數須與提供網頁權杖的呼叫相符。

ListRollupPropertySourceLinksResponse

ListRollupPropertySourceLinks RPC 的回應訊息。

欄位
next_page_token

string

可做為 page_token 傳送的權杖,用於擷取後續網頁。如果省略這個欄位,就不會有後續頁面。

ListSKAdNetworkConversionValueSchemasRequest

ListSKAdNetworkConversionValueSchemas RPC 的要求訊息

欄位
parent

string

必要欄位。要列出結構定義的 DataStream 資源。格式:properties/{property_id}/dataStreams/{dataStream} 範例:properties/1234/dataStreams/5678

page_size

int32

要傳回的資源數上限。即使有其他頁面,服務傳回的產品數量也可能會少於這個值。如未指定,最多將傳回 50 項資源。最大值為 200 (超過最大值的值會強制設為最大值)

page_token

string

屬於接收自前一個 ListSKAdNetworkConversionValueSchemas 呼叫的網頁權杖。提供此項目即可擷取後續網頁。進行分頁時,提供至 ListSKAdNetworkConversionValueSchema 的所有其他參數須與提供網頁權杖的呼叫相符。

ListSKAdNetworkConversionValueSchemasResponse

ListSKAdNetworkConversionValueSchemas 遠端程序呼叫的回應訊息

欄位
skadnetwork_conversion_value_schemas[]

SKAdNetworkConversionValueSchema

SKAdNetworkConversionValueSchemas 清單。最多只會有一個值。

next_page_token

string

可做為 page_token 傳送的權杖,用於擷取後續網頁。如果省略這個欄位,就不會有後續頁面。目前 Google Analytics 每個 dataStream 只支援一個 SKAdNetworkConversionValueSchema,因此這個欄位永遠不會填入資料。

ListSearchAds360LinksRequest

ListSearchAds360Links RPC 的要求訊息。

欄位
parent

string

必要欄位。格式範例:properties/1234

page_size

int32

要傳回的資源數上限。如未指定,最多將傳回 50 項資源。最大值為 200 (如果值大於 200,系統會強制設為最大值)。

page_token

string

屬於接收自前一個 ListSearchAds360Links 呼叫的網頁權杖。提供此項目即可擷取後續網頁。

進行分頁時,提供至 ListSearchAds360Links 的所有其他參數須與提供網頁權杖的呼叫相符。

ListSearchAds360LinksResponse

ListSearchAds360Links RPC 的回應訊息。

欄位
next_page_token

string

可做為 page_token 傳送的權杖,用於擷取後續網頁。如果省略這個欄位,就不會有後續頁面。

ListSubpropertyEventFiltersRequest

ListSubpropertyEventFilters RPC 的要求訊息。

欄位
parent

string

必要欄位。一般資源的資源名稱。格式:properties/property_id 範例:properties/123

page_size

int32

(選用步驟) 要傳回的資源數上限。即使有其他頁面,服務傳回的產品數量也可能會少於這個值。如未指定,最多將傳回 50 項資源。最大值為 200 (超過最大值的值會強制設為最大值)

page_token

string

(選用步驟) 屬於接收自前一個 ListSubpropertyEventFilters 呼叫的網頁權杖。提供此項目即可擷取後續網頁。進行分頁時,提供至 ListSubpropertyEventFilters 的所有其他參數須與提供網頁權杖的呼叫相符。

ListSubpropertyEventFiltersResponse

ListSubpropertyEventFilter 遠端程序呼叫的回應訊息。

欄位
subproperty_event_filters[]

SubpropertyEventFilter

子資源事件篩選器清單。

next_page_token

string

可做為 page_token 傳送的權杖,用於擷取後續網頁。如果省略這個欄位,就不會有後續頁面。

ListSubpropertySyncConfigsRequest

ListSubpropertySyncConfigs RPC 的要求訊息。

欄位
parent

string

必要欄位。房源的資源名稱。格式:properties/property_id 範例:properties/123

page_size

int32

(選用步驟) 要傳回的資源數上限。即使有其他頁面,服務傳回的產品數量也可能會少於這個值。如未指定,最多將傳回 50 項資源。最大值為 200 (超過最大值的值會強制設為最大值)

page_token

string

(選用步驟) 屬於接收自前一個 ListSubpropertySyncConfig 呼叫的網頁權杖。提供此項目即可擷取後續網頁。進行分頁時,提供至 ListSubpropertySyncConfig 的所有其他參數須與提供網頁權杖的呼叫相符。

ListSubpropertySyncConfigsResponse

ListSubpropertySyncConfigs RPC 的回應訊息。

欄位
subproperty_sync_configs[]

SubpropertySyncConfig

SubpropertySyncConfig 項資源的清單。

next_page_token

string

可做為 page_token 傳送的權杖,用於擷取後續網頁。如果省略這個欄位,就不會有後續頁面。

MatchingCondition

定義事件編輯或事件建立規則套用至事件的條件。

欄位
field

string

必要欄位。條件中用於比較的欄位名稱。如果指定了「event_name」,這項條件就會套用至事件名稱。否則條件會套用至具有指定名稱的參數。

這個值不得包含空格。

comparison_type

ComparisonType

必要欄位。要套用至值的比較類型。

value

string

必要欄位。這個條件要比較的值。執行階段實作可能會強制轉換這個值,根據參數值的類型評估這個條件。

negated

bool

是否應否定比較結果。舉例來說,如果 negated 為 true,則「equals」比較會以「not equals」的形式運作。

ComparisonType

比對條件的比較類型

列舉
COMPARISON_TYPE_UNSPECIFIED 不明
EQUALS 等於 (區分大小寫)
EQUALS_CASE_INSENSITIVE 等於 (不區分大小寫)
CONTAINS 包含 (區分大小寫)
CONTAINS_CASE_INSENSITIVE 包含 (不區分大小寫)
STARTS_WITH 開頭為 (區分大小寫)
STARTS_WITH_CASE_INSENSITIVE 開頭為 (不區分大小寫)
ENDS_WITH 結尾為 (區分大小寫)
ENDS_WITH_CASE_INSENSITIVE 結尾為 (不區分大小寫)
GREATER_THAN 大於
GREATER_THAN_OR_EQUAL 大於或等於
LESS_THAN 小於
LESS_THAN_OR_EQUAL 小於或等於
REGULAR_EXPRESSION 規則運算式。僅支援網站資料串流。
REGULAR_EXPRESSION_CASE_INSENSITIVE 規則運算式 (不區分大小寫)。僅支援網站資料串流。

MeasurementProtocolSecret

用於將命中傳送至 Measurement Protocol 的密鑰值。

欄位
name

string

僅供輸出。這個密鑰的資源名稱。這項密鑰可以是任何類型的串流子項。格式:properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}

display_name

string

必要欄位。這項密鑰的使用者可理解顯示名稱。

secret_value

string

僅供輸出。Measurement Protocol 密鑰值。將這個值傳遞至 Measurement Protocol API 的 api_secret 欄位,即可將命中傳送至這個密鑰的父項資源。

NumericValue

代表數字。

欄位
聯集欄位 one_value。數值 one_value 只能是下列其中一項:
int64_value

int64

整數值

double_value

double

雙重值

ParameterMutation

定義要變動的事件參數。

欄位
parameter

string

必要欄位。要變更的參數名稱。這個值必須:* 少於 40 個字元。* 在規則內的所有變動中必須是專屬名稱 * 只能包含英文字母、數字或 _ (底線) 如果是事件編輯規則,名稱也可以設為「event_name」,以便就地修改 event_name。

parameter_value

string

必要欄位。要執行的值突變。* 不得超過 100 個字元。* 如要為參數指定常數值,請使用該值的字串。* 如要從其他參數複製值,請使用「[[other_parameter]]」這類語法。詳情請參閱這篇說明中心文章

PostbackWindow

SKAdNetwork 轉換回傳回溯期設定。

欄位
conversion_values[]

ConversionValues

系統會根據重複欄位的順序,決定轉換價值設定的優先順序。索引值越低的項目優先順序越高。系統會選取第一個評估結果為 true 的轉換價值設定。如果 enable_postback_window_settings 設為 true,則至少須有一個項目。最多可輸入 128 個項目。

postback_window_settings_enabled

bool

如果 enable_postback_window_settings 為 true,則必須填入 conversion_values,系統會使用這些值判斷何時及如何設定用戶端裝置的轉換價值,並將結構定義匯出至已連結的 Google Ads 帳戶。如果為 false,系統不會使用這些設定,但會保留這些設定,以備日後使用。postback_window_one 一律必須符合這項條件。

屬性

代表 Google Analytics 資源的資源訊息。

欄位
name

string

僅供輸出。這個資源的名稱。格式:properties/{property_id}。範例:「properties/1000」

property_type

PropertyType

不可變更。這個資源的房源類型。建立資源時,如果類型為「PROPERTY_TYPE_UNSPECIFIED」,則會隱含「ORDINARY_PROPERTY」。

create_time

Timestamp

僅供輸出。實體的原始建立時間。

update_time

Timestamp

僅供輸出。實體酬載欄位上次更新的時間。

parent

string

不可變更。這個資源的邏輯父項資源名稱。

注意:您可以使用「移動資源」使用者介面變更父項。格式:accounts/{account}、properties/{property}。範例:「accounts/100」、「properties/101」

display_name

string

必要欄位。這項資源的使用者可理解顯示名稱。

顯示名稱長度上限為 100 個 UTF-16 程式碼單元。

industry_category

IndustryCategory

與這個房源相關聯的產業。範例:AUTOMOTIVE、FOOD_AND_DRINK

time_zone

string

必要欄位。報表時區:系統會根據這個時區為報表界定一日的起始,不論資料來自何處都是如此。如果時區採行日光節約時間,Analytics 會自動配合調整。

注意:修改時區只會影響該變更生效後收集的報表資料,不會溯及既往。

格式:https://www.iana.org/time-zones 範例:「America/Los_Angeles」

currency_code

string

報表中使用貨幣值時的貨幣類型。

格式:https://en.wikipedia.org/wiki/ISO_4217 範例:「USD」、「EUR」、「JPY」

service_level

ServiceLevel

僅供輸出。適用於這項資源的 Google Analytics 服務層級。

delete_time

Timestamp

僅供輸出。如果已設定,這個屬性遭刪除的時間。如未設定,表示該房源目前不在垃圾桶中。

expire_time

Timestamp

僅供輸出。如果已設定,系統會在該時間永久刪除已移至垃圾桶的資源。如果未設定,表示這項屬性目前不在垃圾桶中,也不會遭到刪除。

account

string

不可變更。父項帳戶的資源名稱。格式:accounts/{account_id}。範例:「accounts/123」

PropertySummary

代表 Google Analytics 資源中繼資料的虛擬資源。

欄位
property

string

這個屬性摘要所指屬性的資源名稱。格式:properties/{property_id}。範例:「properties/1000」

display_name

string

這份資源摘要中提及的資源顯示名稱。

property_type

PropertyType

屬性的屬性類型。

parent

string

這個資源的邏輯父項資源名稱。

注意:您可以使用「移動資源」使用者介面變更父項。格式:accounts/{account}、properties/{property} 範例:「accounts/100」、「properties/200」

PropertyType

Property 資源類型。

列舉
PROPERTY_TYPE_UNSPECIFIED 不明或未指定的房源類型
PROPERTY_TYPE_ORDINARY 一般 Google Analytics 資源
PROPERTY_TYPE_SUBPROPERTY Google Analytics 子資源
PROPERTY_TYPE_ROLLUP Google Analytics 匯總資源

ProvisionAccountTicketRequest

ProvisionAccountTicket RPC 的要求訊息。

欄位
account

Account

要建立的帳戶。

redirect_uri

string

使用者接受《服務條款》後,系統會將使用者導向的重新導向 URI。必須在 Cloud Console 中設定為重新導向 URI。

ProvisionAccountTicketResponse

ProvisionAccountTicket RPC 的回應訊息。

欄位
account_ticket_id

string

要在服務條款連結中傳遞的參數。

ProvisionSubpropertyRequest

CreateSubproperty RPC 的要求訊息。

欄位
subproperty

Property

必要欄位。要建立的子資源。

subproperty_event_filter

SubpropertyEventFilter

(選用步驟) 要在一般資源上建立的子資源事件篩選器。

custom_dimension_and_metric_synchronization_mode

SynchronizationMode

(選用步驟) 自訂維度和指標的子資源功能同步模式

ProvisionSubpropertyResponse

ProvisionSubproperty 遠端程序呼叫的回應訊息。

欄位
subproperty

Property

建立的子資源。

subproperty_event_filter

SubpropertyEventFilter

建立的子資源事件篩選器。

ReorderEventEditRulesRequest

ReorderEventEditRules RPC 的要求訊息。

欄位
parent

string

必要欄位。格式範例:properties/123/dataStreams/456

event_edit_rules[]

string

必要欄位。指定資料串流的 EventEditRule 資源名稱,並依所需處理順序排列。清單中必須包含串流的所有 EventEditRule。

ReportingDataAnnotation

報表資料註解是指與特定日期相關的報表資料註解。

欄位
name

string

必要欄位。ID。這項報表資料註解的資源名稱。格式:「properties/{property_id}/reportingDataAnnotations/{reporting_data_annotation}」格式:「properties/123/reportingDataAnnotations/456」

title

string

必要欄位。這項報表資料註解的使用者可理解標題。

description

string

(選用步驟) 這項報表資料註解的說明。

color

Color

必要欄位。用於顯示這項報表資料註解的顏色。

system_generated

bool

僅供輸出。如果為 true,表示這項註解是由 Google Analytics 系統產生。系統產生的註解無法更新或刪除。

聯集欄位 target。這項報表資料註解的目標 target 只能是下列其中一個:
annotation_date

Date

如果已設定,報表資料註解會顯示這個欄位代表的特定日期。日期必須是有效日期,且已設定年、月和日。日期可以是過去、現在或未來。

annotation_date_range

DateRange

如果已設定,報表資料註解會適用於這個欄位代表的日期範圍。

顏色

這項報表資料註解可能使用的顏色

列舉
COLOR_UNSPECIFIED 顏色不明或未指定。
PURPLE 紫色。
BROWN 棕色。
BLUE 藍色。
GREEN 綠色。
RED 紅色。
CYAN 青色。
ORANGE 橘色。(僅用於系統產生的註解)

DateRange

代表報表資料註解的日期範圍,開始和結束日期都包含在內。時區以父項資源為準。

欄位
start_date

Date

必要欄位。這個範圍的開始日期。必須是設定了年、月、日的有效日期。日期可以是過去、現在或未來。

end_date

Date

必要欄位。這個範圍的結束日期。必須是設定了年、月、日的有效日期。這個日期必須大於或等於開始日期。

ReportingIdentitySettings

包含與報表身分相關設定的資源。

欄位
name

string

僅供輸出。ID。這個報表身分識別設定單例資源的資源名稱。格式:properties/{property_id}/reportingIdentitySettings 範例:「properties/1234/reportingIdentitySettings」

reporting_identity

ReportingIdentity

用於在報表中識別使用者身分的策略。

ReportingIdentity

在報表中識別使用者身分的各種策略。

列舉
IDENTITY_BLENDING_STRATEGY_UNSPECIFIED 未指定混合策略。
BLENDED 混合報表識別資訊策略。
OBSERVED 觀察到的報表識別資訊策略。
DEVICE_BASED 以裝置為依據的報表識別資訊策略。

RunAccessReportRequest

要求提供資料存取記錄報表。

欄位
entity

string

資料存取報表支援在資源或帳戶層級提出要求。如果是在帳戶層級要求,資料存取報表會包含該帳戶下所有資源的所有存取權。

如要在資源層級提出要求,實體應為「properties/123」(如果「123」是您的 Google Analytics 資源 ID)。如要在帳戶層級提出要求,實體應為「accounts/1234」(如果「1234」是您的 Google Analytics 帳戶 ID)。

dimensions[]

AccessDimension

要求和回應中顯示的尺寸。要求最多可包含 9 個維度。

metrics[]

AccessMetric

要求並顯示在回應中的指標。要求最多可包含 10 項指標。

date_ranges[]

AccessDateRange

要讀取的存取記錄日期範圍。如果要求多個日期範圍,每個回應列都會包含以零為基準的日期範圍索引。如果兩個日期範圍重疊,這兩個日期範圍的回應列都會包含重疊日期的存取記錄。最多可要求 2 個日期範圍。

dimension_filter

AccessFilterExpression

維度篩選器可將報表回應限制為符合篩選器的特定維度值。舉例來說,您可以篩選單一使用者的存取記錄。如需更多範例,請參閱「維度篩選器基本概念」。這個篩選條件無法使用指標。

metric_filter

AccessFilterExpression

指標篩選器可將報表回應限制為符合篩選條件的特定指標值。指標篩選器會在匯總報表資料列後套用,類似於 SQL 的 having 子句。這個篩選器無法使用維度。

offset

int64

起始資料列的資料列數。第一列會計為第 0 列。如果未指定偏移量,系統會將其視為 0。如果偏移量為零,這個方法會傳回第一頁的結果,其中包含 limit 個項目。

如要進一步瞭解這個分頁參數,請參閱「分頁」。

limit

int64

代表要傳回的列數。如未指定,系統會傳回 10,000 個資料列。無論您要求多少資料列,API 每次最多只會傳回 100,000 個資料列。limit 必須為正數。

如果剩餘的資料列數量少於要求的 limit,API 傳回的資料列數量可能會少於 limit。舉例來說,維度 country 的可能值少於 300 個,因此即使將 limit 設為較高的值,只針對 country 產生報表時,最多也只會顯示 300 列。

如要進一步瞭解這個分頁參數,請參閱「分頁」。

time_zone

string

如果指定,則為這項要求的時區。如未指定,系統會使用資源的時區。系統會根據要求中的時區,解讀報表的開始和結束日期。

格式為 IANA 時區資料庫 (https://www.iana.org/time-zones) 中的字串,例如「America/New_York」或「Asia/Tokyo」。

order_bys[]

AccessOrderBy

指定回應中的資料列排序方式。

return_entity_quota

bool

切換是否要傳回這個 Analytics 資源的配額目前狀態。配額會以 AccessQuota 形式傳回。如果是帳戶層級的要求,這個欄位必須為 false。

include_all_users

bool

(選用步驟) 決定是否要在回應中納入從未發出 API 呼叫的使用者。如果為 true,則回應中會包含所有有權存取指定資源或帳戶的使用者,無論他們是否發出 API 呼叫。如果設為 false,則只會納入已發出 API 呼叫的使用者。

expand_groups

bool

(選用步驟) 決定是否要傳回使用者群組中的使用者。只有在 include_all_users 設為 true 時,這個欄位才會生效。如果為 true,系統會傳回有權存取指定資源或帳戶的所有使用者。如果設為 false,系統只會傳回具有直接存取權的使用者。

RunAccessReportResponse

自訂的資料存取記錄報表回覆。

欄位
dimension_headers[]

AccessDimensionHeader

報表中與特定維度對應的資料欄標題。DimensionHeaders 的數量和順序與資料列中的維度相符。

metric_headers[]

AccessMetricHeader

報表中與特定指標對應的資料欄標題。MetricHeaders 的數量和順序與資料列中的指標相符。

rows[]

AccessRow

報表中的維度值組合和指標值列。

row_count

int32

查詢結果中的資料列總數。rowCount 與回應中傳回的資料列數、limit 要求參數和 offset 要求參數無關。舉例來說,如果查詢傳回 175 列,且 API 要求包含 50 個 limit,則回應會包含 175 個 rowCount,但只有 50 列。

如要進一步瞭解這個分頁參數,請參閱「分頁」。

quota

AccessQuota

這項 Analytics 資源的配額狀態,包括這項要求。這個欄位不適用於帳戶層級要求。

SKAdNetworkConversionValueSchema

iOS 串流的 SKAdNetwork 轉換價值結構定義。

欄位
name

string

僅供輸出。結構定義的資源名稱。這只會是 iOS 串流的子項,且 iOS 串流最多只能有一個這類子項。格式:properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema

postback_window_one

PostbackWindow

必要欄位。第一個回傳期的轉換價值設定。與回傳期 2 和 3 的值不同,這些值包含「精細」的轉換價值 (數值)。

必須為這個回傳期設定轉換價值。其他視窗為選用視窗,如果未設定或停用,可能會沿用這個視窗的設定。

postback_window_two

PostbackWindow

第二個回傳期的轉換價值設定。

只有在需要為這段回傳期定義不同的轉換價值時,才應設定這個欄位。

如果這個回傳期的 enable_postback_window_settings 設為 false,系統會使用 postback_window_one 的值。

postback_window_three

PostbackWindow

第三個回傳期的轉換價值設定。

只有在使用者選擇為這段回傳期定義不同的轉換價值時,才應設定這個欄位。您可以在不設定視窗 2 的情況下設定視窗 3。如果已設定回溯期 1 和 2,且這個回傳期的 enable_postback_window_settings 設為 false,結構定義會沿用 postback_window_two 的設定。

apply_conversion_values

bool

啟用後,Google Analytics SDK 會使用這個結構定義設定轉換價值,且結構定義會匯出至連結這項資源的所有 Google Ads 帳戶。如果停用,Google Analytics SDK 不會自動設定轉換價值,且結構定義也不會匯出至 Google Ads。

SearchChangeHistoryEventsRequest

SearchChangeHistoryEvents RPC 的要求訊息。

欄位
account

string

必要欄位。要傳回變更記錄資源的帳戶資源。格式:accounts/{account}

範例:accounts/100

property

string

(選用步驟) 子資源的資源名稱。如果設定這項屬性,系統只會傳回對這個資源或其子項資源所做的變更。格式:properties/{propertyId}

範例:properties/100

resource_type[]

ChangeHistoryResourceType

(選用步驟) 如果設定,則只會傳回至少符合其中一種類型的資源變更。

action[]

ActionType

(選用步驟) 如果已設定,則只會傳回符合一或多個這類動作的變更。

actor_email[]

string

(選用步驟) 如果設定這項屬性,系統只會傳回這份清單中使用者所做的變更。

earliest_change_time

Timestamp

(選用步驟) 如果設定了這個時間,系統只會傳回這個時間之後 (含這個時間) 所做的變更。

latest_change_time

Timestamp

(選用步驟) 如果設定,則只會傳回在此時間之前 (含此時間) 所做的變更。

page_size

int32

(選用步驟) 要傳回的 ChangeHistoryEvent 項目數上限。如未指定,最多將傳回 50 個項目。最大值為 200 (如果值大於 200,系統會強制設為最大值)。

請注意,服務傳回的頁面項目數量可能會少於這個值 (甚至可能為零),而且可能還有其他頁面。如要取得特定數量的項目,請繼續使用 page_token 要求其他頁面,直到取得所需數量為止。

page_token

string

(選用步驟) 屬於接收自前一個 SearchChangeHistoryEvents 呼叫的網頁權杖。提供此項目即可擷取後續網頁。進行分頁時,提供至 SearchChangeHistoryEvents 的所有其他參數須與提供網頁權杖的呼叫相符。

SearchChangeHistoryEventsResponse

SearchAccounts RPC 的回應訊息。

欄位
change_history_events[]

ChangeHistoryEvent

呼叫者可存取的結果。

next_page_token

string

可做為 page_token 傳送的權杖,用於擷取後續網頁。如果省略這個欄位,就不會有後續頁面。

ServiceLevel

Google Analytics 的各種服務層級。

列舉
SERVICE_LEVEL_UNSPECIFIED 未指定或指定的服務等級無效。
GOOGLE_ANALYTICS_STANDARD Google Analytics 的標準版本。
GOOGLE_ANALYTICS_360 Google Analytics 的付費進階版。

SubmitUserDeletionRequest

SubmitUserDeletion RPC 的要求訊息。

欄位
name

string

必要欄位。要提交使用者刪除要求的資源名稱。

聯集欄位 user。提交 user 刪除要求的使用者只能是下列其中一項:
user_id

string

Google Analytics 使用者 ID

client_id

string

Google Analytics 用戶端 ID

app_instance_id

string

Firebase 應用程式執行個體 ID

user_provided_data

string

使用者提供的資料。可包含一個電子郵件地址或一個電話號碼。

電子郵件地址應經過正規化,如下所示:

  • lowercase
  • 移除 gmail.com/googlemail.com 地址中「@」前的半形句號
  • 移除所有空格

電話號碼應標準化為:

  • 移除所有非數字字元
  • 新增「+」前置字元

SubmitUserDeletionResponse

SubmitUserDeletion RPC 的回應訊息。

欄位
deletion_request_time

Timestamp

標記時間點,系統會刪除該時間點之前的所有訪客資料。這會設為收到刪除要求的時間。

SubpropertyEventFilter

代表 Google Analytics 子資源事件篩選器的資源訊息。

欄位
name

string

僅供輸出。格式:properties/{ordinary_property_id}/subpropertyEventFilters/{sub_property_event_filter} 範例:properties/1234/subpropertyEventFilters/5678

filter_clauses[]

SubpropertyEventFilterClause

必要欄位。未排序的清單。定義 SubpropertyEventFilter 的篩選子句。所有子句都會以 AND 運算子合併,以判斷要將哪些資料傳送至子資源。

apply_to_property

string

不可變更。使用這項篩選條件的子資源資源名稱。

SubpropertyEventFilterClause

用於定義篩選器的子句。篩選器可以是包含性 (符合篩選器子句的事件會納入子資源的資料),也可以是排除性 (符合篩選器子句的事件會從子資源的資料中排除)。

欄位
filter_clause_type

FilterClauseType

必要欄位。篩選子句的類型。

filter_expression

SubpropertyEventFilterExpression

必要欄位。要傳送至子資源的事件邏輯運算式。

FilterClauseType

指定這是納入或排除篩選器子句。

列舉
FILTER_CLAUSE_TYPE_UNSPECIFIED 篩選子句類型不明或未指定。
INCLUDE 如果符合篩選子句,系統就會將事件納入子資源。
EXCLUDE 如果符合篩選條件子句,系統就會從子資源中排除事件。

SubpropertyEventFilterCondition

特定篩選運算式

欄位
field_name

string

必要欄位。要篩選的欄位。

聯集欄位 one_filter

one_filter 只能是下列其中一項:

null_filter

bool

空值篩選器。

string_filter

StringFilter

字串類型維度的篩選器,符合特定模式。

StringFilter

字串類型維度的篩選器,符合特定模式。

欄位
match_type

MatchType

必要欄位。字串篩選器的比對類型。

value

string

必要欄位。用於比對的字串值。

case_sensitive

bool

(選用步驟) 如為 true,字串值會區分大小寫。如果設為 False,比對時不區分大小寫。

MatchType

篩選器如何用於判斷是否相符。

列舉
MATCH_TYPE_UNSPECIFIED 比對類型不明或未指定。
EXACT 字串值完全相符。
BEGINS_WITH 以字串值開頭。
ENDS_WITH 結尾為字串值。
CONTAINS 包含字串值。
FULL_REGEXP 完整規則運算式與字串值相符。
PARTIAL_REGEXP 與字串值部分相符的規則運算式。

SubpropertyEventFilterExpression

子資源事件篩選器的邏輯運算式。

欄位
聯集欄位 expr。套用至篩選器的運算式。expr 只能是下列其中一項:
or_group

SubpropertyEventFilterExpressionList

要以 OR 運算子合併的運算式清單。只能包含 not_expression 或 filter_condition 運算式。

not_expression

SubpropertyEventFilterExpression

要 NOT (反轉、補足) 的篩選器運算式。只能包含篩選條件。這項設定無法在頂層 SubpropertyEventFilterExpression 中設定。

filter_condition

SubpropertyEventFilterCondition

建立符合特定事件的篩選條件。這項設定無法在頂層 SubpropertyEventFilterExpression 中設定。

SubpropertyEventFilterExpressionList

子資源事件篩選器運算式清單。

欄位
filter_expressions[]

SubpropertyEventFilterExpression

必要欄位。未排序的清單。子資源事件篩選器運算式清單

SubpropertySyncConfig

子資源同步設定可控管一般資源設定同步至子資源的方式。系統會為每個子資源自動佈建這項資源。

欄位
name

string

僅供輸出。ID。格式:properties/{ordinary_property_id}/subpropertySyncConfigs/{subproperty_id} 範例:properties/1234/subpropertySyncConfigs/5678

apply_to_property

string

僅供輸出。不可變更。這些設定適用的子資源名稱。

custom_dimension_and_metric_sync_mode

SynchronizationMode

必要欄位。指定子資源的自訂維度 / 指標同步模式。

如果設為「ALL」,系統會立即啟用自訂維度 / 指標同步功能。只要同步模式設為「全部」,子資源就不允許自訂維度 / 指標的本機設定。

如果設為 NONE,系統會停用自訂維度 / 指標同步功能。您必須在子資源中明確設定自訂維度 / 指標。

SynchronizationMode

子資源的同步模式

列舉
SYNCHRONIZATION_MODE_UNSPECIFIED 同步模式不明或未指定。
NONE 實體不會同步。子資源允許進行本機編輯。
ALL 實體會從父項資源同步處理。子資源不允許進行本機變動 (建立 / 更新 / 刪除)

UpdateAccessBindingRequest

UpdateAccessBinding RPC 的要求訊息。

欄位
access_binding

AccessBinding

必要欄位。要更新的存取權繫結。

UpdateAccountRequest

UpdateAccount RPC 的要求訊息。

欄位
account

Account

必要欄位。要更新的帳戶。帳戶的 name 欄位用於識別帳戶。

update_mask

FieldMask

必要欄位。要更新的欄位清單。欄位名稱必須採用蛇形命名法 (例如「field_to_update」)。系統不會更新省略的欄位。如要取代整個實體,請使用一個路徑,並以字串「*」比對所有欄位。

UpdateAttributionSettingsRequest

UpdateAttributionSettings RPC 的要求訊息

欄位
attribution_settings

AttributionSettings

必要欄位。要更新的歸因設定。name 欄位用於識別要更新的設定。

update_mask

FieldMask

必要欄位。要更新的欄位清單。欄位名稱必須採用蛇形命名法 (例如 「field_to_update」)。系統不會更新省略的欄位。如要取代整個實體,請使用一個路徑,並以字串「*」比對所有欄位。

UpdateAudienceRequest

UpdateAudience RPC 的要求訊息。

欄位
audience

Audience

必要欄位。要更新的目標對象。目標對象的 name 欄位可用於識別要更新的目標對象。

update_mask

FieldMask

必要欄位。要更新的欄位清單。欄位名稱必須採用蛇形命名法 (例如 「field_to_update」)。系統不會更新省略的欄位。如要取代整個實體,請使用一個路徑,並以字串「*」比對所有欄位。

UpdateBigQueryLinkRequest

UpdateBigQueryLink RPC 的要求訊息。

欄位
update_mask

FieldMask

必要欄位。要更新的欄位清單。欄位名稱必須採用蛇形命名法 (例如 「field_to_update」)。系統不會更新省略的欄位。如要取代整個實體,請使用一個路徑,並以字串「*」比對所有欄位。

UpdateCalculatedMetricRequest

UpdateCalculatedMetric RPC 的要求訊息。

欄位
calculated_metric

CalculatedMetric

必要欄位。要更新的 CalculatedMetric

update_mask

FieldMask

必要欄位。要更新的欄位清單。系統不會更新省略的欄位。如要取代整個實體,請使用一個路徑,並以字串「*」比對所有欄位。

UpdateChannelGroupRequest

UpdateChannelGroup RPC 的要求訊息。

欄位
channel_group

ChannelGroup

必要欄位。要更新的 ChannelGroup。資源的 name 欄位用於識別要更新的 ChannelGroup。

update_mask

FieldMask

必要欄位。要更新的欄位清單。欄位名稱必須採用蛇形命名法 (例如 「field_to_update」)。系統不會更新省略的欄位。如要取代整個實體,請使用一個路徑,並以字串「*」比對所有欄位。

UpdateConversionEventRequest

UpdateConversionEvent RPC 的要求訊息

欄位
conversion_event

ConversionEvent

必要欄位。要更新的轉換事件。name 欄位用於識別要更新的設定。

update_mask

FieldMask

必要欄位。要更新的欄位清單。欄位名稱必須採用蛇形命名法 (例如 「field_to_update」)。系統不會更新省略的欄位。如要取代整個實體,請使用一個路徑,並以字串「*」比對所有欄位。

UpdateCustomDimensionRequest

UpdateCustomDimension RPC 的要求訊息。

欄位
custom_dimension

CustomDimension

要更新的 CustomDimension

update_mask

FieldMask

必要欄位。要更新的欄位清單。系統不會更新省略的欄位。如要取代整個實體,請使用一個路徑,並以字串「*」比對所有欄位。

UpdateCustomMetricRequest

UpdateCustomMetric RPC 的要求訊息。

欄位
custom_metric

CustomMetric

要更新的 CustomMetric

update_mask

FieldMask

必要欄位。要更新的欄位清單。系統不會更新省略的欄位。如要取代整個實體,請使用一個路徑,並以字串「*」比對所有欄位。

UpdateDataRedactionSettingsRequest

UpdateDataRedactionSettings RPC 的要求訊息。

欄位
data_redaction_settings

DataRedactionSettings

必要欄位。要更新的設定。name 欄位用於識別要更新的設定。

update_mask

FieldMask

必要欄位。要更新的欄位清單。欄位名稱必須採用蛇形命名法 (例如 「field_to_update」)。系統不會更新省略的欄位。如要取代整個實體,請使用一個路徑,並以字串「*」比對所有欄位。

UpdateDataRetentionSettingsRequest

UpdateDataRetentionSettings RPC 的要求訊息。

欄位
data_retention_settings

DataRetentionSettings

必要欄位。要更新的設定。name 欄位用於識別要更新的設定。

update_mask

FieldMask

必要欄位。要更新的欄位清單。欄位名稱必須採用蛇形命名法 (例如 「field_to_update」)。系統不會更新省略的欄位。如要取代整個實體,請使用一個路徑,並以字串「*」比對所有欄位。

UpdateDataStreamRequest

UpdateDataStream RPC 的要求訊息。

欄位
data_stream

DataStream

要更新的 DataStream

update_mask

FieldMask

必要欄位。要更新的欄位清單。系統不會更新省略的欄位。如要取代整個實體,請使用一個路徑,並以字串「*」比對所有欄位。

UpdateDisplayVideo360AdvertiserLinkRequest

UpdateDisplayVideo360AdvertiserLink RPC 的要求訊息。

欄位
update_mask

FieldMask

必要欄位。要更新的欄位清單。系統不會更新省略的欄位。如要取代整個實體,請使用一個路徑,並以字串「*」比對所有欄位。

UpdateEnhancedMeasurementSettingsRequest

UpdateEnhancedMeasurementSettings RPC 的要求訊息。

欄位
enhanced_measurement_settings

EnhancedMeasurementSettings

必要欄位。要更新的設定。name 欄位用於識別要更新的設定。

update_mask

FieldMask

必要欄位。要更新的欄位清單。欄位名稱必須採用蛇形命名法 (例如 「field_to_update」)。系統不會更新省略的欄位。如要取代整個實體,請使用一個路徑,並以字串「*」比對所有欄位。

UpdateEventCreateRuleRequest

UpdateEventCreateRule RPC 的要求訊息。

欄位
event_create_rule

EventCreateRule

必要欄位。要更新的 EventCreateRule。資源的 name 欄位用於識別要更新的 EventCreateRule。

update_mask

FieldMask

必要欄位。要更新的欄位清單。欄位名稱必須採用蛇形命名法 (例如 「field_to_update」)。系統不會更新省略的欄位。如要取代整個實體,請使用一個路徑,並以字串「*」比對所有欄位。

UpdateEventEditRuleRequest

UpdateEventEditRule RPC 的要求訊息。

欄位
event_edit_rule

EventEditRule

必要欄位。要更新的 EventEditRule。資源的 name 欄位用於識別要更新的 EventEditRule。

update_mask

FieldMask

必要欄位。要更新的欄位清單。欄位名稱必須採用蛇形命名法 (例如 「field_to_update」)。系統不會更新省略的欄位。如要取代整個實體,請使用一個路徑,並以字串「*」比對所有欄位。

UpdateExpandedDataSetRequest

UpdateExpandedDataSet RPC 的要求訊息。

欄位
expanded_data_set

ExpandedDataSet

必要欄位。要更新的 ExpandedDataSet。資源的 name 欄位用於識別要更新的 ExpandedDataSet。

update_mask

FieldMask

必要欄位。要更新的欄位清單。欄位名稱必須採用蛇形命名法 (例如 「field_to_update」)。系統不會更新省略的欄位。如要取代整個實體,請使用一個路徑,並以字串「*」比對所有欄位。

UpdateGoogleAdsLinkRequest

UpdateGoogleAdsLink RPC 的要求訊息

欄位
update_mask

FieldMask

必要欄位。要更新的欄位清單。欄位名稱必須採用蛇形命名法 (例如 「field_to_update」)。系統不會更新省略的欄位。如要取代整個實體,請使用一個路徑,並以字串「*」比對所有欄位。

UpdateGoogleSignalsSettingsRequest

UpdateGoogleSignalsSettings RPC 的要求訊息

欄位
google_signals_settings

GoogleSignalsSettings

必要欄位。要更新的設定。name 欄位用於識別要更新的設定。

update_mask

FieldMask

必要欄位。要更新的欄位清單。欄位名稱必須採用蛇形命名法 (例如 「field_to_update」)。系統不會更新省略的欄位。如要取代整個實體,請使用一個路徑,並以字串「*」比對所有欄位。

UpdateKeyEventRequest

UpdateKeyEvent RPC 的要求訊息

欄位
key_event

KeyEvent

必要欄位。要更新的重要事件。name 欄位用於識別要更新的設定。

update_mask

FieldMask

必要欄位。要更新的欄位清單。欄位名稱必須採用蛇形命名法 (例如 「field_to_update」)。系統不會更新省略的欄位。如要取代整個實體,請使用一個路徑,並以字串「*」比對所有欄位。

UpdateMeasurementProtocolSecretRequest

UpdateMeasurementProtocolSecret RPC 的要求訊息

欄位
measurement_protocol_secret

MeasurementProtocolSecret

必要欄位。要更新的 Measurement Protocol 密鑰。

update_mask

FieldMask

必要欄位。要更新的欄位清單。系統不會更新省略的欄位。

UpdatePropertyRequest

UpdateProperty RPC 的要求訊息。

欄位
property

Property

必要欄位。要更新的屬性。系統會使用該屬性的 name 欄位,識別要更新的屬性。

update_mask

FieldMask

必要欄位。要更新的欄位清單。欄位名稱必須採用蛇形命名法 (例如 「field_to_update」)。系統不會更新省略的欄位。如要取代整個實體,請使用一個路徑,並以字串「*」比對所有欄位。

UpdateReportingDataAnnotationRequest

UpdateReportingDataAnnotation RPC 的要求訊息。

欄位
reporting_data_annotation

ReportingDataAnnotation

必要欄位。要更新的報表資料註解。

update_mask

FieldMask

(選用步驟) 要更新的欄位清單。欄位名稱必須採用蛇形命名法 (例如「field_to_update」)。系統不會更新省略的欄位。如要取代整個實體,請使用一個路徑,並以字串「*」比對所有欄位。

UpdateSKAdNetworkConversionValueSchemaRequest

UpdateSKAdNetworkConversionValueSchema RPC 的要求訊息。

欄位
skadnetwork_conversion_value_schema

SKAdNetworkConversionValueSchema

必要欄位。要更新的 SKAdNetwork 轉換價值結構定義。

update_mask

FieldMask

必要欄位。要更新的欄位清單。系統不會更新省略的欄位。

UpdateSearchAds360LinkRequest

UpdateSearchAds360Link RPC 的要求訊息。

欄位
update_mask

FieldMask

必要欄位。要更新的欄位清單。系統不會更新省略的欄位。如要取代整個實體,請使用一個路徑,並以字串「*」比對所有欄位。

UpdateSubpropertyEventFilterRequest

UpdateSubpropertyEventFilter RPC 的要求訊息。

欄位
subproperty_event_filter

SubpropertyEventFilter

必要欄位。要更新的子資源事件篩選器。

update_mask

FieldMask

必要欄位。要更新的欄位清單。欄位名稱必須採用蛇形命名法 (例如「field_to_update」)。系統不會更新省略的欄位。如要取代整個實體,請使用一個路徑,並以字串「*」比對所有欄位。

UpdateSubpropertySyncConfigRequest

UpdateSubpropertySyncConfig RPC 的要求訊息。

欄位
subproperty_sync_config

SubpropertySyncConfig

必要欄位。更新「SubpropertySyncConfig」。

update_mask

FieldMask

(選用步驟) 要更新的欄位清單。欄位名稱必須採用蛇形命名法 (例如「field_to_update」)。系統不會更新省略的欄位。如要取代整個實體,請使用一個路徑,並以字串「*」比對所有欄位。