iQ変数API | iQプロファイル | Tealiumドキュメント

この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`	String	Optional	保存されたバージョンのタイトル。 `saveType`が`saveAs`に構成されている場合のデフォルト：`API \| {TIMESTAMP}` `saveType`が`save`に構成されている場合のデフォルト：既存のバージョンタイトル
`saveType`	String	Optional	PATCHリクエストで実行する保存のタイプ：`save`または`saveAs`。デフォルトは`saveAs`。
`notes`	String	Required	パブリッシュバージョンに関する追加のノート。
`operationList`	Array	Required	操作オブジェクトのリスト。例えば、複数の変数。
`op`	String	Required	実行する操作：`add`、`replace`、または`remove`。
`path`	String	Required	更新するコンポーネントタイプとID、形式：`/variables`。
`value.object`	String	Required	更新されるオブジェクトタイプ：`variable`または`extension`。
`value.name`	String	Required (for add/replace)	変数のタイトル。
`value.alias`	String	Required	変数の名前。
`value.type`	String	Required	変数タイプを表すプレフィックス。 `ls` - ローカル保存 `ss` - セッション保存 `udo` - ユニバーサルデータオブジェクト `qp` - クエリストリングパラメータ `cp` - クッキー `js` - JavaScript 変数 `meta` - メタデータ要素 `va` - AudienceStream属性（読み取り専用。このタイプは他のiQプロファイルAPI要素で使用できますが、APIを使用して作成することはできません。）
`value.notes`	String	Optional	変数に関するノート。

リクエストの例

{
  "versionTitle":"Version 2022.03.22.2108",
  "saveType": "saveAs",
  "notes": "version notes here",
  "operationList":[
    {
      "op":"add",
      "path":"/variables",
      "value":{
        "object": "variable",
        "name": "viewport_height",
        "alias": "Viewport Height",
        "type": "dom",
        "notes":"dom variable"
      }
    }
  ]
}

PATCH操作パラメータ

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

opパラメータは以下の値をサポートします：

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

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

例えば、変数を追加するには：

"op" : "add",
"path" : "/variables"

特定の変数を更新するには、IDをパスに追加します：

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

変数の作成

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

リクエストの例

{
  "versionTitle":"Version 2022.03.22.2108",
  "saveType": "saveAs",
  "notes": "version notes here",
  "operationList":[
    {
      "op":"add",
      "path":"/variables",
      "value":{
        "object": "variable",
        "name": "viewport_height",
        "alias": "Viewport Height",
        "type": "dom",
        "notes":"dom variable"
      }
    }
  ]
}

変数の更新

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

リクエストの例

{
  "versionTitle":"Version 2022.03.22.2108",
  "saveType": "saveAs",
  "notes": "version notes here",
  "operationList":[
    {
      "op":"replace",
      "path":"/variables/503",
      "value":{
        "object": "variable",
        "name": "viewport_height",
        "alias": "Viewport Height",
        "type": "dom",
        "notes":"dom variable"
      }
    }
  ]
}

変数の削除

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

リクエストの例

{
  "versionTitle":"Version 2022.03.22.2108",
  "saveType": "saveAs",
  "notes": "version notes here",
  "operationList":[
    {
      "op":"remove",
      "path":"/variables/503",
      "value":{
        "object": "variable"
      }
    }
  ]
}

エラーメッセージ

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

エラーコード	エラーメッセージ
400	`"プロファイルライブラリが古いため、プロファイルをパッチする前に変更をマージしてください - {ACCOUNT} \| profile: {PROFILE}"` `"変数の検証に失敗しました - variableId: {VARIABLE_ID} \| {ACCOUNT} \| profile: {PROFILE}. 原因: {CAUSE}"` `"patchProfile.arg2.notes: must not be empty"`
404	`"プロファイルが見つかりません - account: {ACCOUNT} \| profile: {PROFILE}"` `"プロファイルライブラリが見つかりません - account: {ACCOUNT} \| profile: {PROFILE}"` `"プロファイル（レガシー）が見つかりません - account: {ACCOUNT} \| profile: {PROFILE}"` `"ユーザーが現在同じアカウントを表示しています: {ACCOUNT} \| profile: {PROFILE}"` `"最新バージョンが見つかりません - {ACCOUNT} \| profile: {PROFILE}"`
409	`"プロファイルの保存にエラーが発生しました: {PROFILE} for account: {ACCOUNT}, duplicate versions: {VERSION}"`
500	`"Profile: {PROFILE} inherits from library profile"` `"プロファイルメタデータの保存エラー - account: {ACCOUNT} \| profile: {PROFILE}"` `"プロファイルの保存エラー - account: {ACCOUNT} \| profile: {PROFILE}"` `"プロファイル（レガシー）の保存エラー - {ACCOUNT} \| profile: {PROFILE}"`