iQイベントAPI
iQイベントAPIはPATCHメソッドを使用してプロファイルイベントを更新します。
このAPIと利用可能なオブジェクトフィールドについて詳しくは、iQプロファイルAPIとiQプロファイルオブジェクトをご覧ください。
使い方
PATCHメソッドを使用して、iQプロファイルオブジェクト内のコンポーネントを作成、更新、削除します。
PATCH /v3/tiq/accounts/{ACCOUNT}/profiles/{PROFILE}
PATCHメソッドを使用すると、保存または名前を付けて保存を使用してプロファイルイベントをプログラムで変更します。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呼び出しで使用する必要がある地域固有のホスト名が含まれます。
APIキーからベアラートークンを生成する方法については、認証をご覧ください。
プロファイルフィールド
プロファイルイベントは、以下の可能なフィールドを含む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 |
文字列 | 必須 | トラッキングされるイベントのタイプ。トラッキングされるイベントのタイプ。
|
value.scope |
文字列 | 任意 | イベントスコープの名前。DOM ReadyAfter Load Rules |
value.trackingEvent |
文字列 | 必須 | イベントリスナーのトラッキングイベント：link viewcustom-event-of-anytype |
value.selectedTargets |
Map <string, Boolean> | 任意 | コンポーネントを公開する環境のオブジェクト：{ "prod" : true|false, "qa" : true|false, "dev" : true|false } デフォルト：すべての環境が trueに構成されています。 |
value.eventTriggers |
オブジェクト | 必須 | 各イベントタイプに特有の構成。値は"object": "[value.Type]"の形式で、それに続いてイベントの構成があります。 |
value.eventVariables |
配列 | 必須 | 各イベントタイプに特有の変数。 |
value.bufferingEventVariables |
配列 | 必須 | バッファリングイベントが発生したことを示す変数。 |
value.rules |
オブジェクト | 必須 | イベントリスナーがページ上でロードされるときのルール。 |
リクエストの例
{
"versionTitle": "Adding Events",
"saveType": "saveAs",
"notes": "added a new event",
"operationList": [
{
"op": "add",
"path": "/events",
"value":{
"object": "event",
"name": "new API event",
"notes": "event 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": "Adding Events",
"saveType": "saveAs",
"notes": "added a new event",
"operationList": [
{
"op": "add",
"path": "/events",
"value":{
"object": "event",
"name": "new API event",
"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 | "プロファイルライブラリが古いため、プロファイルをパッチする前に変更をマージしてください - {ACCOUNT} | プロファイル: {PROFILE}""patchProfile.arg2.notes: 空であってはなりません" |
| 404 | "プロファイルが見つかりません - アカウント: {ACCOUNT} | プロファイル: {PROFILE}""プロファイルライブラリが見つかりません - アカウント: {ACCOUNT} | プロファイル: {PROFILE}""プロファイル（レガシー）が見つかりません - アカウント: {ACCOUNT} | プロファイル: {PROFILE}""最新バージョンが見つかりません - {ACCOUNT} | プロファイル: {PROFILE}" |
| 409 | "現在、同じアカウントを表示しているユーザーがいます: {ACCOUNT} | プロファイル: {PROFILE}" |
| 500 | "プロファイル: {PROFILE} はライブラリプロファイルから継承されます""プロファイルメタデータの保存エラー - アカウント: {ACCOUNT} | プロファイル: {PROFILE}""プロファイルの保存エラー - アカウント: {ACCOUNT} | プロファイル: {PROFILE}""プロファイル（レガシー）の保存エラー - {ACCOUNT} | プロファイル: {PROFILE}" |
最終更新日 :: 2024年June月27日