開発ガイドコンテンツの書き込み
Markdown 形式のコンテンツを DingTalk ドキュメントに書き込む方法
-
方法 1：コンテンツの挿入（追加、既存のコンテンツに影響なし）
コンテンツの挿入 インターフェイスを呼び出し、Markdown コンテンツをドキュメントの指定位置に挿入します。
-
方法 2：ドキュメントの上書き（クリア後に再書き込み）
ドキュメントの上書き（アプリ認可） インターフェイスを呼び出し、Markdown 形式でドキュメントの全コンテンツを上書きします。
ドキュメントの上書きは、ドキュメントの既存の全コンテンツをクリアする破壊的な操作です。慎重に使用してください。コンテンツを追加するだけの場合は、コンテンツ挿入インターフェイスを使用してください。
ブロック要素の操作
コンテンツ付き段落の挿入方法
ブロック要素の挿入 インターフェイスを呼び出し、ドキュメントに段落ブロックを挿入し、children フィールドで段落内のインライン要素を指定します。
paragraph オブジェクトは省略できません。段落に特殊な属性がない場合でも、空のオブジェクト {} を渡す必要があります。
ドキュメントの指定位置（末尾ではない場所）にブロック要素を挿入する方法
ブロック要素の挿入 インターフェイスを呼び出す際に、blockId または index でターゲット位置を指定し、where パラメータでターゲット位置の前後どちらに挿入するかを制御します。
見出しの挿入方法
ブロック要素の挿入 インターフェイスを呼び出し、blockType を heading に設定し、heading オブジェクト内で level により見出しレベル（1〜6）を指定します。
heading.level と見出しレベルの対応関係：
参照ブロックの挿入方法
ブロック要素の挿入 インターフェイスを呼び出し、blockType を blockquote に設定し、blockquote オブジェクト内に参照コンテンツを渡します。
ハイライトブロックを挿入し、その中に段落をネストする方法
ハイライトブロックのchildren は BlockElement 配列のみとなります。ブロック要素の挿入 インターフェイスを呼び出す際、children 内に子段落を渡します。
children のタイプが異なります。段落ブロックの children はインライン要素のみ、ハイライトブロックの children はブロック要素のみとなります。
カラム分割の挿入方法
ブロック要素の挿入 インターフェイスを呼び出し、blockType を columns に設定し、columns.size でカラム数を指定し、children 内に各カラムのブロック要素コンテンツを渡します。
columns オブジェクトのフィールド説明：
columns の children は BlockElement 配列のみで、インライン要素は使用できません。
番号付きリストの挿入方法
ブロック要素の挿入 インターフェイスを呼び出し、blockType を orderedList に設定し、orderedList オブジェクト内にリスト属性を渡し、children 内にリスト項目のテキストを渡します。
list オブジェクトの主なフィールド説明：
箇条書きの挿入方法
ブロック要素の挿入 インターフェイスを呼び出し、blockType を unorderedList に設定し、unorderedList オブジェクト内にリスト属性を渡し、children 内にリスト項目のテキストを渡します。
listId は、複数のリスト項目を同一のリストとして関連付けるために使用します。同一リストの複数のリスト項目を挿入する場合、各リスト項目に同じ listId を使用し、BatchOperate バッチインターフェイスで一括挿入できます。
クエリ操作
ドキュメント内のすべてのブロック要素の blockId を取得する方法
ブロック要素のクエリ インターフェイスを呼び出し、ドキュメントのルートノード配下の一次ブロック要素リストを取得します。各要素にはid（つまり blockId）が含まれています。