iQ タグ API
iQ タグ API は PATCH メソッドを使用してプロファイルのタグを更新します。
この API と利用可能なオブジェクトフィールドについて詳しくは、iQ プロファイル API と iQ プロファイルオブジェクト を参照してください。
動作方法
PATCH メソッドを使用して、iQ プロファイルオブジェクトのコンポーネントを作成、更新、削除します。
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、または tag。 |
value.tagID |
文字列 | 必須 | 一意のタグテンプレート ID。タグ ID を取得するために GET リクエストを使用します。なお、この値はタグ UID とは異なります。 |
value.status |
文字列 | オプション | オン/オフのステータス: active または inactive。 |
value.notes |
文字列 | オプション | タグに関するノート。 |
value.title |
文字列 | 必須 (add/replace) | タグの名前。 |
value.selectedTargets |
マップ <文字列, 真偽値> | オプション | コンポーネントを公開する環境のオブジェクト。{ "prod" : true|false, "qa" : true|false, "dev" : true|false } デフォルト: すべての環境が true に構成されています。 |
value.tagConfiguration |
マップ <文字列, オブジェクト> | オプション | ベンダーによって提供されるタグ固有の構成の文字列とオブジェクトのマップ。構成は各タグに固有です。詳細については、タグのドキュメントを参照してください。 |
value.advancedConfiguration |
オブジェクト | オプション | タグの構成に対応する一連の高度な構成。advConfigBundle — True または FalseadvConfigLoadType — True または FalseadvConfigOptOut — TrueadvConfigSend— True または False advConfigSrc — テキストフィールドtagTiming — DOM Ready または Prioritized |
value.rules |
オブジェクト | オプション | タグに適用するロードルールまたは除外するロードルール。 |
value.dataMappings |
マップ <文字列, 文字列> | オプション | Tealium IQ 変数とそれに対応するマッピング先。マッピング変数トリガーの具体的な形式は、タグの構成の データマッピング 画面で確認できます。 |
リクエストの例
{
"versionTitle": "Version 2022.03.22.2108",
"saveType": "saveAs",
"notes":"バージョンのノート",
"operationList": [
{
"op": "add",
"path": "/tags",
"value":{
"object":"tag",
"tagId": "7133",
"status": "active",
"notes": "",
"title": "Google Analytics (gtag.js)",
"selectedTargets": {
"qa": true,
"dev": true,
"prod": true
},
"tagConfiguration": {
"config_cross_track_domains": "",
"config_allow_display_features": "false",
"config_tracking_id": "UA-12345678-1",
"config_allow_anchor": "false",
"config_data_layer_name": "",
"config_enhanced_link_attribution": "false",
"config_use_amp_client_id": "false",
"config_optimize_id": "",
"config_screen_view": "false",
"config_cross_track": "false",
"config_transport_type": "default",
"config_gaobject": "",
"config_anonymize_ip": "false",
"config_clear_global_vars": "false"
},
"advancedConfiguration": {
"bundleFlag": false,
"syncLoadType": true,
"optout": true,
"scriptSource": "",
"sendFlag": true,
"tagTiming": "Dom Ready"
},
"rules": {
"apply": [
{"and": [{"or": [{"uid": 52, "type": "loadRule"}]}]}
],
"exclude": []
},
"dataMappings": [
{
"mappings": ["true:present_offer"],
"type": "va",
"variable": "badges.30"
},
{
"mappings": ["event.start_date"],
"type": "udo",
"variable": "dates.23"
},
{
"mappings": ["config.page_title"],
"type": "udo",
"variable": "page_name"
}
],
}
}
]
}
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": "Version 2022.03.22.2108",
"saveType": "saveAs",
"notes":"バージョンのノート",
"operationList": [
{
"op": "add",
"path": "/tags",
"value":{
"object":"tag",
"tagId": "7133",
"status": "active",
"notes": "",
"title": "Google Analytics (gtag.js)",
"selectedTargets": {
"qa": true,
"dev": true,
"prod": true
},
"tagConfiguration": {
"config_cross_track_domains": "",
"config_allow_display_features": "false",
"config_tracking_id": "UA-12345678-1",
"config_allow_anchor": "false",
"config_data_layer_name": "",
"config_enhanced_link_attribution": "false",
"config_use_amp_client_id": "false",
"config_optimize_id": "",
"config_screen_view": "false",
"config_cross_track": "false",
"config_transport_type": "default",
"config_gaobject": "",
"config_anonymize_ip": "false",
"config_clear_global_vars": "false"
},
"advancedConfiguration": {
"bundleFlag": false,
"syncLoadType": true,
"optout": true,
"scriptSource": "",
"sendFlag": true,
"tagTiming": "Dom Ready"
},
"rules": {
"apply": [
{"and": [{"or": [{"uid": 52, "type": "loadRule"}]}]}
],
"exclude": []
},
"dataMappings": [
{
"variable": "page_name",
"type": "udo",
"mappings": ["config.page_title"]
}
],
}
}
]
}
タグの更新
この PATCH メソッドは、プロファイルオブジェクトと追加のタグフィールドを受け取ります。
リクエストの例
{
"versionTitle": "Version 2022.03.22.2108",
"saveType": "saveAs",
"notes":"バージョンのノート",
"operationList": [
{
"op": "replace",
"path": "/tags/49",
"value":{
"object":"tag",
"tagId": "7133",
"status": "active",
"notes": "",
"title": "Google Analytics (gtag.js)",
"selectedTargets": {
"qa": true,
"dev": true,
"prod": true
},
"tagConfiguration": {
"config_cross_track_domains": "",
"config_allow_display_features": "false",
"config_tracking_id": "UA-12345678-1",
"config_allow_anchor": "false",
"config_data_layer_name": "",
"config_enhanced_link_attribution": "false",
"config_use_amp_client_id": "false",
"config_optimize_id": "",
"config_screen_view": "false",
"config_cross_track": "false",
"config_transport_type": "default",
"config_gaobject": "",
"config_anonymize_ip": "false",
"config_clear_global_vars": "false"
},
"advancedConfiguration": {
"bundleFlag": false,
"syncLoadType": true,
"optout": true,
"scriptSource": "",
"sendFlag": true,
"tagTiming": "Dom Ready"
},
"rules": {
"apply": [
{"and": [{"or": [{"uid": 52, "type": "loadRule"}]}]}
],
"exclude": []
},
"dataMappings": [
{
"variable": "page_name",
"type": "udo",
"mappings": ["config.page_title"]
}
],
}
}
]
}
タグの削除
この PATCH メソッドは、プロファイルオブジェクトと追加のタグフィールドを受け取ります。
リクエストの例
{
"versionTitle": "Version 2022.03.22.2108",
"saveType": "saveAs",
"notes":"",
"operationList": [
{
"op": "remove",
"path": "/tags/230",
"value":{
"object":"tag"
}
}
]
}
エラーメッセージ
このエンドポイントの潜在的なエラーメッセージ:
| エラーコード | エラーメッセージ |
|---|---|
| 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}""Users are currently viewing the same account: {ACCOUNT} | profile: {PROFILE}""Latest version not found - {ACCOUNT} | profile: {PROFILE}" |
| 409 | "Error saving profile: {PROFILE} for account: {ACCOUNT}, duplicate versions: {VERSION}" |
| 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}" |
最終更新日 :: 2024年March月29日