Google Analytics Admin API

服务: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
可申请创建帐号的工单。
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/*}
更新属性。
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
返回指定父级媒体资源中的转化事件列表。

REST 资源:v1beta.properties.customDimension

方法
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/*}
更新媒体资源上的 CustomDimension。

REST 资源:v1beta.properties.customMetrics

方法
archive POST /v1beta/{name=properties/*/customMetrics/*}:archive
归档媒体资源上的 CustomMetric。
create POST /v1beta/{parent=properties/*}/customMetrics
创建 CustomMetric。
get GET /v1beta/{name=properties/*/customMetrics/*}
查找单个自定义指标。
list GET /v1beta/{parent=properties/*}/customMetrics
可列出媒体资源上的 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”Measurement ProtocolSecret。
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
可申请创建帐号的工单。
searchChangeHistoryEvents POST /v1alpha/{account=accounts/*}:searchChangeHistoryEvents
根据指定的一组过滤条件搜索帐号或其子级的所有更改。

REST 资源:v1alpha.properties

方法
acknowledgeUserDataCollection POST /v1alpha/{property=properties/*}:acknowledgeUserDataCollection
确认指定媒体资源的用户数据收集条款。
create POST /v1alpha/properties
创建具有指定位置和属性的 GA4 媒体资源。
delete DELETE /v1alpha/{name=properties/*}
将目标属性标记为软删除(即“垃圾”),并将其返回。
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
返回指定父帐号下的子媒体资源。
patch PATCH /v1alpha/{property.name=properties/*}
更新属性。
runAccessReport POST /v1alpha/{entity=properties/*}:runAccessReport
返回数据访问记录的自定义报告。
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.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.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
返回指定父级媒体资源中的转化事件列表。

REST 资源:v1alpha.properties.customDimension

方法
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/*}
更新媒体资源上的 CustomDimension。

REST 资源:v1alpha.properties.customMetrics

方法
archive POST /v1alpha/{name=properties/*/customMetrics/*}:archive
归档媒体资源上的 CustomMetric。
create POST /v1alpha/{parent=properties/*}/customMetrics
创建 CustomMetric。
get GET /v1alpha/{name=properties/*/customMetrics/*}
查找单个自定义指标。
list GET /v1alpha/{parent=properties/*}/customMetrics
可列出媒体资源上的 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。
getGlobalSiteTag GET /v1alpha/{name=properties/*/dataStreams/*/globalSiteTag}
返回指定网站数据流的网站代码。
list GET /v1alpha/{parent=properties/*}/dataStreams
列出媒体资源上的 DataStream。
patch PATCH /v1alpha/{dataStream.name=properties/*/dataStreams/*}
更新媒体资源上的 DataStream。

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”Measurement ProtocolSecret。
list GET /v1alpha/{parent=properties/*/dataStreams/*}/measurementProtocolSecrets
返回指定父媒体资源下的子 MeasurementProtocolSecret。
patch PATCH /v1alpha/{measurementProtocolSecret.name=properties/*/dataStreams/*/measurementProtocolSecrets/*}
更新 Measurement Protocol 密钥。

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。