# 計測用の拡張APIについて
### カスタムイベントの設定 setCustomEvent
機能：適応される度、イベント数を転送し、ボタンクリック・登録完了・ショッピングカートに入れるなどの行動データを計測できます。業務に必要なロジックに基づいてセッティングし、データを得ることができます。例として、登録数を計測する場合、カスタムイベントコードをajaxの成功関数式に設置し、計測を進まれます。
**形式:**
```
ptengine.track('setCustomEvent',{ eventName:'イベント名', isActiveElement:インタラクティブ要素なのか})
```
パラメーターeventName：イベント名，String種類，固定文字列選択必須。\
パラメーターisActiveElement: インタラクティブ要素なのか，Number，選択可能，1:インタラクティブ要素，0:非インタラクティブ要素。初期値は0。
**事例：**
```
ptengine.track('setCustomEvent',{
eventName:'手動イベント計測',
isActiveElement:1
})
```
### カスタムディメンジョン setCustomVar
**形式：**
```
ptengine.track('setCustomVarV2',{eventName: 'イベント系カスタム変数'})
```
**機能：**イベント設定の上、コードでカスタム変数を追加することができます。例として、「ショッピングカートに入れる」とのイベントに対して、商品の種類や商品の値段などを計測できます。該当する変数はそれぞれ「ショッピングカートに入れた商品の種類」と「ショッピングカートに入れた商品の値段」になります。こちらの機能は特別プランを使わせて頂くか、またはDataDeckとの連携を行うことで使用できます。
**パラメーター：**\
setCustomVarV2は固定値であるため、必ず選択ください。2つ目のパラメーターはjson形式対象になります。2番目のパラメータ{key：value}：データが収集されないキー：値を最大10個追加します。図では4つが設定され、さらに6つは設定できます。
**Key（プロパティ名）：**数字、文字、アンダースコアの組み合わせを使用します。これ以外の文字が使用されている場合、データは収集されません。また12文字以上でもデータが収集できない仕様となっています。そして重複するキーを追加すると、重複するキーに上書きされます。
**Value（プロパティ値）：**データ型：string、int、float、dateの4種類となります。これ以外のデータ型を使用すると、データは収集されません。さまざまなデータ型値の長さ制限は以下の通りです。
**文字列（string）：**50文字以上のデータは収集されません。
**整数（int）：**(-2147483648,2147483647)，この範囲外の整数を使用すると、データが収集されません。
**フロート（float）**：(-4294967296,4294967294)，この範囲外の浮動小数点数を使用してもデータは収集されません。
**日付（date）**：時刻の形式は「YYYY-MM-DD HH：MM：SS」である必要があります。形式が正しくない場合、データは収集されません。
**事例：**
```
ptengine.track('setCustomVarV2',{
eventName: '購入',
productId: 123456,
productCatalog: '商品カテゴリ',
productName: '商品名',
productPrice: 123.45,
createDate: '2018-04-23 15:40:46'
})
```
### クロスドメイン設定setCrossDomainLink
**形式：**
```
ptengine.track('setCrossDomainLink,allManual/halfManual ');
```
**機能：**クロスドメイン設定による連携。AドメインとBドメインに同じ計測コードを設置しても、ユーザーがAドメインからBドメインまでにドメイン移動をした場合、cookieの共有ができないため、訪問数が分けられてしまい、正しいデータの収集が妨げられます。訪問を連携させるため、こちらの機能を使って訪問を付け合うことができます。このAPIの原理は、cookie情報を取り、それをhrefタグ属性の連携点情報にすることで、システムの訪問データを取集する原理です。もしウェブサイトからの移動がaタグhref方式ではない場合、この機能はご使用できません。
**パラメーター：**\
allManual全手動モードになります。クロスドメイン処理を実行する必要のあるaタグ内に、onclick="pt\_domain"属性を追加します。ユーザーがすでにonclickイベントを設定している場合（例：onclick="test()"）、その一番後ろにpt\_domainを加えても構いません（例：onclick="test();pt\_domain"）。もしこの属性のaタグがない場合、ドメインを超えての処理はされません。
halfManualは半手動モードになります。aタグに修正をしなくても、ページ内の全てのaタグにクロスドメイン処理をかけます。
### 設定ページtitle setVPT
**形式：**
```
ptengine.track('setVPT,デモtilte');
```
**功能：**デモtitleを設定。ページにtitleタグがない場合、Ptengine上ではnot setで表示されてしまいますが、このような場合をなくすため、この機能を使用し、手動でページタイトルを設定することができます。
**事例：**
```
ptengine.track('setVPT,ptmind');
```
ページ元title：ptengine\
setVPT使用後、Ptengineで見えるtitle：ptmind
### setVPV
**形式：**
```
ptengine.track('setVPV,デモurl');
```
**機能：**デモurlを設定できます。注意点：この機能を使用する時、URLが自動で小文字化されるため、URLに大文字が含まれている場合、影響される可能性がございます。
事例：
```
ptengine.track('setVPV,http://www.baidu.com/your');
```
元URL：`http://www.baidu.com`\
setVPV 後：`http://www.baidu.com/your`
### setURL
**形式：**\_pt\_sp\_2.push('setURL,＃');
**機能：**urlの「#」後の情報を設定します。
**事例：**
```
ptengine.track('setURL,btnSave');
```
元URL：`http://www.baidu.com`
setURL使用後Ptengineで表示されるURL：`http://www.baidu.com#btnSave`
### サンプル率設定 setSampleRate
**形式：**
```
ptengine.track('setSampleRate, サンプル率');
```
**機能：**収集されるデータのサンプル率を設定します。もしウェブサイトへの訪問データが膨大しすぎて、全量収集を行いたくない場合、サンプル率をご設定すれば、データ計測を制御することができます。
**パラメーター1：** サンプル率の設定、選択必須。例：1000で設定した場合、表示されるサンプル率は1/1000となり、1万UUの中に10UUの訪問データだけを取ります。
事例：
```
```
### 広告パラメーターで訪問を新しく発生させない setIgnoreCampaign
形式：
```
ptengine.track('setIgnoreCampaign,true');
```
**機能：** データ収集システムが自動で広告パラメーターを含んだページを新しい訪問の入口ページとして表示するため、ずっと再読み込みをしても、毎回の再読み込みが新しい訪問の入口ページとしてカウントされます。
**パラメーター：**こちらの值がtrueである場合，広告(utm)パラメーターは無視し、広告パラメーターで訪問数を新しく発生させません。falseである場合、広告 (utm)パラメーターは無視せず、毎回訪問は広告パラメーターを含んだページへとなるため、新しい訪問としてカウントされます。
### iframe内のイベント計測機能オン setIframe
**形式：**
```
ptengine.track('setIframe, true');
```
**機能：**iframe内のイベント計測機能を開く
**パラメーター：**こちらの值がtrueである場合，iframe内のイベント計測機能がオンとなり、trueでない場合はオンになりません。基本設定状態では、iframe内のイベント継続機能はオフになっています。
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://helps.ptengine.com/developer/extended-api.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.