スマートチップを使用して Google ブックスからのリンクをプレビューする

コーディング レベル: 中級
所要時間: 30 分
プロジェクトの種類: Google Workspace アドオン

目標

• アドオンの機能について説明します。
• 以下を使用して、アドオンの構築方法を理解します。 Apps Script の機能と、 説明します。
• 環境を設定する。
• スクリプトを設定します。
• スクリプトを実行します。

この Google Workspace アドオンについて

このサンプルでは、Google Workspace からのリンクをプレビューする Google Workspace アドオンを作成します。 Google ブックスの 作成する必要があります。Google ブックスの URL を 作成された場合、アドオンは リンクのプレビューがトリガーされます。リンクをプレビューするには、 スマートチップにリンクできます。リンクの上にポインタを置くと、 書籍の詳細情報が表示されます。

このアドオンで使用されている Apps Script の UrlFetch サービスを使用して、 Google ブックスの書籍 API にアクセスし、 Google ドキュメントに表示する Google ブックスに関する情報。

仕組み

Google Workspace アドオンのマニフェスト ファイルの場合、スクリプトによって Google ドキュメントを拡張してリンクをトリガーするアドオン Google ブックスのウェブサイトの特定のパターンに一致する URL のプレビュー (https://books.google.com).

このコードファイルでは、スクリプトが Google ブックス API に接続し、URL を使用して 書籍に関する情報（Volume のインスタンス）を 参照）。「 スクリプトがこの情報を使用してスマートチップを生成し、 タイトルと、概要、ページ数、概要を表示するプレビュー カード 表紙、評価数などです

Apps Script サービス

このアドオンは次のサービスを使用します。

• UrlFetch サービス - Google ブックスに接続します。 書籍に関する情報（API のインスタンス）を取得するための API Volume リソース）。
• Card Service - ユーザーを作成します。 インターフェースで確認できます。

前提条件

このサンプルを使用するには、次の前提条件を満たす必要があります。

• Google アカウント（Google Workspace アカウントは 管理者の承認が必要です）。

• インターネットにアクセスできるウェブブラウザ。

• Google Cloud プロジェクト 関連付ける。詳しくは、サービス アカウントの プロジェクトです。

環境の設定

以降のセクションでは、アプリケーションをビルドするための環境を設定します。 できます。

Google Cloud コンソールで Cloud プロジェクトを開く

まだ開いていない場合は、使用する Cloud プロジェクトを開きます。 次のように設定します。

1. Google Cloud コンソールで、[プロジェクトの選択] ページに移動します。

   Cloud プロジェクトを選択する

2. 使用する Google Cloud プロジェクトを選択します。または、[プロジェクトを作成] をクリックし、画面の指示に従います。Google Cloud プロジェクトを作成する場合、プロジェクトの課金を有効にする必要があります。

Google Books API を有効にする

このアドオンは Google Books API に接続します。 Google API を使用する前に、Google Cloud プロジェクトで有効にする必要があります。 1 つの Google Cloud プロジェクトで 1 つ以上の API を有効にできます。

• Cloud プロジェクトで、Books API を有効にします。

  <ph type="x-smartling-placeholder"></ph> API を有効にする

OAuth 同意画面を構成する

このアドオンには、Cloud プロジェクト、 設定済みの同意画面。OAuth 同意画面を構成すると、 Google がユーザーに表示され、アプリを公開できるようにアプリを登録します 後で説明します

1. Google Cloud コンソールで、メニュー menu に移動します。 &gt; API とサービス &gt; OAuth 同意画面。

   OAuth 同意画面に移動

2. [ユーザーの種類] で [内部] を選択し、[作成] をクリックします。
3. アプリ登録フォームに入力し、[保存して次へ] をクリックします。

4. 現時点では、スコープの追加をスキップして [保存して次へ] をクリックします。 今後、Google Play 以外で使用するアプリを作成した場合、 [ユーザーの種類] を [外部] に変更してから、 アプリに必要な認証スコープを追加します。

5. アプリ登録の概要を確認します。変更するには、[編集] をクリックします。アプリが 問題がなければ、[ダッシュボードに戻る] をクリックします。

Google Books API の API キーを取得する

1. Google Cloud コンソールに移動します。 課金が有効なプロジェクトが開いていることを確認します。

2. Google Cloud コンソールで、メニュー menu に移動します。 &gt; API とサービス &gt; [認証情報] をタップします。

   [認証情報] に移動

3. [認証情報を作成] &gt; [API キー] をクリックします。

4. 後のステップで使用するため、API キーをメモしておきます。

スクリプトを設定する

以降のセクションでは、 できます。

Apps Script プロジェクトを作成する

1. 次のボタンをクリックして、[Google ブックスからのリンクをプレビュー] を開きます。 Apps Script プロジェクト。
   プロジェクトを開く
2. info_outline [概要] をクリックします。
3. 概要ページで [コピーを作成] をクリックします。
4. Apps Script プロジェクトのコピーで、Code.gs に移動します。 YOUR_API_KEY を、 確認します。

Cloud プロジェクト番号をコピーする

1. Google Cloud コンソールで、メニュー menu に移動します。 &gt; IAM と管理 &gt; [設定] をタップします。

   [IAM と管理] の [設定] に移動

2. [プロジェクト番号] フィールドに値をコピーします。

Apps Script プロジェクトの Cloud プロジェクトを設定する

1. Apps Script プロジェクトで、 [] をクリックします。 プロジェクト設定。
2. [Google Cloud Platform（GCP）プロジェクト] で、[プロジェクトを変更] をクリックします。
3. [GCP プロジェクト番号] に、Google Cloud プロジェクト番号を貼り付けます。
4. [プロジェクトを設定] をクリックします。

アドオンをテストする

以下のセクションでは、作成したアドオンをテストします。

テストデプロイをインストールする

1. Apps Script プロジェクトで、code [Editor] をクリックします。
2. YOUR_API_KEY は、次で作成した Google ブックス API の API キーに置き換えます。 確認できます。
3. [デプロイ] &gt; [デプロイをテスト] をクリックします。
4. [インストール] &gt; [完了] をクリックします。

Google ドキュメントでリンクをプレビューする

1. 次の場所で Google ドキュメントを作成: docs.new.
2. 次の URL をドキュメントに貼り付け、Tab キーを押して次の操作を行います。 URL をスマートチップに変換します。 https://www.google.com/books/edition/Software_Engineering_at_Google/V3TTDwAAQBAJ
3. スマートチップの上にポインタを置き、メッセージが表示されたら、以下へのアクセスを承認します。 アドオンを実行しますプレビュー カードが表示されます。 書籍に関する情報が表示されます。

次の図は、リンクのプレビューを示しています。

コードを確認する

このアプリケーションの Apps Script コードを確認するには、 [ソースコードを表示] をクリックして セクション:

{
  "timeZone": "America/Los_Angeles",
  "exceptionLogging": "STACKDRIVER",
  "runtimeVersion": "V8",
  "oauthScopes": [
    "https://www.googleapis.com/auth/workspace.linkpreview",
    "https://www.googleapis.com/auth/script.external_request"
  ],
  "urlFetchWhitelist": [
    "https://www.googleapis.com/books/v1/volumes/"
  ],
  "addOns": {
    "common": {
      "name": "Preview Books Add-on",
      "logoUrl": "https://developers.google.com/workspace/add-ons/images/library-icon.png",
      "layoutProperties": {
        "primaryColor": "#dd4b39"
      }
    },
    "docs": {
      "linkPreviewTriggers": [
        {
          "runFunction": "bookLinkPreview",
          "patterns": [
            {
              "hostPattern": "*.google.*",
              "pathPrefix": "books"
            },
            {
              "hostPattern": "*.google.*",
              "pathPrefix": "books/edition"
            }
          ],
          "labelText": "Book",
          "logoUrl": "https://developers.google.com/workspace/add-ons/images/book-icon.png",
          "localizedLabelText": {
            "es": "Libros"
          }
        }
      ]
    }
  }
}

function getBook(id) {
  const apiKey = 'YOUR_API_KEY'; // Replace with your API key
  const apiEndpoint = `https://www.googleapis.com/books/v1/volumes/${id}?key=${apiKey}&country=US`;
  const response = UrlFetchApp.fetch(apiEndpoint);
  return JSON.parse(response);
}

function bookLinkPreview(event) {
 if (event.docs.matchedUrl.url) {
    const segments = event.docs.matchedUrl.url.split('/');
    const volumeID = segments[segments.length - 1];

    const bookData = getBook(volumeID);
    const bookTitle = bookData.volumeInfo.title;
    const bookDescription = bookData.volumeInfo.description;
    const bookImage = bookData.volumeInfo.imageLinks.small;
    const bookAuthors = bookData.volumeInfo.authors;
    const bookPageCount = bookData.volumeInfo.pageCount;

    const previewHeader = CardService.newCardHeader()
      .setSubtitle('By ' + bookAuthors)
      .setTitle(bookTitle);

    const previewPages = CardService.newDecoratedText()
      .setTopLabel('Page count')
      .setText(bookPageCount);

    const previewDescription = CardService.newDecoratedText()
      .setTopLabel('About this book')
      .setText(bookDescription).setWrapText(true);

    const previewImage = CardService.newImage()
      .setAltText('Image of book cover')
      .setImageUrl(bookImage);

    const buttonBook = CardService.newTextButton()
      .setText('View book')
      .setOpenLink(CardService.newOpenLink()
        .setUrl(event.docs.matchedUrl.url));

    const cardSectionBook = CardService.newCardSection()
      .addWidget(previewImage)
      .addWidget(previewPages)
      .addWidget(CardService.newDivider())
      .addWidget(previewDescription)
      .addWidget(buttonBook);

    return CardService.newCardBuilder()
    .setHeader(previewHeader)
    .addSection(cardSectionBook)
    .build();
  }
}

関連トピック

• スマートチップを使用してリンクをプレビューする
• Google Books API のリファレンス ドキュメント