iQ イベント API | iQプロファイル | Tealium開発者ドキュメントプレビュー

この API と利用可能なオブジェクトフィールドについて詳しくは、iQ プロファイル API と iQ プロファイルオブジェクトを参照してください。

動作方法

iQ プロファイルオブジェクトのコンポーネントを作成、更新、削除するには、PATCH メソッドを使用します。

PATCH /v3/tiq/accounts/{ACCOUNT}/profiles/{PROFILE}

PATCH メソッドを使用すると、API を使用してプロファイルイベントをプログラムで変更し、保存または保存として使用することができます。API を使用して変更を行った後は、アプリケーションにログインして公開する必要があります。

cURL リクエストの例

curl --location --request PATCH 'https://platform.tealiumapis.com/v3/tiq/accounts/{ACCOUNT}/profiles/{PROFILE}' \
  --header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzUx...MiJ9' \
  --header 'Content-Type: application/json' \
  --data '

認証

ベアラートークンはすべての API 呼び出しの認証に使用され、API キーは認証呼び出しでのみ使用されます。ベアラートークンに加えて、認証応答には後続のサーバーサイド API 呼び出しで使用する必要がある、リージョン固有のホスト名も含まれます。

ベアラートークンを API キーから生成する方法については、Tealium API V3 入門ガイドを参照してください。

プロファイルフィールド

プロファイルイベントは、次の可能なフィールドを含む JSON オブジェクトです。

オブジェクト	タイプ	必須	説明
`versionTitle`	文字列	オプション	保存されたバージョンのタイトル。 `saveType` が `saveAs` の場合のデフォルト: `API \| {TIMESTAMP}` `saveType` が `save` の場合のデフォルト: 既存のバージョンのタイトル
`saveType`	文字列	オプション	PATCH リクエストで実行する保存のタイプ: `save` または `saveAs`。デフォルトは `saveAs`。
`notes`	文字列	必須	公開バージョンに関する追加のノート。
`operationList`	配列	必須	操作オブジェクトのリスト。たとえば、複数のイベント。
`op`	文字列	必須	実行する操作: `add`、`replace`、または `remove`。
`path`	文字列	必須	更新するコンポーネントのタイプと ID。形式は `/{TYPE}/{ID}`。
`value.object`	文字列	必須	更新されるオブジェクトのタイプ: `variable`、`extension`、または `event`。
`value.name`	文字列	必須 (add/replace)	イベントの名前。
`value.notes`	文字列	オプション	イベントに関するノート。
`value.status`	文字列	必須	オン/オフのステータス: `active` または `inactive`。
`value.occurrence`	文字列	オプション	イベントトリガーがトラッキングコールにどのくらいの回数結果をもたらすかを決定します。値: `Run Once` または `Run Always`。デフォルト: `Run Always`。
`value.type`	文字列	必須	トラッキングされるイベントのタイプ。トラッキングされるイベントのタイプ。 `mouseEvents`- 次のユーザーアクションを含みます: `click` - 訪問がページ上でマウスをクリックしたとき。 `mousedown` - 訪問がマウスを下に動かしたとき。 `mouseup` - 訪問がマウスを上に動かしたとき。 `mouseOver` - 訪問がページ上の特定の要素にマウスを重ねたとき。 `formSubmit` - 訪問がページ上のフォームを送信したとき。 `youtubeVideo` - 訪問がページ上の埋め込み YouTube ビデオと対話したとき。 `vimeoVideo` - 訪問がページ上の埋め込み Vimeo ビデオと対話したとき。 `html5Video` - 訪問がページ上の埋め込み HTML5 ビデオと対話したとき。 `pageView` - 訪問がページを表示したとき。 `scroll` - 訪問がページを垂直または水平にスクロールしたとき。 `elementVisibility` - ページが訪問に画面要素を表示するとき。
`value.scope`	文字列	オプション	イベントスコープの名前。 `DOM Ready` `After Load Rules`
`value.trackingEvent`	文字列	必須	イベントリスナーのトラッキングイベント: `link` `view` `custom-event-of-anytype`
`value.selectedTargets`	マップ <string, Boolean>	オプション	コンポーネントを公開する環境のオブジェクト: `{ "prod" : true\|false, "qa" : true\|false, "dev" : true\|false }` デフォルト: すべての環境が `true` に構成されています。
`value.eventTriggers`	オブジェクト	必須	各イベントタイプに固有の構成。値は `"object": "[value.Type]"` の形式であり、イベントの構成に続きます。
`value.eventVariables`	配列	必須	各イベントタイプに固有の変数。
`value.bufferingEventVariables`	配列	必須	バッファリングイベントが発生したかどうかを示す変数。
`value.rules`	オブジェクト	必須	イベントリスナーがページでロードされるタイミングを指示するルール。

リクエストの例

{
  "versionTitle": "イベントの追加",
  "saveType": "saveAs",
  "notes": "新しいイベントを追加しました",
  "operationList": [
    {
      "op": "add",
      "path": "/events",
      "value":{
        "object": "event",
        "name": "新しい API イベント",
        "notes": "イベントのノート",
        "status": "active",
        "occurence": "Run Always",
        "type": "youtubeVideo",
        "scope": "After Load Rules",
        "trackingEvent": "link",
        "selectedTargets":{
          "qa": true,
          "dev": true,
          "prod": true
        },
        "eventTriggers": {
          "object": "youtubeVideo",
           "enabledVideoEventsList": [
            "play", "pause", "buffering", "milestones"
          ],
           "cssSelector": "mycss.selector",
           "milestoneOption": "percentageComplete",
           "milestonesList": [25,50,75,100],
         },
         "eventVariables":
         [
          {
            "variable": "tealium_event",
            "type": "text",
            "value": "youTube_video"
          }
        ],
         "bufferingEventVariables": [
          {
            "variable": "buffering",
            "type": "text",
            "value": "true"
          }
        ],
         "rules": {
          "apply": [ 
            {
              "and": [{"or": [{"uid": 52, "type": "loadRule"}]}]}
            ],
          "exclude": []
        }
      }
    } 
  ] 
}

PATCH 操作パラメータ

POST、PUT、DELETE メソッドの代わりに、PATCH メソッドでは op パラメータを使用して実行するアクションを指定します。

op パラメータは、次の値をサポートしています:

add - コンポーネントを作成します。
replace - コンポーネントを更新します。
remove - コンポーネントを削除します。

コンポーネントのタイプと ID を指定するには、path パラメータを使用します。path パラメータの形式は /{TYPE}/{ID} です。

たとえば、イベントを追加するには:

"op" : "add",
"path" : "/events"

特定のイベントを更新するには、パスに ID を追加します:

"op" : "replace",
"path" : "/events/503"

イベントの作成

この PATCH メソッドは、プロファイルオブジェクトと追加のイベントフィールドを受け取ります。

リクエストの例

{
  "versionTitle": "イベントの追加",
  "saveType": "saveAs",
  "notes": "新しいイベントを追加しました",
  "operationList": [
    {
      "op": "add",
      "path": "/events",
      "value":{
        "object": "event",
        "name": "新しい API イベント",
        "status": "active",
        "occurence": "Run Always",
        "type": "youtubeVideo",
        "scope": "After Load Rules",
        "trackingEvent": "link",
        "selectedTargets":{
          "qa": true,
          "dev": true,
          "prod": true
        },
        "eventTriggers": {
          "object": "youtubeVideo",
           "enabledVideoEventsList": [
            "play", "pause", "buffering", "milestones"
          ],
           "cssSelector": "mycss.selector",
           "milestoneOption": "percentageComplete",
           "milestonesList": [25,50,75,100],
         },
         "eventVariables":
         [
          {
            "variable": "tealium_event",
            "type": "text",
            "value": "youTube_video"
          }
        ],
         "bufferingEventVariables": [
          {
            "variable": "buffering",
            "type": "text",
            "value": "true"
          }
        ],
         "rules": {
          "apply": [ 
            {
              "and": [{"or": [{"uid": 52, "type": "loadRule"}]}]}
            ],
          "exclude": []
        }
      }
    } 
  ] 
}

イベントの更新

この PATCH メソッドは、プロファイルオブジェクトと追加のイベントフィールドを受け取ります。

リクエストの例

{
  "versionTitle": "イベントの追加",
  "saveType": "saveAs",
  "notes": "新しいイベントを追加しました",
  "operationList": [
    {
      "op": "replace",
      "path": "/events/503",
     "value":{
        "object": "event",
        "name": "新しい API イベント",
        "status": "active",
        "occurence": "Run Always",
        "type": "youtubeVideo",
        "scope": "After Load Rules",
        "trackingEvent": "link",
        "selectedTargets":{
          "qa": true,
          "dev": true,
          "prod": true
        },
        "eventTriggers": {
          "object": "youtubeVideo",
           "enabledVideoEventsList": [
            "play", "pause", "buffering", "milestones"
          ],
           "cssSelector": "mycss.selector",
           "milestoneOption": "percentageComplete",
           "milestonesList": [25,50,75,100],
         },
         "eventVariables":
         [
          {
            "variable": "tealium_event",
            "type": "text",
            "value": "youTube_video"
          }
        ],
         "bufferingEventVariables": [
          {
            "variable": "buffering",
            "type": "text",
            "value": "true"
          }
        ],
         "rules": {
          "apply": [ 
            {
              "and": [{"or": [{"uid": 52, "type": "loadRule"}]}]}
            ],
          "exclude": []
        }
      }
    } 
  ] 
}

イベントの削除

この PATCH メソッドは、プロファイルオブジェクトと追加のイベントフィールドを受け取ります。

リクエストの例

{
  "versionTitle": "イベントの追加",
  "saveType": "saveAs",
  "notes": "新しいイベントを追加しました",
  "operationList": [
    {
      "op": "remove",
      "path": "/events/503",
      "value":{
        "object": "event"
      }
    }
  ] 
}

エラーメッセージ

このエンドポイントの潜在的なエラーメッセージ:

エラーコード	エラーメッセージ
400	`"Profile libraries are out of date, merge changes before patching profile - {ACCOUNT} \| profile: {PROFILE}"` `"patchProfile.arg2.notes: must not be empty"`
404	`"Profile not found - account: {ACCOUNT} \| profile: {PROFILE}"` `"Profile library not found - account: {ACCOUNT} \| profile: {PROFILE}"` `"Profile (legacy) not found - account: {ACCOUNT} \| profile: {PROFILE}"` `"Latest version not found - {ACCOUNT} \| profile: {PROFILE}"`
409	`"Users are currently viewing the same account: {ACCOUNT} \| profile: {PROFILE}"`
500	`"Profile: {PROFILE} inherits from library profile"` `"Error saving profile metadata - account: {ACCOUNT} \| profile: {PROFILE}"` `"Error saving profile - account: {ACCOUNT} \| profile: {PROFILE}"` `"Error saving profile(legacy) - {ACCOUNT} \| profile: {PROFILE}"`