PhantomBuster のデータでGoogle Sheets を拡張

古川えりか
古川えりか
コンテンツスペシャリスト
API Server を介して、Google Apps Script から PhantomBuster を呼び出せます。



マクロ、カスタム関数、アドオンを使用してGoogle スプレッドシートからPhantomBuster のデータとやり取りします。CData API Server は、ADO.NET Provider for API（またはその他の240+ ADO.NET Providers）と組み合わせることで、Google Sheets のようなクラウドベースのモバイルアプリケーションからPhantomBuster のデータに接続できるようになります。API Server は、PhantomBuster およびCData ADO.NET Providers にサポートされるすべてのソースのOData サービスを生成する軽量のWeb アプリケーションです。

Google Apps Script（GAS）は、これらのOData サービスをJSON 形式で利用できます。この記事では、Google スプレッドシートにAgents データを取り込みシンプルなアドオンを作成する方法を説明します。

API Server の設定

以下のリンクからAPI Server の無償トライアルをスタートしたら、セキュアなPhantomBuster OData サービスを作成していきましょう。

PhantomBuster への接続

GAS からPhantomBuster のデータを操作するには、まずPhantomBuster への接続を作成・設定します。

  1. API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。 接続を追加
  2. 「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「PhantomBuster」を選択します。
  3. 事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
    CData コネクタの追加方法はこちら >>
  4. それでは、PhantomBuster への接続設定を行っていきましょう！ 接続設定

  5. API キー認証の設定

    Phantombuster API を利用するには、Phantombuster のアカウント設定から API キーを取得する必要があります。phantombuster.com に移動し、プロフィールアイコンをクリックして Settings を選択し、API セクションから API キーをコピーしてください。

    以下の接続プロパティを設定して接続を確立してください：

    • AuthScheme：APIKey に設定します。
    • APIKey：アカウント設定ページから取得した Phantombuster の API キーに設定します。

    複数組織のアカウント

    API キーが複数の組織に紐づいている場合は、OrganizationId 接続プロパティに対象の組織識別子を設定することで、特定の組織を指定できます。設定すると、X-Phantombuster-Org リクエストヘッダーとして送信されます。

    接続文字列の例：

    Profile=C:\profiles\Phantombuster.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key_here"
  6. 接続情報の入力が完了したら、「保存およびテスト」をクリックします。

API キー認証の設定

Phantombuster API を利用するには、Phantombuster のアカウント設定から API キーを取得する必要があります。phantombuster.com に移動し、プロフィールアイコンをクリックして Settings を選択し、API セクションから API キーをコピーしてください。

以下の接続プロパティを設定して接続を確立してください：

  • AuthScheme：APIKey に設定します。
  • APIKey：アカウント設定ページから取得した Phantombuster の API キーに設定します。

複数組織のアカウント

API キーが複数の組織に紐づいている場合は、OrganizationId 接続プロパティに対象の組織識別子を設定することで、特定の組織を指定できます。設定すると、X-Phantombuster-Org リクエストヘッダーとして送信されます。

接続文字列の例：

Profile=C:\profiles\Phantombuster.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key_here"

API Server のユーザー設定

次に、API Server 経由でPhantomBuster にアクセスするユーザーを作成します。「Users」ページでユーザーを追加・設定できます。やってみましょう。

  1. 「Users」ページで ユーザーを追加をクリックすると、「ユーザーを追加」ポップアップが開きます。
  2. 次に、「ロール」、「ユーザー名」、「権限」プロパティを設定し、「ユーザーを追加」をクリックします。
  3. その後、ユーザーの認証トークンが生成されます。各ユーザーの認証トークンとその他の情報は「Users」ページで確認できます。

PhantomBuster 用のAPI エンドポイントの作成

ユーザーを作成したら、PhantomBuster のデータ用のAPI エンドポイントを作成していきます。

  1. まず、「API」ページに移動し、 「 テーブルを追加」をクリックします。
  2. アクセスしたい接続を選択し、次へをクリックします。
  3. 接続を選択した状態で、各テーブルを選択して確認をクリックすることでエンドポイントを作成します。

OData のエンドポイントを取得

以上でPhantomBuster への接続を設定してユーザーを作成し、API Server でPhantomBuster データのAPI を追加しました。これで、OData 形式のPhantomBuster データをREST API で利用できます。API Server の「API」ページから、API のエンドポイントを表示およびコピーできます。

PhantomBuster のデータを取得する

「Tools」->「Script Editor」とクリックして、スプレッドシートからScript Editor を開きます。Script Editor で次の機能を追加し、スプレッドシートにOData クエリの結果を入力します。 


function retrieve(){
  var url = "https://MyUrl/api.rsc/Agents?select=Id,,,";
  var response = UrlFetchApp.fetch(url,{
    headers: {"Authorization":"Basic " + Utilities.base64Encode("MyUser:MyAuthtoken")}
  });
  var json = response.getContentText();
  var sheet = SpreadsheetApp.getActiveSheet();
  var a1 = sheet.getRange('a1');
  var index=1;
  var agents = JSON.parse(json).value;

  var cols = [["Id","","",""]];
  sheet.getRange(1,1,1,4).setValues(cols);

  row=2;
  for(var i in agents){
    for (var j in agents[i]) {
      switch (j) {
        case "Id":
          a1.offset(row,0).setValue(account[i][j]);
          break;
        case "":
          a1.offset(row,1).setValue(account[i][j]);
          break;
        case "":
          a1.offset(row,2).setValue(account[i][j]);
          break;
        case "":
          a1.offset(row,3).setValue(account[i][j]);
          break;
      }
    }
    row++;
  }
}

次のステップに従って、開いたタイミングでスプレッドシートに入力するインストール可能なトリガーを追加します。

  1. 「Resources」->「Current Project's Triggers」->「Add a New Trigger」とクリックします。
  2. 「Run」メニューで「retrieve」を選択します。
  3. 「From Spreadsheet」を選択します。
  4. 「On open」を選択します。

ダイアログを閉じると、アプリケーションへのアクセスを許可するように要求されます。

「Publish」->「Test as Add-On」とクリックすることで、スクリプトを確認できます。バージョン、インストールタイプ、およびスプレッドシートを選択し、テストの構成を作成します。作成したら、選択して実行できます。

はじめる準備はできましたか？

詳細はこちら、または無料トライアルにお申し込みください：

CData API Server

この記事の内容

関連記事