このページは Cloud Translation API によって翻訳されました。

テキストをドキュメントに結合する

Google Docs API の便利な用途の 1 つは、複数のデータソースの情報を 1 つのドキュメントに統合することです。

このページでは、外部ソースからデータを取得して、既存のテンプレートドキュメントに挿入する方法について説明します。

テンプレートは、テンプレートから作成されるすべてのドキュメントに同じ固定テキストが含まれる特別なタイプのドキュメントです。また、他の動的テキストを配置できる指定されたプレースホルダも含まれます。たとえば、契約書テンプレートには固定のコンテンツと、受取人の氏名、住所などの詳細を入力する場所が含まれている場合があります。アプリは、顧客固有のデータをテンプレートに統合して、完成したドキュメントを作成できます。

このアプローチが有用である理由はいくつかあります。

デザイナーは Google ドキュメントエディタを使用して、ドキュメントのデザインを簡単に微調整できます。これは、アプリ内のパラメータを調整してレンダリングされるレイアウトを設定するよりもはるかに簡単です。
コンテンツをプレゼンテーションから分離するというのは有名なデザインの原則で、多くのメリットがある。

統合のイメージ図。

基本的なレシピ

Docs API を使用してデータをドキュメントに統合する方法の例を次に示します。

プレースホルダコンテンツを使用してドキュメントを作成すると、デザインとフォーマットを簡単に行えます。置き換え対象のテキストの書式設定は保持されます。
挿入する要素ごとに、プレースホルダコンテンツをタグに置き換えます。普段使われない文字列を使用します。たとえば、{{account-holder-name}} などのタグを使うといいでしょう。
コード内で Google Drive API を使用してドキュメントのコピーを作成する。
コードで、ドキュメント名を指定して Docs API の batchUpdate() メソッドを使用し、ReplaceAllTextRequest を含めます。

ドキュメント ID はドキュメントを参照し、URL から取得できます。

https://docs.google.com/document/d/documentId/edit

例

次の例では、テンプレートのすべてのタブにある 2 つのフィールドを実際の値に置き換えて、完成したドキュメントを生成します。

この結合を行うには、次のコードを使用します。

Java

String customerName = "Alice";
DateTimeFormatter formatter = DateTimeFormatter.ofPattern("yyyy/MM/dd");
String date = formatter.format(LocalDate.now());

List<Request> requests = new ArrayList<>();
// One option for replacing all text is to specify all tab IDs.
requests.add(new Request()
        .setReplaceAllText(new ReplaceAllTextRequest()
                .setContainsText(new SubstringMatchCriteria()
                        .setText("{{customer-name}}")
                        .setMatchCase(true))
                .setReplaceText(customerName)
                .setTabsCriteria(new TabsCriteria()
                        .addTabIds(TAB_ID_1)
                        .addTabIds(TAB_ID_2)
                        .addTabIds(TAB_ID_3))));
// Another option is to omit TabsCriteria if you are replacing across all tabs.
requests.add(new Request()
        .setReplaceAllText(new ReplaceAllTextRequest()
                .setContainsText(new SubstringMatchCriteria()
                        .setText("{{date}}")
                        .setMatchCase(true))
                .setReplaceText(date)));

BatchUpdateDocumentRequest body = new BatchUpdateDocumentRequest();
service.documents().batchUpdate(documentId, body.setRequests(requests)).execute();

Node.js

  let customerName = 'Alice';
  let date = yyyymmdd()
  let requests = [
    // One option for replacing all text is to specify all tab IDs.
    {
      replaceAllText: {
        containsText: {
          text: '{{customer-name}}',
          matchCase: true,
        },
        replaceText: customerName,
        tabsCriteria: {
          tabIds: [TAB_ID_1, TAB_ID_2, TAB_ID_3],
        },
      },
    },
    // Another option is to omit TabsCriteria if you are replacing across all tabs.
    {
      replaceAllText: {
        containsText: {
          text: '{{date}}',
          matchCase: true,
        },
        replaceText: date,
      },
    },
  ];

  google.options({auth: auth});
  google
      .discoverAPI(
          'https://docs.googleapis.com/$discovery/rest?version=v1&key={YOUR_API_KEY}')
      .then(function(docs) {
        docs.documents.batchUpdate(
            {
              documentId: '1yBx6HSnu_gbV2sk1nChJOFo_g3AizBhr-PpkyKAwcTg',
              resource: {
                requests,
              },
            },
            (err, {data}) => {
              if (err) return console.log('The API returned an error: ' + err);
              console.log(data);
            });
      });

Python

customer_name = 'Alice'
date = datetime.datetime.now().strftime("%y/%m/%d")

requests = [
        # One option for replacing all text is to specify all tab IDs.
        {
        'replaceAllText': {
            'containsText': {
                'text': '{{customer-name}}',
                'matchCase':  'true'
            },
            'replaceText': customer_name,
            'tabsCriteria': {
                'tabIds': [TAB_ID_1, TAB_ID_2, TAB_ID_3],
            },
        }},
        # Another option is to omit TabsCriteria if you are replacing across all tabs.
        {
        'replaceAllText': {
            'containsText': {
                'text': '{{date}}',
                'matchCase':  'true'
            },
            'replaceText': str(date),
        }
    }
]

result = service.documents().batchUpdate(
    documentId=document_id, body={'requests': requests}).execute()

テンプレートを管理する

テンプレートドキュメントをアプリで定義および所有する場合は、そのアプリ専用のアカウントを使用してテンプレートを作成してください。サービスアカウントを利用することをおすすめします。共有を制限する Google Workspace ポリシーによる複雑さを回避できます。

テンプレートからドキュメントのインスタンスを作成する際は、必ずエンドユーザーの認証情報を使用してください。これにより、作成したドキュメントをユーザー側で完全に制御できるため、ドライブのユーザー単位の制限によって生じるスケーリングの問題を回避することができます。

サービスアカウントを使用してテンプレートを作成するには、アプリの認証情報を使用して次の手順を実施します。

Docs API の documents.create を使用してドキュメントを作成します。
Drive API の permissions.create を使用して、ドキュメントの受信者がドキュメントを読み取れるように権限を更新します。
Drive API の permissions.create を使用して、テンプレートの作成者が書き込みできるように権限を更新します。
必要に応じてテンプレートを編集します。

ドキュメントのインスタンスを作成するには、ユーザーの認証情報を使用して次の操作を行います。

Drive API の files.copy を使用してテンプレートのコピーを作成します。
Docs API の documents.batchUpdate を使用して値を置換する。