For AI agents: the complete documentation index is available at https://docs.dataplatform.ovh.net/ja/llms.txt, the full documentation bundle is available at https://docs.dataplatform.ovh.net/ja/llms-full.txt, and this page is available as Markdown at https://docs.dataplatform.ovh.net/ja/connectors-sources-rest.md.
  • 🇯🇵 日本語

    • REST APIからデータをインポートする

    ストアでHTTP RESTを見つけた後、Selectをクリックすると、以下に示す構成画面が表示されます

    目的

    REST は、互換性のあるAPIから情報を要求し、JSONレスポンスからデータをインポートするための標準的なアプリケーションプロトコルです。

    rest

    Data PlatformにHTTP RESTソースを追加する

    構成画面の概要

    ストアでHTTP RESTを見つけた後、Selectをクリックすると、以下に示す構成画面が表示されます。

    rest

    サポートされているファイルとサイズ

    Info

    HTTP RESTコネクタは現在、JSONタイプのレスポンスのみをサポートしています。

    さらに、メタデータ抽出ジョブを実行する際のファイルサイズ制限があります。 特に、以下の場合です。

    • 完全抽出: ~900 MB
    • サンプル抽出: ~2.5 GB

    ソースの構成

    ソースを作成する際には、以下の情報を入力する必要があります。

    API情報

    URL: 要求するAPIのベースURLまたはアドレス（後でエンドポイントを登録します） SSL verify: セキュアな接続を設定したい場合は有効にします 認証モード: APIが認証を必要とする場合は有効にします（以下を参照）

    認証情報

    REST APIが認証を必要とする場合は、認証セクションで認証モードを選択して構成します。APIが認証を必要としない場合は、このステップをスキップできます。

    2

    POSTまたはGETの方法を選択し、認証が必要なURL（例: http://localhost/auth）を続けます。

    次に、レスポンスで使用するトークンパスを入力し、トークンをクッキーに保持するかどうかを決定します。つまり、認証セッションをクッキーに保存します。

    最後に、以下のオプションのパラメータを構成します。

    • Body: json、form-data、form-urlencoded、またはインラインのオプションのボディを追加します
    • Query: 要求にクエリを追加します
    • Header: 要求のヘッダーを追加します
    3

    認証レスポンスからトークンを取得する必要がある場合は、レスポンスJSONのどのキーにトークンが格納されているかを指定する必要があります。（一般的に: token）

    上記の詳細を追加した後、APIとの接続を確立し、エンドポイントの登録に進むには、Connectをクリックします。

    データを読み込むためのエンドポイントを指定する

    Data Platformでは、各登録されたエンドポイントは、別々のテーブルに読み込むことができるデータソースオブジェクトに対応します。

    APIのエンドポイントは、接続するエンドポイントセクションから追加できます。デフォルトでは、エンドポイントはありません。手動で追加する必要があります。

    4

    各エンドポイントについて、以下のパラメータを構成できます。

    • Query: このエンドポイントの要求にクエリを追加します
    • Header: このエンドポイントの要求のヘッダーを追加します
    • Options: タイムアウト、ページネーションの設定、またはこのエンドポイントからのデータを含むテーブルの名前を設定するなどの追加オプションを構成します
    Info

    上記のオプションに変数を注入できます。さらに詳しい情報については、下記のリファレンスを参照してください。

    5

    新しいエンドポイントで高度なモードを使用して、Curl要求から事前構成されたエンドポイントをインポートできます。

    5

    変数を注入する

    認証トークン

    認証エンドポイントを有効にし、以前に取得したトークンを再利用する必要がある場合は、Queryセクションの必要なキーの値、またはHeaderセクション、Bodyセクション、またはURLに$tokenを入力できます。

    セグメンテーション値

    このセクションでは、エンドポイント内でカスタマイズ目的で変数プレースホルダーを使用する方法について説明します。これらのプレースホルダーは、ユーザーが値を動的に指定できるようにし、システムの柔軟性と適応性を高めることができます。

    変数はパーセント記号（%）で囲み、次の形式で指定します: (%VARIABLE_TYPE|DEFAULT_VALUE%)。

    VARIABLE_TYPE: 変数の種類を説明します。 DEFAULT_VALUE: ユーザーが提供しない場合、変数が置き換えられるデフォルト値を表します。

    変数の種類:

    segmentationValue: この変数の種類は、プレースホルダーをセグメンテーションの最初の値に置き換えます。 形式: 数値またはテキスト。 例: (%segmentationValue|1%)

    segmentationValues: この変数の種類は、プレースホルダーをセグメンテーションのすべての値に置き換え、配列として形式を整えます。 例: (%segmentationValues|[1,2,3]%)

    ユーザーは、エンドポイントの以下のコンポーネントにこれらの変数を組み込むことができます:

    URL: 変数を使用して、URL内に動的に値を挿入できます。 例: GET /api/data/(%segmentationValue|1%)/details

    Body (Payload): 要求でペイロードを送信する場合、変数を使用して動的な値を含めることができます。 例:

    json

    { "segmentationValue": "(%segmentationValue|1%)", "filter": "(%segmentationValues|[]%)" }

    Query Parameters: 変数をクエリパラメータに含め、要求をカスタマイズできます。 例: GET /api/data?segment=%segmentationValue|1%&filters=%segmentationValues|[]%

    相対日付

    クエリの日に相対する日付パラメータを使用する必要がある場合は、パイプで区切られた2つの部分からなる次の特殊なワイルドカードを使用できます| : (%now|date%)は、クエリが行われる日（YYYY-MM-DDとして形式を整え）に置き換えられます。

    パイプの前の可能な値:

    • (%dateMin|: DPEワークフローのパラメータで構成された日付の最小値を使用します
    • (%dateMax|: DPEワークフローのパラメータで構成された日付の最大値を使用します
    • %now|: 実行時に現在の日付と時刻を使用します

    パイプの後の可能な値で日付形式を指定する:

    • |date%): YYYY-MM-DDとして
    • |datetime%): YYYY-MM-DD HH:mm:SSとして
    • |timestamp%): UNIXタイムスタンプとして
    • |%Y-%m-%d%): カスタムフォーマッターとして
    Info

    カスタム形式についてさらに詳しく知るには、Python datetimeドキュメントを参照してください。

    Warning

    ソースを作成する前にソースに名前を付けることを忘れないでください。ソースを作成した後、技術名を変更することはできません。また、Data Platform SDKを使用してソースを開こうとする際に使用されます。

    さらに詳しく

    トレーニングや技術的なアシスタンスを受けるには、営業担当者にお問い合わせください、またはプロフェッショナルサービスページを訪れ、見積もりを依頼し、専門家チームによってプロジェクトを分析してもらってください。

    質問をする、フィードバックを提供し、Data Platformを構築するチームと直接交流するには、専用のDiscordチャネルにアクセスしてください。

    OVHcloudサービスについてサポートが必要な場合は、ヘルプセンターでリクエストを作成してください。

    ユーザーコミュニティに参加してください。