IBM® API Connect Enterprise as a Service

トークンの解説

「E メール・サブスクライバー」ウィザードを使用して、E メールの件名と本文でコンテキスト特有のトークンを指定できます。使用可能なトークンと置換値は、選択されたフロー (例えば、API、プラン、製品、またはすべて) によって異なります。

アプリケーション・トークン

個々のアプリケーションに関連したトークン。

名前	トークン	説明	製品のサブスクライバー	プランのサブスクライバー	API のサブスクライバー	すべてのユーザー
説明	`[application:description]`	アプリケーションに指定される説明。
有効	`[application:enabled]`	アプリケーションの状態。
ID	`[application:id]`	アプリケーションの ID。
イメージの URL	`[application:image_url]`	アプリケーションのイメージの URL。
ライフサイクル状態	`[application:lifecycle_state]`	アプリケーションのライフサイクル状態。
名前	`[application:name]`	アプリケーションの名前。
役職	`[application:title]`	アプリケーションのタイトル。

コンシューマー組織トークン

個々のコンシューマー組織に関連したトークン。

名前	トークン	説明	製品のサブスクライバー	プランのサブスクライバー	API のサブスクライバー	すべてのユーザー
ID	`[consumer-org:id]`	コンシューマー組織の ID。
名前	`[consumer-org:name]`	コンシューマー組織の名前。
役職	`[consumer-org:title]`	コンシューマー組織のタイトル。

製品トークン

個々の製品に関連したトークン。

名前	トークン	説明	製品のサブスクライバー	プランのサブスクライバー	API のサブスクライバー	すべてのユーザー
API	`[product:apis]`	製品内の API (name:version) のコンマ区切りリスト。
ID	`[product:id]`	製品の ID。
イメージの URL	`[product:image_url]`	製品のイメージの URL。
名前	`[product:name]`	製品の名前。
プラン	`[product:plans]`	製品内のプラン名のコンマ区切りリスト。
状態	`[product:state]`	製品の状態。
役職	`[product:title]`	製品のタイトル。

プラン・トークン

個々の製品プランに関連したトークン。

名前	トークン	説明	製品のサブスクライバー	プランのサブスクライバー	API のサブスクライバー	すべてのユーザー
承認が必要です	`[product-plan:approval]`	プランに承認が必要かどうか。
説明	`[product-plan:description]`	プランの説明。
名前	`[product-plan:name]`	製品内の所定のプランの名前。
速度制限	`[product-plan:rate-limits]`	プランに含まれるレート制限の名前と値のペアのコンマ区切りリスト。
役職	`[product-plan:title]`	プランのタイトル。

API トークン

個々の API に関連したトークン。

名前	トークン	説明	製品のサブスクライバー	プランのサブスクライバー	API のサブスクライバー	すべてのユーザー
ID	`[api:id]`	API の ID。
イメージの URL	`[api:image_url]`	API のイメージの URL。
名前	`[api:name]`	API の名前。
OAI バージョン	`[api:oai_version]`	API の OAI バージョン。
プロトコル	`[api:protocol]`	API のプロトコル。
状態	`[api:state]`	API の現在の状態。
役職	`[api:title]`	API のタイトル。
バージョン	`[api:version]`	API のバージョン。

ユーザー・トークン

受信者の個々のユーザー・アカウントに関連したトークン。

名前	トークン	説明	製品のサブスクライバー	プランのサブスクライバー	API のサブスクライバー	すべてのユーザー
アカウント名	`[user:account-name]`	ユーザー・アカウントのログイン名。
作成日	`[user:created]`	ユーザー・アカウントが作成された日付。			>
表示名	`[user:display-name]`	ユーザー・アカウントの表示名。
E メール	`[user:mail]`	ユーザー・アカウントの E メール・アドレス。
様	`[user:first_name]`	ユーザーの名。
姓	`[user:last_name]`	ユーザーの姓。
ロール	`[user:roles]`	ユーザー・アカウントに関連付けられているユーザー・ロール。
状態	`[user:apic_state]`	リスト (テキスト) フィールド。
ユーザー ID	`[user:uid]`	ユーザー・アカウントの固有 ID。

現在のユーザー・トークン

E メールの送信を開始する現在のユーザーに関連したトークン。

名前	トークン	説明	製品のサブスクライバー	プランのサブスクライバー	API のサブスクライバー	すべてのユーザー
アカウント名	`[current-user:account-name]`	ユーザー・アカウントのログイン名。
表示名	`[current-user:display-name]`	ユーザー・アカウントの表示名。
E メール	`[current-user:mail]`	ユーザー・アカウントの E メール・アドレス。

サイト情報トークン

サイト全体の設定やその他のグローバル構成に関連したトークン。

名前	トークン	説明	製品のサブスクライバー	プランのサブスクライバー	API のサブスクライバー	すべてのユーザー
E メール	`[site:mail]`	サイトの管理 E メール・アドレス。
ログイン・ページ	`[site:login-url]`	サイトのログイン・ページの URL。
名前	`[site:name]`	サイトの名前。
スローガン	`[site:slogan]`	サイトのスローガン。
URL	`[site:url]`	サイトのフロントページの URL。
URL (短縮)	`[site:url-brief]`	サイトのフロントページの URL (プロトコルなし)。

現在日付トークン

現在の日時に関連したトークン。

名前	トークン	説明	製品のサブスクライバー	プランのサブスクライバー	API のサブスクライバー	すべてのユーザー
カスタム・フォーマット	`[current-date:custom:?]`	カスタム形式の日付。詳細については、PHP 資料を参照してください。
フォールバック日付形式	`[current-date:fallback]`	「フォールバック」形式の日付。 (Fri, 01/08/2021 - 14:19)
HTML 日付	`[current-date:html_date]`	「html_date」形式の日付。 (2021-01-08)
HTML 日時	`[current-date:html_datetime]`	「html_datetime」形式の日付。 (2021-01-08T14:19:19+0000)
HTML 月	`[current-date:html_month]`	「html_month」形式の日付。 (2021-01)
HTML 時間	`[current-date:html_time]`	「html_time」形式の日付。 (14:19:19)
HTML 週	`[current-date:html_week]`	「html_week」形式の日付。 (2021-W01)
HTML 年	`[current-date:html_year]`	「html_year」形式の日付。 (2021)
HTML 年なし日付	`[current-date:html_yearless_date]`	「html_yearless_date」形式の日付。 (01-08)
長形式	`[current-date:long]`	「long」形式の日付。 (Friday, January 8, 2021 - 14:19)
中形式	`[current-date:medium]`	「medium」形式の日付。 (Fri, 01/08/2021 - 14:19)
未加工のタイム・スタンプ	`[current-date:raw]`	UNIX タイム・スタンプ形式の日付 (1610115559)
短形式	`[current-date:short]`	「short」形式の日付。 (01/08/2021 - 14:19)
経過時間	`[current-date:since]`	「time-since」形式の日付。 (6 分)