次の方法で共有

Power Query SDK を使用してコネクタを開発する

  • [アーティクル]

Power Query SDK は、Power Query コネクタの作成に役立つ一連のツールです。 これらのコネクタは、多くの場合、カスタム コネクタまたは Power Query 拡張機能と呼ばれます。

カスタム コネクタを使用すると、新しいデータ ソースを作成したり、既存のソースをカスタマイズして拡張したりできます。 一般的な使用用途は次のとおりです。

  • REST API のビジネス アナリストのフレンドリ ビューを作成する
  • 既存のコネクタ (OData サービスや ODBC ドライバーなど) で Power Query がサポートするソースのブランドを提供する
  • SaaS オファリング用の OAuth v2 認証フローを実装する
  • 使いやすさを向上させるために、データ ソースに対して制限付きまたはフィルター処理されたビューを公開する
  • ODBC ドライバーを使用してデータ ソースの DirectQuery を有効にする

Power Query SDK のインストール

Visual Studio Marketplace の Visual Studio Code セクションから Visual Studio Code Power Query SDK をインストールします。 [インストール] を選択して SDK をインストールします。

コネクタ開発プロセス

次のセクションでは、SDK を使用して Power Query コネクタを作成する最も一般的なプロセスの概要を説明します。

新しい機能の作成

新しいワークスペース (Visual Studio Code Power Query SDK) を作成する場合は、次のコア ファイルから開始します。

  • コネクタ定義ファイル (<connectorName>.pq)
  • クエリ ファイル (<connectorName>.query.pq)
  • 文字列リソース ファイル (resources.resx)
  • アイコンの作成に使われるさまざまなサイズの PNG ファイル

コネクタ定義ファイルは、空のデータ ソース記述で始まります。 データ アクセスの処理に関する記事から、Power Query SDK のコンテキストでデータ ソースの詳細を確認できます。

テスト

Power Query SDK は基本的なクエリ実行機能を備えているので、Power BI Desktop に切り替えることなく拡張機能をテストできます。

クエリ テスト ファイル

拡張ファイルに加えて、データ コネクタ プロジェクトにはクエリ ファイル (name.query.pq) を含めることができます。 このファイルは、Visual Studio Code 内でテスト クエリを実行するために使用できます。 クエリ評価には、.pqx ファイルを登録しなくても、拡張コードが自動的に含まれるため、拡張コード内の共有関数の呼び出しやテストが可能になります。

クエリ ファイルには、1 つの式 (例: HelloWorld.Contents())、let 式 (Power Query によって生成されるものなど)、またはセクション ドキュメントを含めることができます。

構築と展開

プロジェクトを構築すると、.mez ファイルまたは拡張子ファイルが生成されます。

Power Query の拡張機能は、ZIP ファイルにバンドルされており、ファイルの拡張子は .mez です。 実行時に、Power BI Desktop は [Documents]\Microsoft Power BI Desktop\Custom Connectors から拡張機能を読み込みます。

Note

Data Connector プロジェクトは、拡張ファイルを [ドキュメント]\Microsoft Power BI Desktop\Custom Connectors ディレクトリにコピーするカスタムの構築後の手順をサポートしていません。 これを実行したい場合は、サードパーティの拡張機能を使用するとよいでしょう。

拡張機能は、M セクション ドキュメント内で定義されます。 セクション ドキュメントは、Power Query で生成されるクエリ ドキュメントとは少し異なる形式です。 通常、Power Query からインポートしたコードの場合、セクション ドキュメントに合わせて変更する必要がありますが、その変更はわずかです。 注意する必要があるセクション ドキュメントの違いは次のとおりです。

  • セクション宣言で始まります (例: section HelloWorld;)。
  • 各式はセミコロンで終わります (例: a = 1; または b = let c = 1 + 2 in c;)。
  • 共有としてマークされていない限り、すべての関数と変数はセクション ドキュメントに対してローカルです。 共有関数は、他のクエリや関数から見えるようになり、拡張機能のエクスポートと考えることができます (つまり、Power Query から呼び出し可能になります)。

M セクション ドキュメントの詳細については、M 言語仕様を参照してください。

データ コネクタの配布

Power Query コネクタは、Power BI Desktop または Power BI データフロー、Power BI データマート、その他のエクスペリエンスなどの Power Query Online エクスペリエンスで使用できます。

Power BI Desktop

Power BI Desktop ユーザーは、次の手順に従って Power Query カスタム コネクタを使用できます。

  1. 拡張子ファイル (.mez または .pqx) を [ドキュメント]/Power BI Desktop/Custom Connectors にコピーします。
  2. Power BI Desktopで、[ファイル]>[オプションと設定]>[オプション]>[セキュリティ]>[データ拡張] の [(非推奨) 検証または警告なしで拡張機能の読み込みを許可する] オプションを選択します。
  3. Power BI Desktop を再起動します。

再起動時に、Power BI Desktop によって自動的に拡張機能が読み込まれます。

または、データ ソースとコネクタの所有者として、コネクタを Power Query コネクタ認定資格プログラムに送信して、すべてのリリースで Power BI Desktop に付属するようにすることもできます。

Power Query Online

Power Query Online エクスペリエンスには、Power Query 認定コネクタのみが表示されます。 Power Query コネクタ認定資格プログラムの詳細については、「Power Query コネクタ認定資格」に関するページを参照してください。