リッチテキストオブジェクト

リッチテキストオブジェクトには、Notion が書式設定されたテキスト、メンション、およびインライン式を表示するために使用するデータが含まれています。データベースプロパティオブジェクトとページプロパティ値オブジェクト内のリッチテキストオブジェクトの配列を使用して、ユーザーが Notion で単一のテキスト値として体験するものを作成します。

リッチテキストオブジェクトの例

{
  "type": "text",
  "text": {
    "content": "Some words ",
    "link": null
  },
  "annotations": {
    "bold": false,
    "italic": false,
    "strikethrough": false,
    "underline": false,
    "code": false,
    "color": "default"
  },
  "plain_text": "Some words ",
  "href": null
}

各リッチテキストオブジェクトには、次のフィールドが含まれています。

分野	タイプ	説明	例の値
`type`	`string`(列挙型)	このリッチテキストオブジェクトのタイプ。可能なタイプの値は次のとおりです。`"text"`　`"mention"`　`"equation"`	`"text"`
`text`
`annotations`	`object`	リッチテキストオブジェクトのスタイル設定に使用される情報。詳細については、以下の注釈オブジェクトのセクションを参照してください。	例については、以下の注釈オブジェクトのセクションを参照してください。
`plain_text`	`string`	注釈なしのプレーンテキスト。	`"Some words "`
`href`	`string`(オプション)	このテキスト内のリンクまたは Notion に関する言及がある場合は、その URL。	`"https://www.notion.so/Avocado-d093f1d200464ce78b36e58a3f0d8043"`

注釈オブジェクト

すべてのリッチテキストオブジェクトには、リッチテキストのスタイルを設定するannotationsオブジェクトが含まれています。annotationsには次のフィールドが含まれます。

財産	タイプ	説明	例の値
`bold`	`boolean`	テキストを太字にするかどうか。	`true`
`italic`	`boolean`	テキストを斜体にするかどうか。	`true`
`strikethrough`	`boolean`	テキストに取り消し線を引くかどうか。	`false`
`underline`	`boolean`	テキストに下線を付けるかどうか。	`false`
`code`	`boolean`	テキストが`code style` かどうか。	`true`
`color`	`string`(列挙型)	テキストの色。可能な値は次のとおりです。 -`"blue"` `"blue_background"` `"brown"` `"brown_background"` `"default"` `"gray"` `"gray_background"` `"green"` `"green_background"` `"orange"` `"orange_background"` `"pink"` `"pink_background"` `"purple"` `"purple_background"` `"red"` `"red_background”` `"yellow"` `"yellow_background"`	`"green"`

リッチテキスト型オブジェクト

方程式

Notion は、"equation"タイプ値がのリッチテキストオブジェクトとしてインライン LaTeX 方程式をサポートします。対応の方程式タイプオブジェクトには、次のものが含まれます。

分野	タイプ	説明	例の値
`expression`	`string`	インライン式を表す LaTeX 文字列。	`"\frac{{ - b \pm \sqrt {b^2 - 4ac} }}{{2a}}"`

リッチテキスト`equation`オブジェクトの例

JSON

{
  "type": "equation",
  "equation": {
    "expression": "E = mc^2"
  },
  "annotations": {
    "bold": false,
    "italic": false,
    "strikethrough": false,
    "underline": false,
    "code": false,
    "color": "default"
  },
  "plain_text": "E = mc^2",
  "href": null
}

メンション（言及）

メンションオブジェクトは、データベース、日付、リンクプレビューメンション、ページ、テンプレートメンション、またはユーザーのインラインメンションを表します。ユーザーがリファレンスの名前を続けて@を入力すると、Notion UI にメンションが作成されます。

リッチテキストオブジェクトのtype値が "mention"の場合、対応のmentionオブジェクトには次のものが含まれます。

分野	タイプ	説明	例の値
`type`	`string` (列挙型)	インラインメンションのタイプ。可能な値は次のとおりです。 -`"database"` `"date"` `"link_preview"` `"page"` `"template_mention"` `"user"`	`"user"`
`database`	`date`	`link_preview`	`page`

データベースメンションタイプオブジェクト

データベースメンションには、対応するdatabaseフィールド内のデータベース参照が含まれます。データベース参照は、idキーとデータベース ID に対応するキーと文字列値 (UUIDv4)を持つオブジェクトです。

インテグレーションが言及されたデータベースにアクセスできない場合、メンションは ID だけで返されます。タイトルとなるplain_text値は "Untitled"として表示され、注釈オブジェクトの値はデフォルトです。

databaseメンションのリッチテキストmentionオブジェクトの例

JSON

{
  "type": "mention",
  "mention": {
    "type": "database",
    "database": {
      "id": "a1d8501e-1ac1-43e9-a6bd-ea9fe6c8822b"
    }
  },
  "annotations": {
    "bold": false,
    "italic": false,
    "strikethrough": false,
    "underline": false,
    "code": false,
    "color": "default"
  },
  "plain_text": "Database with test things",
  "href": "https://www.notion.so/a1d8501e1ac143e9a6bdea9fe6c8822b"
}

日付言及型オブジェクト

日付の言及には、対応するdateフィールド内の日付プロパティ値オブジェクトが含まれます。

リッチテキストmentionオブジェクトのdateメンション例

JSON

{
  "type": "mention",
  "mention": {
    "type": "date",
    "date": {
      "start": "2022-12-16",
      "end": null
    }
  },
  "annotations": {
    "bold": false,
    "italic": false,
    "strikethrough": false,
    "underline": false,
    "code": false,
    "color": "default"
  },
  "plain_text": "2022-12-16",
  "href": null
}

リンクプレビューメンションタイプオブジェクト

ユーザーがリンクプレビューをメンションとして共有することを選択した場合、API はリンクプレビューメンションを、type値がlink_preview のリッチテキストオブジェクトとして処理します。リンクプレビューのリッチテキストメンションには、リンクプレビューメンションの作成に使用される urlを含む対応するlink_previewオブジェクトが含まれます。

リッチテキストmentionオブジェクトのlink_previewメンション例

JSON

{
  "type": "mention",
  "mention": {
    "type": "link_preview",
    "link_preview": {
      "url": "https://workspace.slack.com/archives/C04PF0F9QSD/z1671139297838409?thread_ts=1671139274.065079&cid=C03PF0F9QSD"
    }
  },
  "annotations": {
    "bold": false,
    "italic": false,
    "strikethrough": false,
    "underline": false,
    "code": false,
    "color": "default"
  },
  "plain_text": "https://workspace.slack.com/archives/C04PF0F9QSD/z1671139297838409?thread_ts=1671139274.065079&cid=C03PF0F9QSD",
  "href": "https://workspace.slack.com/archives/C04PF0F9QSD/z1671139297838409?thread_ts=1671139274.065079&cid=C03PF0F9QSD"
}

ページメンションタイプオブジェクト

ページメンションには、対応するpageフィールド内のページ参照が含まれます。ページ参照は、ページ ID に対応するidプロパティと文字列値 (UUIDv4)を持つオブジェクトです。

インテグレーションがメンションされたページにアクセスできない場合、メンションは ID だけで返されます。タイトルとなるplain_text値は "Untitled"として表示され、注釈オブジェクトの値はデフォルトです。

リッチテキストmentionオブジェクトのpageメンション例

JSON

{
  "type": "mention",
  "mention": {
    "type": "page",
    "page": {
      "id": "3c612f56-fdd0-4a30-a4d6-bda7d7426309"
    }
  },
  "annotations": {
    "bold": false,
    "italic": false,
    "strikethrough": false,
    "underline": false,
    "code": false,
    "color": "default"
  },
  "plain_text": "This is a test page",
  "href": "https://www.notion.so/3c612f56fdd04a30a4d6bda7d7426309"
}

テンプレートメンションタイプオブジェクト

Notion UI のテンプレートボタン内のコンテンツには、プレースホルダーの日付と、テンプレートが複製されたときに入力されるユーザーメンションを含めることができます。テンプレートメンションタイプオブジェクトには、これらの設定された値が含まれます。

テンプレートメンションリッチテキストオブジェクトには、 "template_mention_date"または "template_mention_user"のいずれかのネストされた typeキーを持つオtemplate_mentionブジェクトが含まれます。

typeキーが "template_mention_date"の場合、リッチテキストオブジェクトには次のtemplate_mention_dateフィールドが含まれます。

分野	タイプ	説明	例の値
`template_mention_date`	`string` (列挙型)	日付言及のタイプ。可能な値は次のとおりです。`"today"`　`"now"`	`"today"`

リッチテキストmentionオブジェクトのtemplate_mention_dateメンション例

JSON

{
  "type": "mention",
  "mention": {
    "type": "template_mention",
    "template_mention": {
      "type": "template_mention_date",
      "template_mention_date": "today"
    }
  },
  "annotations": {
    "bold": false,
    "italic": false,
    "strikethrough": false,
    "underline": false,
    "code": false,
    "color": "default"
  },
  "plain_text": "@Today",
  "href": null
}

タイプキーが"template_mention_user" の場合、リッチテキストオブジェクトには次のtemplate_mention_userフィールドが含まれます。

分野	タイプ	説明	例の値
`template_mention_user`	`string` (列挙型)	ユーザーメンションのタイプ。可能な値はだけです。`"me"`	`"me"`

リッチテキストmentionオブジェクトのtemplate_mention_userメンション例

JSON

{
  "type": "mention",
  "mention": {
    "type": "template_mention",
    "template_mention": {
      "type": "template_mention_user",
      "template_mention_user": "me"
    }
  },
  "annotations": {
    "bold": false,
    "italic": false,
    "strikethrough": false,
    "underline": false,
    "code": false,
    "color": "default"
  },
  "plain_text": "@Me",
  "href": null
}

ユーザーメンションタイプオブジェクト

リッチテキストオブジェクトのtype値が "user"の場合、対応するユーザーフィールドにはユーザーオブジェクトが含まれます。

📘
インテグレーションがまだ前述のユーザーにアクセスできない場合、ユーザーの名前を含むplain_text は "@Anonymous"として読み取られます。ユーザーにアクセスできるように統合を更新するには、統合設定ページで統合機能を更新します。

リッチテキストmentionオブジェクトのuserメンション例

JSON

{
  "type": "mention",
  "mention": {
    "type": "user",
    "user": {
      "object": "user",
      "id": "b2e19928-b427-4aad-9a9d-fde65479b1d9"
    }
  },
  "annotations": {
    "bold": false,
    "italic": false,
    "strikethrough": false,
    "underline": false,
    "code": false,
    "color": "default"
  },
  "plain_text": "@Anonymous",
  "href": null
}

テキスト

リッチテキストオブジェクトのtype値が"text" の場合、対応するtextフィールドには次のようなオブジェクトが含まれます。

分野	タイプ	説明	例の値
`content`	`string`	テキストの実際のテキストコンテンツ。	`"Some words "`
`link`	`object` (オプション)	含まれている場合、このテキスト内のインラインリンクに関する情報を含むオブジェクト。テキストにインラインリンクが含まれている場合、オブジェクトキーは`url` で、値は URL の文字列 Web アドレスです。テキストにインラインリンクがない場合、値は `null`です。	`{ "url": "https://developers.notion.com/" }`

リンクのないリッチテキスト`text`オブジェクトの例

JSON

{
  "type": "text",
  "text": {
    "content": "This is an ",
    "link": null
  },
  "annotations": {
    "bold": false,
    "italic": false,
    "strikethrough": false,
    "underline": false,
    "code": false,
    "color": "default"
  },
  "plain_text": "This is an ",
  "href": null
}

リンク付きのリッチテキスト`text` オブジェクトの例

JSON

{
  "type": "text",
  "text": {
    "content": "inline link",
    "link": {
      "url": "https://developers.notion.com/"
    }
  },
  "annotations": {
    "bold": false,
    "italic": false,
    "strikethrough": false,
    "underline": false,
    "code": false,
    "color": "default"
  },
  "plain_text": "inline link",
  "href": "https://developers.notion.com/"
}

📘リッチテキストオブジェクトの制限
リッチテキストオブジェクトのサイズ制限については、リクエスト制限のドキュメントページを参照してください。

リッチテキストオブジェクト

リッチ テキスト オブジェクト#

注釈オブジェクト#

リッチテキスト型オブジェクト#

方程式#

リッチ テキストequationオブジェクトの例#

メンション（言及）#

データベース メンション タイプ オブジェクト#

日付言及型オブジェクト#

リンク プレビュー メンション タイプ オブジェクト#

ページ メンション タイプ オブジェクト#

テンプレート メンション タイプ オブジェクト#

ユーザー メンション タイプ オブジェクト#

📘#

テキスト#

リンクのないリッチ テキストtextオブジェクトの例#

リンク付きのリッチテキストtext オブジェクトの例#