实验

使用集合让一切井井有条 根据您的偏好保存内容并对其进行分类。

“实验”集合是一组“实验”资源,其中每个资源都描述了向已验证用户提供的一个内容实验。

有关此类资源的方法列表,请参阅本页面的结尾部分。

资源表示形式

用于 Google Analytics(分析)“实验”资源的 JSON 模板。

{
  "id": string,
  "kind": "analytics#experiment",
  "selfLink": string,
  "accountId": string,
  "webPropertyId": string,
  "internalWebPropertyId": string,
  "profileId": string,
  "name": string,
  "description": string,
  "created": datetime,
  "updated": datetime,
  "objectiveMetric": string,
  "optimizationType": string,
  "status": string,
  "winnerFound": boolean,
  "startTime": datetime,
  "endTime": datetime,
  "reasonExperimentEnded": string,
  "rewriteVariationUrlsAsOriginal": boolean,
  "winnerConfidenceLevel": double,
  "minimumExperimentLengthInDays": integer,
  "trafficCoverage": double,
  "equalWeighting": boolean,
  "snippet": string,
  "variations": [
    {
      "name": string,
      "url": string,
      "status": string,
      "weight": double,
      "won": boolean
    }
  ],
  "servingFramework": string,
  "editableInGaUi": boolean,
  "parentLink": {
    "type": "analytics#profile",
    "href": string
  }
}
属性名称 说明 备注
accountId string 此实验所属的帐户 ID。此为只读字段。
created datetime 此实验的创建时间。此为只读字段。
description string 关于此实验的备注。 可写入
editableInGaUi boolean 如果为真,则最终用户可以通过 Google Analytics(分析)界面来编辑实验。 可写入
endTime datetime 实验的结束时间(状态从 RUNNING 变为 ENDED 时)。只有当实验已结束时才会出现此字段。此字段为只读。
equalWeighting boolean 指明是否要在各变体之间均匀分配流量的布尔值。如果此值为 False,内容实验将遵循默认行为,即根据变体效果动态调整流量。可选 -- 默认为 False。对于状态为 ENDED 的实验,此字段不可更改。 可写入
id string 实验 ID。在进行修补和更新时必须提供。创建时不可用。
internalWebPropertyId string 此实验所属的网络媒体资源的内部 ID。此为只读字段。
kind string Google Analytics(分析)实验的资源类型。此为只读字段。
minimumExperimentLengthInDays integer 在 [3, 90] 范围内的整数。指定实验的最短时间。对于运行中的实验,可以修改此字段。对于状态为 ENDED 的实验,此字段不可更改。 可写入
name string 实验名称。对于状态为 ENDED 的实验,此字段不可更改。创建实验时,此字段为必填。 可写入
objectiveMetric string 该实验正在进行优化的指标。有效的值包括:“ga:goal(n)Completions”、“ga:adsenseAdsClicks”、“ga:adsenseAdsViewed”、“ga:adsenseRevenue”、“ga:bounces”、“ga:pageviews”、“ga:sessionDuration”、“ga:transactions”、 “ga:transactionRevenue”。当状态为“RUNNING”,并且 servingFramework 是“REDIRECT”或“API”时,此字段为必填。 可写入
optimizationType string 指明 objectiveMetric 应该最小化还是最大化。可取的值为:“MAXIMUM”、“MINIMUM”。可选 -- 默认为“MAXIMUM”。 没有 objectiveMetric 则不能指定。状态为“RUNNING”或“ENDED”时不可修改。 可写入
parentLink.href string 链接到此实验所属的数据视图(配置文件)。此为只读字段。
parentLink.type string 其值为“analytics#profile”。此为只读字段。
profileId string 此实验所属的数据视图(配置文件)ID。此为只读字段。
reasonExperimentEnded string 实验结束的原因。可能的值:"STOPPED_BY_USER"、"WINNER_FOUND"、"EXPERIMENT_EXPIRED"、"ENDED_WITH_NO_WINNER"、"GOAL_OBJECTIVE_CHANGED"。"ENDED_WITH_NO_WINNER" 是指实验并未过期,但预计无法找出胜者。如果通过 API 将实验状态更改为“ENDED”,此字段将被设置为 STOPPED_BY_USER。此字段为只读。
rewriteVariationUrlsAsOriginal boolean 指明是否要重写变体网址以与原始版本的网址匹配的布尔值。对于状态为 ENDED 的实验,此字段不可更改。 可写入
servingFramework string 用于投放实验变体和评估实验结果的框架。为以下类型之一:
  • REDIRECT:Google Analytics(分析)将流量重定向到不同的变体页面,报告所选的变体并评估结果。
  • API:Google Analytics(分析)选择并报告要投放的变体,然后评估结果;调用者负责投放所选变体。
  • EXTERNAL:在外部投放变体,并将所选变体报告给 Google Analytics(分析)。调用者负责投放所选变体和评估结果。
可写入
snippet string 要包含在控制页里的代码段。此为只读字段。
startTime datetime 实验的开始时间(状态从 READY_TO_RUN 变为 RUNNING 时)。只有当实验已开始时才会出现此字段。此字段为只读。
status string 实验状态。可能的值有:“DRAFT”、“READY_TO_RUN”、“RUNNING”、“ENDED”。实验可以创建为“DRAFT”、“READY_TO_RUN”或“RUNNING”状态。创建实验时,此字段为必填。 可写入
trafficCoverage double 一个介于 0 和 1 之间的浮点数。指定用于实验的很小一部分流量。对于运行中的实验,可以修改此字段。对于状态为 ENDED 的实验,此字段不可更改。 可写入
updated datetime 实验的最后修改时间。此为只读字段。
variations[] list 变体的数组。数组中的第一个变体为原始版本。当实验处于 RUNNING 状态时,变体数量不可更改。变体数量必须至少为两个,才可以将状态设置为 RUNNING。 可写入
variations[].name string 变体名称。创建实验时,此字段为必填。对于状态为 ENDED 的实验,此字段不可更改。 可写入
variations[].status string 变体的状态。可能的值有:“ACTIVE”、“INACTIVE”。状态为 INACTIVE 的变体将不会投放。对于状态为 ENDED 的实验,此字段不可更改。 可写入
variations[].url string 变体的网址。对于状态为 RUNNING 或 ENDED 的实验,此字段不可更改。 可写入
variations[].weight double 变体应获得的权重。只有当实验正在运行时才会出现此字段。此该字段为只读。
variations[].won boolean 如果实验已结束,并且此变体的效果(在统计上)显著好于原始版本,则为真。此为只读字段。
webPropertyId string 此实验所属的网络媒体资源 ID。网络媒体资源 ID 的格式为 UA-XXXXX-YY。该字段为只读。
winnerConfidenceLevel double 一个介于 0 和 1 之间的浮点数。指定为选出胜者所必需的置信度。对于状态为 ENDED 的实验,此字段不可更改。 可写入
winnerFound boolean 指明是否已经为此实验找出胜者的布尔值。此为只读字段。

方法

delete
删除一个实验。
get
返回用户有权访问的一个实验。
insert
创建一个新实验。
list
列出用户有访问权限的实验。
patch
更新一个现有的实验。此方法支持修补语义。
update
更新一个现有的实验。