メインコンテンツにスキップ
⛏ JSON PATHによるアウトプットの取得方法

2024年6月25日時点の仕様です。

Yoom 運営事務局 avatar
対応者:Yoom 運営事務局
一週間前以上前にアップデートされました

概要

JSON PATHを使用することで、アプリオペレーションを実行した際のAPIリクエスト結果から任意の値を取得し、アウトプットとして後続のオペレーションで使用することが可能です。

※JSON PATHによるアウトプットの取得方法は2パターンあるため各パターンを紹介します。

JSON PATHについて

Yoomではアプリと連携するオペレーションで実行したAPIリクエストの結果はJSON形式のテキストで確認できるようになっています。

JSON PATHは特定のフォーマットでパスを記載することで、リクエスト結果のJSONテキストから任意の値を抽出することが可能です。(HTMLで用いるXPATHと近しいものとなります。)

パターン1

トリガーやアプリと連携するオペレーションの作成画面で「テスト」ボタンを押すとAPI接続のレスポンス結果が表示されます。

パターン1では、レスポンス結果内で直接操作をするパターンとなります。

以下のようにレスポンス結果内に+マークがある場合はこのパターンをご参照ください。

JSON PATHによるアウトプットの取得

表示されたレスポンス結果から取得した値の隣にある+マークを押すことで、自動的にアウトプットに値が取得されます。

また、項目名や入力形式を値に併せて任意に変更することも可能です。

JSON PATHを修正して、指定の値・全ての値を取得する

以下のように複数行に跨った値を取得する場合、取得したJSON PATHの一部を修正することで、特定箇所の値やすべての値を取得することが可能です。

例えば+マークにより、このようなJSON PATHを最初に取得します。

record['テーブル_0'].value[0].value['文字列__1行__4'].value

これはテーブル_0というテーブル内に、文字列_1_4という列が複数ある状況を指します。

value横[]にある数字は値の位置を指し、0であれば最初の値(以下図の場合1111)、1であれば2つ目の値(以下図の場合2222)を指定します。

文字列_1_4の列▼

添付動画のようにvalue横[]に*を入れることで、列の値をカンマ区切りですべて取得することも可能です。

パターン2

パターン1と同様、各操作画面で「テスト」ボタンを押すとAPI接続のレスポンス結果が表示されます。

パターン2では、レスポンス結果画面とは別の画面での操作パターンとなります。

以下のようにレスポンス結果内に+マークがない場合はこのパターンをご参照ください。

JSON PATHによるアウトプットの取得

1.レスポンス結果が表示されたあとに、画面下部にある「+取得する値を追加」を押します。

2.画面上にJSON PATHの指定画面が表示されるので、取得したい値横の+マークを押すことで、自動でその値を取得するJSON PATHが取得され、アウトプットとして追加されます。

3.アウトプット追加後、その項目にカーソルを合わせると以下のようにペンマークが表示されるので押します。

4.項目名や入力形式などを自由に変更することが可能です。

JSON PATHを修正して、指定の値・全ての値を取得する

パターン1と同様、パターン2における複数行に跨った値を取得する場合の方法をご説明します。

1.パターン2で先に紹介した1〜4までを操作し、以下のように項目名や入力形式の編集画面まで進みます。

2.取得したJSON PATHの値をコピーします。

3.再度「+取得する値を追加」を押し、JSON PATHの取得画面を開いたら、検索窓にコピーしたJSON PATHをペーストします。

4.パターン1と同様、複数の値を取得するためにJSON PATHの内容を一部修正し、各値が表示されたら、「+JSONPath指定」を押します。

5.最後に1の段階で取得していたJSON PATHのアウトプットを削除し、新しく取得したアウトプットの項目名や入力形式を任意のものに変えたら設定完了です。

以上がJSON PATHによるアウトプットの取得方法です。

関連記事

# 操作,JSON,JSONPATH,アウトプット

こちらの回答で解決しましたか?