API 経由でのドキュメントセクションの編集

ステップ 1
新しい Quip ドキュメントを作成し、テーブルを追加します。セルの 1 つに「Before」という単語を入力します。

ステップ 2
新しいドキュメントの URL を確認します。この URL にドキュメント ID (別名「スレッド ID」) が含まれています。この例では、スレッド ID は bseaAILH8Pt9 です。

次に、Quip の Automation API を使用してスレッドをクエリします。

ステップ 3
Automation API 呼び出しを行うには、自分の個人用 Quip アカウントへの API アクセスを提供するアクセストークンを生成する必要があります。https://quip.com/dev/token にアクセスしてこれを実行してください。

ステップ 4
[Get Personal Access Token] (個人アクセストークンを取得) をクリックしてトークンを生成します。このトークンをコピーしておいてください (ステップ 6 で必要になります)。このトークンは誰とも共有しないでください。Salesforce や Quip の担当者にも教えないようにしてください。

ステップ 5
Postman をダウンロードします。Postman で、[New] (新規) をクリックし、[Request] (リクエスト) を選択します。プロンプトが表示された場合は、リクエストに「Get a thread」という名前を付けます。

ステップ 6

• 上部にある GET の横に、URL https://platform.quip.com/1/threads/ID を貼り付けます。ただし、ID はステップ 2 で取得したドキュメントのスレッド ID に置き換えます。
• [Authorization] (認証) タブで、[Type] (タイプ) を [OAuth 2.0] に設定します。
• [Add Authorization data to] (認証データの追加先) を「リクエストヘッダー」に設定します。
• [アクセストークン] にステップ 4 のトークンを貼り付けます。

ステップ 7
青い [Send] (送信) ボタンをクリックして、API クエリを送信します。Quip からの応答が下部に表示されます。

画面をスクロールして、Quip の応答全体を確認します。

作成者 ID、ドキュメントの種類 (ドキュメントかシートか)、さまざまなタイムスタンプなど、多くのデータが含まれていることがわかります。

ドキュメントの完全な HTML 本文も含まれていることが確認できます。


ステップ 8
虫眼鏡アイコンをクリックして、「Before」という単語を検索します。これはドキュメント内の特定のテーブルセルです。セルのセクション ID をメモします。右側の例では、セクション ID は s:TbUACAI6LgB_TbUACAWHjs6 です。これはステップ 16 で必要になります。
 

休憩

これまでの内容を振り返りましょう。Automation API を使用して、ドキュメント (「スレッド」と呼ばれる) を取得しました。

次に、ドキュメントのスレッド ID とテキストのセクション ID がわかったので、Quip API の 2 番目のクエリを使用して、このテキストを「Before」から「After」に変更します。Automation API を使用してこの編集を行うことも可能ですが、今回は 2 つの API の違いを理解するために Admin API を使用します。

Automation API は、Quip ユーザーに関連付けられたトークンを活用して API 呼び出しを実行します (そのため、ユーザーが実行できる操作に限定されます)。一方、Admin API は Quip サイトの管理者が作成した API キーを使用します。その結果、Admin API を使用することで、個々の Quip ユーザーが通常はアクセスできないコンテンツにもアクセスできます。さらに、Admin API には、Automation API にはない追加のエンドポイント (メッセージの削除など) が含まれています。
 

ステップ 9
Quip サイトの管理者に、Quip の管理コンソールにアクセスし、[設定] → [インテグレーション] → [新しい API キー] の順に移動して、API キーを作成してもらいます。テスト用キーでは、許可されたすべてのスコープを有効にできます。

キーを作成したら、キーの横にある [表示] をクリックして、[クライアント ID] と [クライアントの秘密] を表示します。これはステップ 14 で必要になります。


ステップ 10
Quip 管理者は [設定] → [サイトの設定] にも移動する必要があります。このページの上部にある会社 ID をメモしておいてください。ステップ 16 で必要になります。


ステップ 11
同じページを下にスクロールし、[Admin API ユーザー] セクションで [アクセス権の付与] をクリックします。手順に従って、Quip ユーザーに Admin API アクセス権を付与します。

次に、Postman で Admin API 呼び出しを設定します。


ステップ 12
Postman で、[New] (新規) をクリックし、[Request] (リクエスト) を選択します。プロンプトが表示された場合は、リクエストに「Admin:Edit a thread」という名前を付けます。


ステップ 13
上部にある GET を POST に変更します。次に、URL https://platform.quip.com/1/admin/threads/edit-document を貼り付けます。


ステップ 14
[Authorization] (認証) タブで、[Type] (タイプ) を [OAuth 2.0] に設定します。[Add Authorization data to] (認証データの追加先) を「リクエストヘッダー」に設定します。右側の [Configure New Token] (新しいトークンを設定) を展開し、次のように入力します。

• トークン名: Postman
• 付与種別: 認証コード
• コールバック URL: ([Authorize using browser] (ブラウザーを使用して承認) チェックボックスをオンにします)
• 認証 URL: https://platform.quip.com/1/oauth/login
• アクセストークン URL: https://platform.quip.com/1/oauth/access_token
• クライアント ID: (ステップ 9 から貼り付けます)
• クライアントの秘密: (ステップ 9 から貼り付けます)
• スコープ:(空白のままにします)
• 状態:(空白のままにします)
• クライアント認証: Send credentials in body (本文で資格情報を送信)

ステップ 15
[Get New Access Token] (新規アクセストークンを取得) をクリックします。Quip で認証するために Web ブラウザーにリダイレクトされます。

最終的に、[Manage Access Tokens] (アクセストークンの管理) 画面に移動します。ここで、[Use Token] (トークンを使用) ボタンをクリックします。

ステップ 16
[Body] (本文) サブタブをクリックし、次のフィールドに入力して API リクエストを作成します。

必ず自分の company_id (ステップ 10 から)、thread_id (ステップ 2 から)、section_id (ステップ 8 から) を使用してください。


ステップ 17
青い [Send] (送信) ボタンをクリックして、API クエリを送信します。Quip からの応答が下部に表示されます。

入力内容がすべて正しければ、ドキュメントに変更が反映されます。反映された場合は成功です。問題が発生した場合は、Quip サポートにお問い合わせください。最後までサポートいたします。