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、またはtag。 |
value.tagID |
文字列 | 必須 | ユニークなタグテンプレートID。タグIDを取得するにはGETリクエストを使用します。この値はタグUIDとは異なります。 |
value.status |
文字列 | 任意 | オン/オフのステータス：activeまたはinactive。 |
value.notes |
文字列 | 任意 | タグに関するノート。 |
value.name |
文字列 | 必須（add/replaceの場合） | タグの名前。 |
value.selectedTargets |
Map <string, Boolean> | 任意 | コンポーネントを公開する環境のオブジェクト。{ "prod" : true|false, "qa" : true|false, "dev" : true|false } デフォルト：すべての環境が trueに構成されています。 |
value.tagConfiguration |
Map <String, Object> | 任意 | ベンダーが提供するタグ構成の文字列とオブジェクトのマップ。構成は各タグに固有です。詳細については、タグのドキュメンテーションを参照してください。 |
value.advancedConfiguration |
オブジェクト | 任意 | タグ構成構成に対応する高度な構成のセット。advConfigBundle — TrueまたはFalseadvConfigLoadType — TrueまたはFalseadvConfigOptOut — TrueadvConfigSend— TrueまたはFalse advConfigSrc — テキストフィールドtagTiming — DOM ReadyまたはPrioritized |
value.rules |
オブジェクト | 任意 | タグに適用または除外するロードルール。 |
value.dataMappings |
Map <String, String> | 任意 | Tealium IQ変数とそれに対応するマップされた宛先。マップされた変数トリガーの特定の形式は、タグ構成のData Mappings画面で確認できます。 |
リクエストの例
{
"versionTitle": "バージョンタイトル",
"notes": "ノート",
"operationList": [
{
"op": "add",
"path": "/tags",
"value": {
"object": "tag",
"tagId": "7133",
"status": "active",
"notes": "タグを追加",
"name": "7133タグGoogle Analytics",
"dataMappings": [
{
"variable": "変数名",
"type": "udo",
"mappings": ["a1", "a2"]
}
],
"selectedTargets": {
"qa": true,
"dev": true,
"prod": true
},
"advancedConfiguration": {
"bundleFlag": true,
"syncLoadType": false,
"optout": true,
"scriptSource": "",
"sendFlag": false,
"tagTiming": "Dom Ready"
},
"tagConfiguration": {
"tracking_id": "123"
},
"rules": {
"apply": [{"and": [{"or": [{"uid": "2", "type": "loadRule"}]}]}],
"exclude": [{"and": [{"or": [{"uid": "3", "type": "loadRule"}, {"uid": "2", "type": "loadRule"}]}]}]
}
}
}
]
}
PATCH操作パラメータ
POST、PUT、DELETEメソッドの代わりに、PATCHメソッドはopパラメータを使用して実行するアクションを指定します。
opパラメータは以下の値をサポートします：
add- コンポーネントを作成します。replace- コンポーネントを更新します。remove- コンポーネントを削除します。
コンポーネントのタイプとIDを指定するには、pathパラメータを使用します。pathパラメータの形式は/{TYPE}/{ID}です。
例えば、タグを追加するには：
"op" : "add",
"path" : "/tags"
特定のタグを更新するには、IDをパスに追加します：
"op" : "replace",
"path" : "/tags/503"
タグの作成
このPATCHメソッドはプロファイルオブジェクトと追加のタグフィールドを取ります。
リクエストの例
{
"versionTitle": "バージョンタイトル",
"notes": "ノート",
"operationList": [
{
"op": "add",
"path": "/tags",
"value": {
"object": "tag",
"tagId": "7133",
"status": "active",
"notes": "タグを追加",
"name": "7133タグGoogle Analytics",
"dataMappings": [
{
"variable": "変数名",
"type": "udo",
"mappings": ["a1", "a2"]
}
],
"selectedTargets": {
"qa": true,
"dev": true,
"prod": true
},
"advancedConfiguration": {
"bundleFlag": true,
"syncLoadType": false,
"optout": true,
"scriptSource": "",
"sendFlag": false,
"tagTiming": "Dom Ready"
},
"tagConfiguration": {
"tracking_id": "123"
},
"rules": {
"apply": [{"and": [{"or": [{"uid": "2", "type": "loadRule"}]}]}],
"exclude": [{"and": [{"or": [{"uid": "3", "type": "loadRule"}, {"uid": "2", "type": "loadRule"}]}]}]
}
}
}
]
}
タグの更新
このPATCHメソッドはプロファイルオブジェクトと追加のタグフィールドを取ります。
リクエストの例
{
"versionTitle": "バージョンタイトル",
"notes": "ノート",
"operationList": [
{
"op": "replace",
"path": "/tags/21",
"value": {
"object": "tag",
"tagId": "7133",
"status": "active",
"notes": "タグを追加",
"name": "APIによる名前の置換Google Analytics",
"dataMappings": [
{
"variable": "変数名",
"type": "udo",
"mappings": ["a1", "a2"]
}
],
"selectedTargets": {
"qa": true,
"dev": true,
"prod": true
},
"advancedConfiguration": {
"bundleFlag": true,
"syncLoadType": false,
"optout": true,
"scriptSource": "",
"sendFlag": false,
"tagTiming": "Dom Ready"
},
"tagConfiguration": {
"tracking_id": "123"
},
"rules": {
"apply": [{"and": [{"or": [{"uid": "2", "type": "loadRule"}]}]}],
"exclude": [{"and": [{"or": [{"uid": "3", "type": "loadRule"}, {"uid": "2", "type": "loadRule"}]}]}]
}
}
}
]
}
タグの削除
このPATCHメソッドは、プロファイルオブジェクトと追加のタグフィールドを取ります。
例のリクエスト
{
"versionTitle": "バージョン 2022.03.22.2108",
"saveType": "saveAs",
"notes":"",
"operationList": [
{
"op": "remove",
"path": "/tags/230",
"value":{
"object":"tag"
}
}
]
}
エラーメッセージ
このエンドポイントの潜在的なエラーメッセージ：
| エラーコード | エラーメッセージ |
|---|---|
| 400 | "プロファイルライブラリが古いです、パッチを適用する前に変更をマージしてください - {ACCOUNT} | プロファイル: {PROFILE}""patchProfile.arg2.notes: 空であってはなりません" |
| 404 | "プロファイルが見つかりません - アカウント: {ACCOUNT} | プロファイル: {PROFILE}""プロファイルライブラリが見つかりません - アカウント: {ACCOUNT} | プロファイル: {PROFILE}""プロファイル（レガシー）が見つかりません - アカウント: {ACCOUNT} | プロファイル: {PROFILE}""ユーザーが現在同じアカウントを表示しています: {ACCOUNT} | プロファイル: {PROFILE}""最新バージョンが見つかりません - {ACCOUNT} | プロファイル: {PROFILE}" |
| 409 | "プロファイルの保存エラー: {PROFILE} アカウント用: {ACCOUNT}, 重複バージョン: {VERSION}" |
| 500 | "プロファイル: {PROFILE} はライブラリプロファイルから継承します""プロファイルメタデータの保存エラー - アカウント: {ACCOUNT} | プロファイル: {PROFILE}""プロファイルの保存エラー - アカウント: {ACCOUNT} | プロファイル: {PROFILE}""プロファイル（レガシー）の保存エラー - {ACCOUNT} | プロファイル: {PROFILE}" |
最終更新日 :: 2024年October月16日