ウェブテスト

ウェブテストコレクションはウェブテストリソースのセットです。各ウェブテストリソースには、認証済みユーザーが使用できるコンテンツのウェブテストが記述されています。

このリソースのメソッドの一覧については、このページの最後をご覧ください。

リソース表現

アナリティクスウェブテストリソースの 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`	true の場合、エンドユーザーは Google アナリティクスの管理画面を介してウェブテストを編集することができます。	書き込み可能
`endTime`	`datetime`	ウェブテストの終了日時（ステータスが RUNNING から ENDED に変わった日時）。このフィールドは、ウェブテストが終了した場合のみ表示されます。このフィールドは読み取り専用です。
`equalWeighting`	`boolean`	すべてのパターンにトラフィックを均等に分配するかどうかを指定するブール値。値が False の場合、コンテンツのウェブテストはパターンの成果に基づいて動的にトラフィックを調整するデフォルトの動作を行います。省略可能で、デフォルトは False です。ウェブテストのステータスが ENDED の場合は、このフィールドは変更されません。	書き込み可能
`id`	`string`	ウェブテストの ID。パッチの適用と更新の場合の必須 ID です。作成の場合は使用できません。
`internalWebPropertyId`	`string`	このウェブテストが属するウェブプロパティの内部 ID。このフィールドは読み取り専用です。
`kind`	`string`	アナリティクスウェブテストのリソースタイプ。このフィールドは読み取り専用です。
`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`	`object`	ウェブテストの親リンク。このウェブテストが属するビュー（旧プロファイル）を参照します。
`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`	パターンの URL が元の URL と一致するように上書きされているかどうかを指定するブール値。ウェブテストのステータスが ENDED の場合は、このフィールドは変更されません。	書き込み可能
`selfLink`	`string`	このウェブテストのリンク。このフィールドは読み取り専用です。
`servingFramework`	`string`	ウェブテストパターンの配信と結果の評価に使用するフレームワーク。次のいずれかです。 REDIRECT: Google アナリティクスでは、パターンが異なるページへのトラフィックをリダイレクトし、選択したパターンを報告し、その結果を評価します。 API: Google アナリティクスでは、配信するパターンを選択して報告し、その結果を評価します。発信者は、選択したパターンを配信する必要があります。 EXTERNAL: パターンを外部に配信し、選択したパターンを Google アナリティクスに報告します。発信者は、選択したパターンを配信し、結果を評価する必要があります。	書き込み可能
`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」に設定できるようにするには、少なくとも 2 つのパターンが必要です。	書き込み可能
`variations[].name`	`string`	パターンの名前。ウェブテストを作成する場合、このフィールドは必須です。ウェブテストのステータスが ENDED の場合は、このフィールドは変更されません。	書き込み可能
`variations[].status`	`string`	パターンのステータス。有効な値は「ACTIVE」と「INACTIVE」です。「INACTIVE」のパターンは配信されません。ウェブテストのステータスが ENDED の場合は、このフィールドは変更されません。	書き込み可能
`variations[].url`	`string`	パターンの URL。ウェブテストのステータスが RUNNING か ENDED の場合は、このフィールドは変更されません。	書き込み可能
`variations[].weight`	`double`	このパターンに必要なウェイト。ウェブテストが実行中の場合のみ存在します。このフィールドは読み取り専用です。
`variations[].won`	`boolean`	ウェブテストが終了し、このパターンのパフォーマンスがオリジナルよりも（統計的に）はるかに良好な場合に True となります。このフィールドは読み取り専用です。
`webPropertyId`	`string`	このウェブテストが属するウェブプロパティの ID。UA-XXXXX-YY 形式のウェブプロパティ ID。このフィールドは読み取り専用です。
`winnerConfidenceLevel`	`double`	0～1 の浮動小数点数。最も掲載結果の高い組み合わせを選択する際の、必要な信頼度を指定します。ウェブテストのステータスが ENDED の場合は、このフィールドは変更されません。	書き込み可能
`winnerFound`	`boolean`	このウェブテストで最も掲載結果の高い組み合わせが見つかったかどうかを指定するブール値。このフィールドは読み取り専用です。

メソッド

delete: ウェブテストを削除します。
get: ユーザーがアクセスできるウェブテストを返します。
insert: 新しいウェブテストを作成します。
list: ユーザーがアクセスできるウェブテストを一覧表示します。
patch: 既存のウェブテストを更新します。このメソッドはパッチの動作をサポートしています。
update: 既存のウェブテストを更新します。