前提条件 Smartsheet デベロッパーツールを設定する OAuth アクセススコープ Amazon Quick で統合を設定する使用可能なアクションの管理とトラブルシューティング

Smartsheet の統合

Smartsheet アクションコネクタを使用して、シート、行、レポートを管理し、自然言語を使用して Amazon Quick で Smartsheet ワークスペース全体で直接検索します。この統合では、Smartsheet API を使用します。詳細については、Smartsheet ドキュメントの「Smartsheet API の概要」を参照してください。

この統合をセットアップするには、2 つのステップが必要です。まず、選択した認証方法用に Smartsheet で認証情報を設定します。次に、Amazon Quick で統合を作成し、Smartsheet アカウントに接続します。Amazon Quick がサポートする認証方法の詳細については、「」を参照してください認証方法。

前提条件

統合を設定する前に、次の要件を満たしていることを確認してください。

ビジネスプランまたはエンタープライズプランを持つ Smartsheet アカウント。無料アカウントでは、API アクセストークンを生成したり、OAuth アプリを登録したりすることはできません。詳細については、Smartsheet ウェブサイトの「Smartsheet の料金」を参照してください。
アカウントでアクティブ化された Smartsheet 開発者ツールへのアクセス。登録するには、デベロッパーツールの登録ページに移動します。
サブスクリプションの要件については、「」を参照してくださいコンソールで統合を設定する。

Smartsheet デベロッパーツールを設定する

Amazon Quick を設定する前に、Smartsheet で認証情報を設定します。実行する手順は、使用する認証方法によって異なります。Amazon Quick は、Smartsheet の 2 つの認証方法をサポートしています。これらの方法の詳細については、「認証方法」を参照してください。

ユーザー認証 (OAuth) – 各ユーザーは独自の Smartsheet アカウントでサインインします。アクションは、そのユーザーのアクセス許可で実行されます。このメソッドはを使用しますカスタム OAuth アプリ。以下のデベロッパーツールに登録し、デベロッパープロファイルを作成するおよび OAuth アプリケーションを登録するセクションを完了します。
サービス認証 (API キー) – すべてのアクションは、単一の API トークンを使用して実行されます。このメソッドはを使用しますAPI キー認証。以下のAPI アクセストークンを生成する (サービス認証のみ)セクションを完了します。

Smartsheet OAuth の詳細については、Smartsheet API ドキュメントのOAuth」を参照してください。

デベロッパーツールに登録し、デベロッパープロファイルを作成する

デベロッパーツールの登録ページに移動し、アプリで使用する Smartsheet アカウントを登録します。詳細については、Smartsheet API ドキュメントの「開発者用ツールの登録」を参照してください。
Smartsheet がデベロッパーツールをアクティブ化したら、Smartsheet アプリケーションにサインインし、左下のアカウントアイコンを選択し、デベロッパーツールを選択します。
開発者プロファイルの作成 を選択し、プロファイル名を入力します。詳細については、Smartsheet API ドキュメントの「開発者プロファイルを作成する」を参照してください。

ヒント

Smartsheet では、個人アカウントではなく、OAuth アプリ専用のサービスアカウントを使用することをお勧めします。

OAuth アプリケーションを登録する

Smartsheet デベロッパーツールで、新しいアプリの作成を選択します。
フォームに入力します。
- アプリケーション名 – ユーザーに対してアプリケーションを識別する名前。
- アプリケーションの説明 – 統合の簡単な説明。
- アプリ URL – アプリを起動する URL、またはランディングページ。
- アプリの連絡先/サポート – サポートの連絡先情報。
- アプリリダイレクト URL – https://{region}.quicksight.aws.amazon.com/sn/oauthcallback
  
  {region} を自分の AWS リージョン (例: ) に置き換えますus-east-1。
[保存] を選択します。Smartsheet は、アプリクライアント ID とアプリシークレットを生成します。
クライアント ID とクライアントシークレットの値をコピーします。これらは、Amazon Quick で統合を設定するときに必要です。

詳細については、Smartsheet API ドキュメントの「アプリの登録」を参照してください。

API アクセストークンを生成する (サービス認証のみ)

OAuth の代わりにサービス認証を使用する場合は、API アクセストークンを生成します。トークンを生成するには、ビジネスプランまたはエンタープライズプランが必要です。詳細については、Smartsheet ヘルプセンターの「API アクセストークンを生成する」を参照してください。

Smartsheet アプリケーションで、左側のナビゲーションバーの下部にあるアカウント (プロファイルイメージ) を選択し、個人設定を選択します。
API アクセスタブを選択し、新しいアクセストークンの生成を選択します。
トークンに名前を付け、OK を選択します。トークン値をすぐにコピーします。表示されるのは今回だけです。

重要

アクセストークンを安全に保存します。トークンを持つユーザーは、トークン所有者がアクセスできるすべての Smartsheet データにアクセスできます。トークンをバージョン管理システムにコミットしないでください。トークンの保存に関するベストプラクティスについては、Smartsheet API ドキュメントの「認証」を参照してください。

OAuth アクセススコープ

ユーザー認証 (OAuth) を設定すると、統合は Smartsheet に次のアクセススコープをリクエストします。これらのスコープは、認証されたユーザーに代わって統合が実行できる処理を決定します。代わりにサービス認証 (API キー) を使用する場合、統合はトークン所有者の完全なアクセス許可を使用し、スコープは適用されません。詳細については、Smartsheet API ドキュメントの「アクセススコープ」を参照してください。

Smartsheet OAuth アクセススコープ
スコープ	説明
`READ_SHEETS`	添付ファイル、ディスカッション、セルデータなど、すべてのシートデータを読み取ります。
`WRITE_SHEETS`	添付ファイル、ディスカッション、セルデータなど、シートデータを挿入および変更します。

注記

アクセススコープは、既存の共有アクセス許可を上書きしません。たとえば、 WRITE_SHEETSスコープを持つと、ユーザーがビューワーレベルのアクセスのみを持つシートを統合で更新できなくなります。詳細については、Smartsheet API ドキュメントの「リソースアクセスレベル」を参照してください。

Amazon Quick で統合を設定する

Smartsheet デベロッパーツールの設定が完了したら、Amazon Quick で統合を作成します。

Amazon Quick コンソールで、コネクタを選択します。
チームの作成タブを選択します。
Smartsheet を検索して選択します。
統合の詳細を入力します。
- 名前 – Smartsheet 統合の説明名。
- 説明 (オプション) – 統合の目的。
接続タイプを選択し、接続設定を入力します。これらの認証方法の詳細については、「」を参照してください認証方法。
1. ユーザー認証 (OAuth) では、Smartsheet 開発者ツールアプリ登録のクライアント ID とクライアントシークレットを使用します。以下のフィールドを設定します。
  - ベース URL – https://api.smartsheet.com/2.0
  - クライアント ID – Smartsheet Developer Tools アプリ登録のアプリクライアント ID。
  - クライアントシークレット – Smartsheet Developer Tools アプリ登録からのアプリシークレット。
  - トークン URL – https://api.smartsheet.com/2.0/token
  - 認証 URL – https://app.smartsheet.com/b/authorize
  - リダイレクト URL – https://{region}.quicksight.aws.amazon.com/sn/oauthcallback
2. サービス認証 (API キー) には、Smartsheet Personal Settings の API アクセストークンを使用します。以下のフィールドを設定します。
  - API キー – 個人設定から生成された Smartsheet API アクセストークン。
  - ベース URL – https://api.smartsheet.com/2.0
  - E メール – トークンを生成した Smartsheet アカウントに関連付けられた E メールアドレス。
[作成して続ける] を選択します。
統合を共有するユーザーを選択します。
[次へ] を選択します。

ユーザー認証の場合は、コネクタ > Smartsheet コネクタ名に移動し、サインインを選択して OAuth 認可フローを完了します。Smartsheet の同意ウィンドウで、アクセスを許可するを選択します。

重要

サービス認証では、すべてのアクションは API トークン所有者のアクセス許可を使用して実行されます。この統合にアクセスできる Amazon Quick ユーザーは、トークン所有者がアクセスできるすべての Smartsheet リソースに対してアクションを実行できます。トークンのアクセス許可を組織のセキュリティ要件に応じて適切にスコープします。

注記

Smartsheet Gov、Smartsheet リージョン Europe、または Smartsheet リージョン Australia を使用する場合は、環境に対応するベース URL を使用します。

Smartsheet リージョンベース URLs
環境	ベース URL
Smartsheet	`https://api.smartsheet.com/2.0`
Smartsheet Gov	`https://api.smartsheetgov.com/2.0`
Smartsheet リージョン欧州	`https://api.smartsheet.eu/2.0`
Smartsheet リージョンオーストラリア	`https://api.smartsheet.au/2.0`

詳細については、Smartsheet API ドキュメントの「基本 URL」を参照してください。

使用可能なアクション

統合を設定すると、次のアクションを使用できます。

Smartsheet で使用可能なアクション
Category	[アクション]	説明
検索	リスト検索	指定したテキストに対してユーザーがアクセスできるすべてのシートを検索します。
シート	シートを一覧表示する	認証されたユーザーがアクセスできるすべてのシートを一覧表示します。
シート	シートの取得	シート ID に基づいてシートとそのデータを取得します。
レポート	レポートを一覧表示する	ユーザーがアクセスできるすべてのレポートを一覧表示します。
レポート	レポートの表示	レポート ID に基づいてレポートの詳細を取得します。

の管理とトラブルシューティング

統合を編集、共有、または削除するには、「」を参照してください既存の統合の管理。

認証問題

OAuth 認可が失敗する – クライアント ID とクライアントシークレットが Smartsheet Developer Tools アプリ登録の値と一致していることを確認します。Smartsheet のリダイレクト URL が Amazon Quick 設定の URL と正確に一致することを確認します。OAuth エラータイプのリストについては、Smartsheet API ドキュメントのOAuth エラータイプ」を参照してください。
デベロッパーツールを使用できません – Smartsheet アカウントでデベロッパーツールがアクティブ化されていることを確認します。無料アカウントはデベロッパーツールをサポートしていません。リクエストが拒否された場合は、Smartsheet Customer Success Manager にお問い合わせください。
API キー認証が失敗する – アクセストークンが取り消されていないことを確認します。Smartsheet アプリケーションの Personal Settings > API Access からトークンを管理できます。詳細については、Smartsheet ヘルプセンターの「API アクセストークンを生成する」を参照してください。
アクセストークンの有効期限切れ – OAuth アクセストークンは約 7 日後に期限切れになります。Amazon Quick はトークンの更新を自動的に処理します。永続的なトークンエラーが発生した場合は、統合設定からサインアウトして再度サインインします。詳細については、Smartsheet API ドキュメントの「API コールを行う」を参照してください。

一般的なエラーメッセージ

アクションがアクセス許可エラーを返す – 認証されたユーザーがターゲットシートで必要な共有アクセス許可を持っていることを確認します。OAuth スコープは、共有レベルのアクセスコントロールを上書きしません。詳細については、Smartsheet API ドキュメントの「リソースアクセスレベル」を参照してください。
シートが見つかりません – シート ID が正しく、認証されたユーザーが少なくともシートへのビューワーアクセス権を持っていることを確認します。
API レート制限エラー – Smartsheet API はレート制限を適用します。詳細については、Smartsheet API ドキュメントの「制限事項」を参照してください。

ブラウザで JavaScript が無効になっているか、使用できません。

AWS ドキュメントを使用するには、JavaScript を有効にする必要があります。手順については、使用するブラウザのヘルプページを参照してください。

ドキュメントの表記規則

Slack 統合

Visier 統合