googleドキュメントの見出し(headling) のURL情報を、GASで取得したい

Question

いろいろと調べてみたのですが、わからず、
初めて質問させていただきます。

googleドキュメントの見出し（headling) のURL情報を、GUIでは取得できるのですが、
GASで取得したいと考えています。
GUIの場合は、「概要」から見出しをクリックすることで、URLアドレスバーに表示されるので、
ここから、見出しリンク情報が分かります。
ドキュメント上で、GASでは、取得できないでしょうか？

https://docs.google.com/document/d/xxxxx/edit#heading=h.acqt6ykkwofa
URLのうち、以下の情報の取得の取り方がわからずおります。
h.acqt6ykkwofa

よろしくお願いします。

Answer 1

前提として、たとえば下記のような操作を行って見出しを設定しているとします。

---

①　Googleドキュメントで、文中の見出しにしたい各タイトル文字列をドラッグで選択して、
メニューから「表示形式」→「段落スタイル」→「見出し１」→「『見出し１』を適用」をクリック
※見出しのサイズはここでは説明のため「１」にしていますが、後述の見出しリンクが作れればどれでもよいです。

②　次に、文書の先頭にカーソルを移動し、メニューの「挿入」→「目次」→「青いリンクあり」のアイコンをクリック

　
③ 上記の操作により、下の図のような状態になるはずです。

これによって文書の先頭にテーブルコンテンツが挿入され、その中に見出しのリンクが入っている、という文書構造になります。

この文書構造に対して、見出しのテキストとリンクURLの一部（heading=～～以降）を抽出するコードは、下記になります。

// コンテナバインドスクリプトと仮定。
function myFunction() {
  const doc = DocumentApp.getActiveDocument();

  for (let i = 0; i < doc.getNumChildren(); i++) {
    const p = doc.getChild(i);
    if (p.getType() == DocumentApp.ElementType.TABLE_OF_CONTENTS) {
      const toc = p.asTableOfContents();
      for (let ti = 0; ti < toc.getNumChildren(); ti++) {
        const itemToc = toc.getChild(ti).asParagraph().getChild(0).asText();
        const itemText = itemToc.getText();
        const itemUrl = itemToc.getLinkUrl();
        // テキストとURLをconsoleに表示
        console.log(itemText);
        console.log(itemUrl);
      }
      break;
    }
  }
}

※前提を細かく定義したのは、以下の理由です。

• リンクの作り方は複数あるため、もしかしたら質問者さんは別のやり方で作っているかもしれない、という可能性がある。
• Googleドキュメントは文書構造が複雑になれば要素を辿っていくのに手間がかかる。仮に上記①～③のような単純な構造でない場合、上記のコードがうまくいかない可能性がある。

もし上記コードがうまく行かない場合は、現状のドキュメントのスクリーンショットや、見出しの作り方について説明していただけると、解決しやすいかもしれません。

---

この回答にあたっては、下記リンクを参考にしました：
https://stackoverflow.com/a/12244248

Comments

[me_me_3]

非常に丁寧なご回答ありがとうございます。

前提としては、以下を想定していました。
　ー目次は挿入しない
　ー文章構造は、いただいたようなシンプルな構造

いただいた方法だと、ドキュメントに一旦、目次挿入を実施する必要がありですね。
目次入れるとハイパーリンクが生成されるので、
.getLinkUrl()
で取得できるのは、理解しました。

ちなみに、追加質問になってしまいますが、
「目次ーリンク有り」の挿入は、GASでも可能でしょうか？

[退会済みユーザー]

見出しがリンク状態になっていなくとも、概要欄に見出しの一覧が表示され、クリックするとアドレス欄にリンクが表示されますが、このように文書内でリンクになっていない場合、概要欄CLICK時に表示されるリンクをGASで取得する手段は現状存在しません。

また、「目次ーリンク有り」の挿入をGASで行うことは現状できません。

Google document においてスクリプトで作成できるのは下記のページのうち太字のオブジェクトに限られます。
https://developers.google.com/apps-script/guides/docs#structure_of_a_document

目次に該当する Table of contents は、太字になっておらず、作成するメソッドがどこにもありません。

（マクロを使っても記録できません）

[me_me_3]

ありがとうございました！