Google Analytics Admin API

在 Google Analytics(分析)中管理媒体资源。警告:创建多个客户应用、帐号或项目来分别模拟或充当单个客户应用、帐号或项目,或试图规避服务专用的用量限额或配额,直接违反了《Google Cloud Platform 服务条款》和《Google API 服务条款》。这些操作可能会导致您的 GCP 项目立即终止,且不会发出警告。

服务:analyticsadmin.googleapis.com

要调用此服务,我们建议您使用 Google 提供的客户端库。如果您的应用程序需要使用自己的库来调用此服务,请在发出 API 请求时使用以下信息。

发现文档

发现文档是用于说明和使用 REST API 的机器可读规范。它用于构建客户端库、IDE 插件以及与 Google API 交互的其他工具。一项服务可能会提供多个发现文档。此服务提供了以下发现文档:

服务端点

服务端点是指定 API 服务的网络地址的基本网址。一项服务可能有多个服务端点。此服务具有以下服务端点,下面的所有 URI 都与此服务端点相关:

  • https://analyticsadmin.googleapis.com

REST 资源:v1beta.accountSummaries

方法
list GET /v1beta/accountSummaries
返回调用方可访问的所有帐号的摘要。

REST 资源:v1beta.accounts

方法
delete DELETE /v1beta/{name=accounts/*}
将目标帐号标记为软删除(即“已放入回收站”)并将其返回。
get GET /v1beta/{name=accounts/*}
查找单个帐号。
getDataSharingSettings GET /v1beta/{name=accounts/*/dataSharingSettings}
获取帐号的数据共享设置。
list GET /v1beta/accounts
返回调用方可访问的所有帐号。
patch PATCH /v1beta/{account.name=accounts/*}
更新帐号。
provisionAccountTicket POST /v1beta/accounts:provisionAccountTicket
索要创建帐号的工单。
runAccessReport POST /v1beta/{entity=accounts/*}:runAccessReport
返回数据访问记录的自定义报告。
searchChangeHistoryEvents POST /v1beta/{account=accounts/*}:searchChangeHistoryEvents
根据指定的一组过滤条件,搜索某个帐号或其子帐号的所有更改。

REST 资源:v1beta.properties

方法
acknowledgeUserDataCollection POST /v1beta/{property=properties/*}:acknowledgeUserDataCollection
确认指定媒体资源的用户数据收集条款。
create POST /v1beta/properties
创建具有指定位置和属性的“GA4”媒体资源。
delete DELETE /v1beta/{name=properties/*}
将目标属性标记为软删除(即“已放入回收站”)并将其返回。
get GET /v1beta/{name=properties/*}
查找单个“GA4”媒体资源。
getDataRetentionSettings GET /v1beta/{name=properties/*/dataRetentionSettings}
返回此媒体资源的单例数据保留设置。
list GET /v1beta/properties
返回指定父级帐号下的子媒体资源。
patch PATCH /v1beta/{property.name=properties/*}
更新媒体资源。
runAccessReport POST /v1beta/{entity=properties/*}:runAccessReport
返回数据访问记录的自定义报告。
updateDataRetentionSettings PATCH /v1beta/{dataRetentionSettings.name=properties/*/dataRetentionSettings}
更新此媒体资源的单例数据保留设置。

REST 资源:v1beta.properties.conversionEvents

方法
create POST /v1beta/{parent=properties/*}/conversionEvents
创建具有指定属性的转化事件。
delete DELETE /v1beta/{name=properties/*/conversionEvents/*}
删除媒体资源中的转化事件。
get GET /v1beta/{name=properties/*/conversionEvents/*}
检索单个转化事件。
list GET /v1beta/{parent=properties/*}/conversionEvents
返回指定父媒体资源中的转化事件列表。
patch PATCH /v1beta/{conversionEvent.name=properties/*/conversionEvents/*}
更新具有指定属性的转化事件。

REST 资源:v1beta.properties.customDimensions

方法
archive POST /v1beta/{name=properties/*/customDimensions/*}:archive
归档媒体资源的自定义维度。
create POST /v1beta/{parent=properties/*}/customDimensions
创建自定义维度。
get GET /v1beta/{name=properties/*/customDimensions/*}
查找单个自定义维度。
list GET /v1beta/{parent=properties/*}/customDimensions
列出媒体资源的自定义维度。
patch PATCH /v1beta/{customDimension.name=properties/*/customDimensions/*}
更新媒体资源的自定义维度。

REST 资源:v1beta.properties.customMetrics

方法
archive POST /v1beta/{name=properties/*/customMetrics/*}:archive
归档媒体资源的自定义指标。
create POST /v1beta/{parent=properties/*}/customMetrics
创建自定义指标。
get GET /v1beta/{name=properties/*/customMetrics/*}
查找单个自定义指标。
list GET /v1beta/{parent=properties/*}/customMetrics
列出媒体资源的自定义指标。
patch PATCH /v1beta/{customMetric.name=properties/*/customMetrics/*}
更新媒体资源的 CustomMetric。

REST 资源:v1beta.properties.dataStreams

方法
create POST /v1beta/{parent=properties/*}/dataStreams
创建 DataStream。
delete DELETE /v1beta/{name=properties/*/dataStreams/*}
删除媒体资源上的 DataStream。
get GET /v1beta/{name=properties/*/dataStreams/*}
查找单个 DataStream。
list GET /v1beta/{parent=properties/*}/dataStreams
列出媒体资源上的 DataStream。
patch PATCH /v1beta/{dataStream.name=properties/*/dataStreams/*}
更新媒体资源上的 DataStream。

REST 资源:v1beta.properties.dataStreams.measurementProtocolSecrets

方法
create POST /v1beta/{parent=properties/*/dataStreams/*}/measurementProtocolSecrets
创建 Measurement Protocol 密钥。
delete DELETE /v1beta/{name=properties/*/dataStreams/*/measurementProtocolSecrets/*}
删除目标 MeasurementProtocolSecret。
get GET /v1beta/{name=properties/*/dataStreams/*/measurementProtocolSecrets/*}
查找单个“GA4”MeasurementProtocolSecret。
list GET /v1beta/{parent=properties/*/dataStreams/*}/measurementProtocolSecrets
返回指定父级媒体资源下的子级 MeasurementProtocolSecret。
patch PATCH /v1beta/{measurementProtocolSecret.name=properties/*/dataStreams/*/measurementProtocolSecrets/*}
更新 Measurement Protocol 密钥。

REST 资源:v1alpha.accountSummaries

方法
list GET /v1alpha/accountSummaries
返回调用方可访问的所有帐号的摘要。

REST 资源:v1alpha.accounts

方法
delete DELETE /v1alpha/{name=accounts/*}
将目标帐号标记为软删除(即“已放入回收站”)并将其返回。
get GET /v1alpha/{name=accounts/*}
查找单个帐号。
getDataSharingSettings GET /v1alpha/{name=accounts/*/dataSharingSettings}
获取帐号的数据共享设置。
list GET /v1alpha/accounts
返回调用方可访问的所有帐号。
patch PATCH /v1alpha/{account.name=accounts/*}
更新帐号。
provisionAccountTicket POST /v1alpha/accounts:provisionAccountTicket
索要创建帐号的工单。
runAccessReport POST /v1alpha/{entity=accounts/*}:runAccessReport
返回数据访问记录的自定义报告。
searchChangeHistoryEvents POST /v1alpha/{account=accounts/*}:searchChangeHistoryEvents
根据指定的一组过滤条件,搜索某个帐号或其子帐号的所有更改。

REST 资源:v1alpha.accounts.accessBindings

方法
batchCreate POST /v1alpha/{parent=accounts/*}/accessBindings:batchCreate
创建与帐号或媒体资源的多个访问权限绑定相关的信息。
batchDelete POST /v1alpha/{parent=accounts/*}/accessBindings:batchDelete
删除多个用户与某个帐号或媒体资源的关联的相关信息。
batchGet GET /v1alpha/{parent=accounts/*}/accessBindings:batchGet
获取有关帐号或媒体资源的多个访问权限绑定的信息。
batchUpdate POST /v1alpha/{parent=accounts/*}/accessBindings:batchUpdate
更新某个帐号或媒体资源的多个访问权限绑定的相关信息。
create POST /v1alpha/{parent=accounts/*}/accessBindings
对帐号或媒体资源创建访问绑定。
delete DELETE /v1alpha/{name=accounts/*/accessBindings/*}
删除帐号或媒体资源的访问绑定。
get GET /v1alpha/{name=accounts/*/accessBindings/*}
获取有关访问绑定的信息。
list GET /v1alpha/{parent=accounts/*}/accessBindings
列出帐号或媒体资源上的所有访问权限绑定。
patch PATCH /v1alpha/{accessBinding.name=accounts/*/accessBindings/*}
更新帐号或媒体资源的访问权限绑定。

REST 资源:v1alpha.properties

方法
acknowledgeUserDataCollection POST /v1alpha/{property=properties/*}:acknowledgeUserDataCollection
确认指定媒体资源的用户数据收集条款。
create POST /v1alpha/properties
创建具有指定位置和属性的“GA4”媒体资源。
createConnectedSiteTag POST /v1alpha/properties:createConnectedSiteTag
为 Universal Analytics 媒体资源创建已关联的网站代码。
createRollupProperty POST /v1alpha/properties:createRollupProperty
创建总览媒体资源和所有总览媒体资源来源关联。
createSubproperty POST /v1alpha/properties:createSubproperty
创建子媒体资源以及将应用于已创建的子媒体资源的子媒体资源事件过滤器。
delete DELETE /v1alpha/{name=properties/*}
将目标属性标记为软删除(即“已放入回收站”)并将其返回。
deleteConnectedSiteTag POST /v1alpha/properties:deleteConnectedSiteTag
删除 Universal Analytics 媒体资源的已关联的网站代码。
fetchAutomatedGa4ConfigurationOptOut POST /v1alpha/properties:fetchAutomatedGa4ConfigurationOptOut
提取 UA 媒体资源的 GA4 自动设置流程的停用状态。
fetchConnectedGa4Property GET /v1alpha/properties:fetchConnectedGa4Property
找到指定的 UA 媒体资源,查找与其关联的 GA4 媒体资源。
get GET /v1alpha/{name=properties/*}
查找单个“GA4”媒体资源。
getAttributionSettings GET /v1alpha/{name=properties/*/attributionSettings}
查找 AttributionSettings 单例。
getDataRetentionSettings GET /v1alpha/{name=properties/*/dataRetentionSettings}
返回此媒体资源的单例数据保留设置。
getGoogleSignalsSettings GET /v1alpha/{name=properties/*/googleSignalsSettings}
查找媒体资源的 Google 信号设置。
list GET /v1alpha/properties
返回指定父级帐号下的子媒体资源。
listConnectedSiteTags POST /v1alpha/properties:listConnectedSiteTags
列出 Universal Analytics 媒体资源的已关联的网站代码。
patch PATCH /v1alpha/{property.name=properties/*}
更新媒体资源。
runAccessReport POST /v1alpha/{entity=properties/*}:runAccessReport
返回数据访问记录的自定义报告。
setAutomatedGa4ConfigurationOptOut POST /v1alpha/properties:setAutomatedGa4ConfigurationOptOut
为 UA 媒体资源设置 GA4 自动设置流程的停用状态。
updateAttributionSettings PATCH /v1alpha/{attributionSettings.name=properties/*/attributionSettings}
更新媒体资源的归因设置。
updateDataRetentionSettings PATCH /v1alpha/{dataRetentionSettings.name=properties/*/dataRetentionSettings}
更新此媒体资源的单例数据保留设置。
updateGoogleSignalsSettings PATCH /v1alpha/{googleSignalsSettings.name=properties/*/googleSignalsSettings}
更新媒体资源的 Google 信号设置。

REST 资源:v1alpha.properties.accessBindings

方法
batchCreate POST /v1alpha/{parent=properties/*}/accessBindings:batchCreate
创建与帐号或媒体资源的多个访问权限绑定相关的信息。
batchDelete POST /v1alpha/{parent=properties/*}/accessBindings:batchDelete
删除多个用户与某个帐号或媒体资源的关联的相关信息。
batchGet GET /v1alpha/{parent=properties/*}/accessBindings:batchGet
获取有关帐号或媒体资源的多个访问权限绑定的信息。
batchUpdate POST /v1alpha/{parent=properties/*}/accessBindings:batchUpdate
更新某个帐号或媒体资源的多个访问权限绑定的相关信息。
create POST /v1alpha/{parent=properties/*}/accessBindings
对帐号或媒体资源创建访问绑定。
delete DELETE /v1alpha/{name=properties/*/accessBindings/*}
删除帐号或媒体资源的访问绑定。
get GET /v1alpha/{name=properties/*/accessBindings/*}
获取有关访问绑定的信息。
list GET /v1alpha/{parent=properties/*}/accessBindings
列出帐号或媒体资源上的所有访问权限绑定。
patch PATCH /v1alpha/{accessBinding.name=properties/*/accessBindings/*}
更新帐号或媒体资源的访问权限绑定。

REST 资源:v1alpha.properties.audiences

方法
archive POST /v1alpha/{name=properties/*/audiences/*}:archive
归档媒体资源上的受众群体。
create POST /v1alpha/{parent=properties/*}/audiences
创建受众群体。
get GET /v1alpha/{name=properties/*/audiences/*}
查找单个受众群体。
list GET /v1alpha/{parent=properties/*}/audiences
列出媒体资源上的受众群体。
patch PATCH /v1alpha/{audience.name=properties/*/audiences/*}
更新媒体资源上的受众群体。

REST 资源:v1alpha.properties.calculatedMetrics

方法
create POST /v1alpha/{parent=properties/*}/calculatedMetrics
创建一个 CalculatedMetric。
delete DELETE /v1alpha/{name=properties/*/calculatedMetrics/*}
删除属性上的 CalculatedMetric。
get GET /v1alpha/{name=properties/*/calculatedMetrics/*}
查找单个 CalculatedMetric。
list GET /v1alpha/{parent=properties/*}/calculatedMetrics
列出媒体资源的 CalculatedMetrics。
patch PATCH /v1alpha/{calculatedMetric.name=properties/*/calculatedMetrics/*}
更新属性的 CalculatedMetric。

REST 资源:v1alpha.properties.channelGroups

方法
create POST /v1alpha/{parent=properties/*}/channelGroups
创建 ChannelGroup。
delete DELETE /v1alpha/{name=properties/*/channelGroups/*}
删除媒体资源的 ChannelGroup。
get GET /v1alpha/{name=properties/*/channelGroups/*}
查找单个 ChannelGroup。
list GET /v1alpha/{parent=properties/*}/channelGroups
列出媒体资源上的 ChannelGroup。
patch PATCH /v1alpha/{channelGroup.name=properties/*/channelGroups/*}
更新 ChannelGroup。

REST 资源:v1alpha.properties.conversionEvents

方法
create POST /v1alpha/{parent=properties/*}/conversionEvents
创建具有指定属性的转化事件。
delete DELETE /v1alpha/{name=properties/*/conversionEvents/*}
删除媒体资源中的转化事件。
get GET /v1alpha/{name=properties/*/conversionEvents/*}
检索单个转化事件。
list GET /v1alpha/{parent=properties/*}/conversionEvents
返回指定父媒体资源中的转化事件列表。
patch PATCH /v1alpha/{conversionEvent.name=properties/*/conversionEvents/*}
更新具有指定属性的转化事件。

REST 资源:v1alpha.properties.customDimensions

方法
archive POST /v1alpha/{name=properties/*/customDimensions/*}:archive
归档媒体资源的自定义维度。
create POST /v1alpha/{parent=properties/*}/customDimensions
创建自定义维度。
get GET /v1alpha/{name=properties/*/customDimensions/*}
查找单个自定义维度。
list GET /v1alpha/{parent=properties/*}/customDimensions
列出媒体资源的自定义维度。
patch PATCH /v1alpha/{customDimension.name=properties/*/customDimensions/*}
更新媒体资源的自定义维度。

REST 资源:v1alpha.properties.customMetrics

方法
archive POST /v1alpha/{name=properties/*/customMetrics/*}:archive
归档媒体资源的自定义指标。
create POST /v1alpha/{parent=properties/*}/customMetrics
创建自定义指标。
get GET /v1alpha/{name=properties/*/customMetrics/*}
查找单个自定义指标。
list GET /v1alpha/{parent=properties/*}/customMetrics
列出媒体资源的自定义指标。
patch PATCH /v1alpha/{customMetric.name=properties/*/customMetrics/*}
更新媒体资源的 CustomMetric。

REST 资源:v1alpha.properties.dataStreams

方法
create POST /v1alpha/{parent=properties/*}/dataStreams
创建 DataStream。
delete DELETE /v1alpha/{name=properties/*/dataStreams/*}
删除媒体资源上的 DataStream。
get GET /v1alpha/{name=properties/*/dataStreams/*}
查找单个 DataStream。
getDataRedactionSettings GET /v1alpha/{name=properties/*/dataStreams/*/dataRedactionSettings}
查找单个 DataRedactionSettings。
getEnhancedMeasurementSettings GET /v1alpha/{name=properties/*/dataStreams/*/enhancedMeasurementSettings}
返回此数据流的增强型衡量设置。
getGlobalSiteTag GET /v1alpha/{name=properties/*/dataStreams/*/globalSiteTag}
返回指定网站数据流的网站代码。
list GET /v1alpha/{parent=properties/*}/dataStreams
列出媒体资源上的 DataStream。
patch PATCH /v1alpha/{dataStream.name=properties/*/dataStreams/*}
更新媒体资源上的 DataStream。
updateDataRedactionSettings PATCH /v1alpha/{dataRedactionSettings.name=properties/*/dataStreams/*/dataRedactionSettings}
更新属性的 DataRedactionSettings。
updateEnhancedMeasurementSettings PATCH /v1alpha/{enhancedMeasurementSettings.name=properties/*/dataStreams/*/enhancedMeasurementSettings}
更新此数据流的增强型衡量设置。

REST 资源:v1alpha.properties.dataStreams.eventCreateRules

方法
create POST /v1alpha/{parent=properties/*/dataStreams/*}/eventCreateRules
创建 EventCreateRule。
delete DELETE /v1alpha/{name=properties/*/dataStreams/*/eventCreateRules/*}
删除 EventCreateRule。
get GET /v1alpha/{name=properties/*/dataStreams/*/eventCreateRules/*}
查找单个 EventCreateRule。
list GET /v1alpha/{parent=properties/*/dataStreams/*}/eventCreateRules
列出网站数据流上的 EventCreateRules。
patch PATCH /v1alpha/{eventCreateRule.name=properties/*/dataStreams/*/eventCreateRules/*}
更新 EventCreateRule。

REST 资源:v1alpha.properties.dataStreams.measurementProtocolSecrets

方法
create POST /v1alpha/{parent=properties/*/dataStreams/*}/measurementProtocolSecrets
创建 Measurement Protocol 密钥。
delete DELETE /v1alpha/{name=properties/*/dataStreams/*/measurementProtocolSecrets/*}
删除目标 MeasurementProtocolSecret。
get GET /v1alpha/{name=properties/*/dataStreams/*/measurementProtocolSecrets/*}
查找单个“GA4”MeasurementProtocolSecret。
list GET /v1alpha/{parent=properties/*/dataStreams/*}/measurementProtocolSecrets
返回指定父级媒体资源下的子级 MeasurementProtocolSecret。
patch PATCH /v1alpha/{measurementProtocolSecret.name=properties/*/dataStreams/*/measurementProtocolSecrets/*}
更新 Measurement Protocol 密钥。

REST 资源:v1alpha.properties.dataStreams.sKAdNetworkConversionValueSchema

方法
create POST /v1alpha/{parent=properties/*/dataStreams/*}/sKAdNetworkConversionValueSchema
创建 SKAdNetworkConversionValueSchema。
delete DELETE /v1alpha/{name=properties/*/dataStreams/*/sKAdNetworkConversionValueSchema/*}
删除目标 SKAdNetworkConversionValueSchema。
get GET /v1alpha/{name=properties/*/dataStreams/*/sKAdNetworkConversionValueSchema/*}
查找单个 SKAdNetworkConversionValueSchema。
list GET /v1alpha/{parent=properties/*/dataStreams/*}/sKAdNetworkConversionValueSchema
列出视频流上的 SKAdNetworkConversionValueSchema。
patch PATCH /v1alpha/{skadnetworkConversionValueSchema.name=properties/*/dataStreams/*/sKAdNetworkConversionValueSchema/*}
更新 SKAdNetworkConversionValueSchema。

REST 资源:v1alpha.properties.displayVideo360AdvertiserLinkProposals

方法
approve POST /v1alpha/{name=properties/*/displayVideo360AdvertiserLinkProposals/*}:approve
批准 DisplayVideo360AdvertiserLinkProposal。
cancel POST /v1alpha/{name=properties/*/displayVideo360AdvertiserLinkProposals/*}:cancel
取消 DisplayVideo360AdvertiserLinkProposal。
create POST /v1alpha/{parent=properties/*}/displayVideo360AdvertiserLinkProposals
创建 DisplayVideo360AdvertiserLinkProposal。
delete DELETE /v1alpha/{name=properties/*/displayVideo360AdvertiserLinkProposals/*}
删除媒体资源的 DisplayVideo360AdvertiserLinkProposal。
get GET /v1alpha/{name=properties/*/displayVideo360AdvertiserLinkProposals/*}
查找单个 DisplayVideo360AdvertiserLinkProposal。
list GET /v1alpha/{parent=properties/*}/displayVideo360AdvertiserLinkProposals
列出媒体资源上的 DisplayVideo360AdvertiserLinkProposals。

REST 资源:v1alpha.properties.expandedDataSets

方法
create POST /v1alpha/{parent=properties/*}/expandedDataSets
创建 ExpandDataSet。
delete DELETE /v1alpha/{name=properties/*/expandedDataSets/*}
删除媒体资源上的 ExtendedDataSet。
get GET /v1alpha/{name=properties/*/expandedDataSets/*}
查找单个 ExtendedDataSet。
list GET /v1alpha/{parent=properties/*}/expandedDataSets
列出媒体资源上的 ExtendedDataSet。
patch PATCH /v1alpha/{expandedDataSet.name=properties/*/expandedDataSets/*}
更新媒体资源的 ExtendedDataSet。

REST 资源:v1alpha.properties.subpropertyEventFilters

方法
create POST /v1alpha/{parent=properties/*}/subpropertyEventFilters
创建子媒体资源事件过滤器。
delete DELETE /v1alpha/{name=properties/*/subpropertyEventFilters/*}
删除子媒体资源事件过滤器。
get GET /v1alpha/{name=properties/*/subpropertyEventFilters/*}
查找单个子媒体资源的事件过滤器。
list GET /v1alpha/{parent=properties/*}/subpropertyEventFilters
列出媒体资源中的所有子媒体资源事件过滤器。
patch PATCH /v1alpha/{subpropertyEventFilter.name=properties/*/subpropertyEventFilters/*}
更新子媒体资源的事件过滤器。