目標

目標リソースは、ユーザーのプロファイルの目標を個別に記述したものです。

このリソースのメソッドの一覧は、このページの最後に掲載されています。

リソース表現

アナリティクス目標リソースの JSON テンプレート。

{
  "id": string,
  "kind": "analytics#goal",
  "selfLink": string,
  "accountId": string,
  "webPropertyId": string,
  "internalWebPropertyId": string,
  "profileId": string,
  "name": string,
  "value": float,
  "active": boolean,
  "type": string,
  "created": datetime,
  "updated": datetime,
  "parentLink": {
    "type": "analytics#profile",
    "href": string
  },
  "urlDestinationDetails": {
    "url": string,
    "caseSensitive": boolean,
    "matchType": string,
    "firstStepRequired": boolean,
    "steps": [
      {
        "number": integer,
        "name": string,
        "url": string
      }
    ]
  },
  "visitTimeOnSiteDetails": {
    "comparisonType": string,
    "comparisonValue": long
  },
  "visitNumPagesDetails": {
    "comparisonType": string,
    "comparisonValue": long
  },
  "eventDetails": {
    "useEventValue": boolean,
    "eventConditions": [
      {
        "type": string,
        "matchType": string,
        "expression": string,
        "comparisonType": string,
        "comparisonValue": long
      }
    ]
  }
}
プロパティ名 説明 備考
accountId string この目標が属するアカウントID。
active boolean この目標が有効かどうかを指定します。
created datetime この目標の作成日時。
eventDetails object EVENT タイプの目標の詳細。
eventDetails.eventConditions[] list イベント条件のリスト。
eventDetails.eventConditions[].comparisonType string 比較のタイプ。有効な値は LESS_THANGREATER_THANEQUAL です。
eventDetails.eventConditions[].comparisonValue long この比較に使用する値。
eventDetails.eventConditions[].expression string このマッチに使用する式。
eventDetails.eventConditions[].matchType string 実行するキーワード マッチ。有効な値は REGEXPBEGINS_WITHEXACT です。
eventDetails.eventConditions[].type string このイベント条件のタイプ。有効な値は CATEGORYACTIONLABELVALUE です。
eventDetails.useEventValue boolean イベント値をこの目標の値として使用するかどうかを指定します。
id string 目標 ID。
internalWebPropertyId string この目標が属するウェブ プロパティの内部 ID。
kind string アナリティクスの目標のリソースタイプ。
name string 目標名。
parentLink.href string この目標が属するビューへのリンク。
parentLink.type string 値は「analytics#profile」です。
profileId string この目標が属するビューの ID。
type string 目標のタイプ。有効な値は URL_DESTINATIONVISIT_TIME_ON_SITEVISIT_NUM_PAGESEVENT です。
updated datetime この目標の最終更新日時。
urlDestinationDetails object URL_DESTINATION タイプの目標の詳細。
urlDestinationDetails.caseSensitive boolean 目標の URL とアクセスした URL の大文字と小文字が正確に一致している必要があるかどうかを指定します。
urlDestinationDetails.firstStepRequired boolean この目標の最初のステップが必要であるかどうかを指定します。
urlDestinationDetails.matchType string 目標の URL のキーワード マッチ。有効な値は HEADEXACTREGEX です。
urlDestinationDetails.steps[] list この目標到達プロセスのために設定したステップのリスト。
urlDestinationDetails.steps[].name string ステップの名前。
urlDestinationDetails.steps[].number integer ステップの数。
urlDestinationDetails.steps[].url string このステップの URL。
urlDestinationDetails.url string この目標の URL。
value float 目標の値。
visitNumPagesDetails object VISIT_NUM_PAGES タイプの目標の詳細。
visitNumPagesDetails.comparisonType string 比較のタイプ。有効な値は LESS_THANGREATER_THANEQUAL です。
visitNumPagesDetails.comparisonValue long この比較に使用する値。
visitTimeOnSiteDetails object VISIT_TIME_ON_SITE タイプの目標の詳細。
visitTimeOnSiteDetails.comparisonType string 比較のタイプ。有効な値は LESS_THANGREATER_THAN です。
visitTimeOnSiteDetails.comparisonValue long この比較に使用する値。
webPropertyId string この目標が属するウェブ プロパティの ID。UA-XXXXX-YY 形式のウェブ プロパティ ID。

メソッド

get
ユーザーがアクセスできる目標を取得します。
insert
新しい目標を作成します。
list
ユーザーがアクセスできる目標を一覧表示します。
patch
既存の目標を更新します。このメソッドはパッチの動作をサポートしています。
update
既存の目標を更新します。