Cmdlets for Twitter

Build 23.0.8839

接続の確立

CData Cmdlets ユーザーは、データモジュールをインストールし、接続プロパティを設定してスクリプトを開始できます。このセクションでは、CSV インポートおよびエクスポートcmdlet などのネイティブPowerShell cmdlet でTwitter Cmdlets を使用する例を示します。

インストールおよび接続

PSGet がある場合は、PowerShell Gallery から次のコマンドを使ってcmdlet をインストールできます。CData サイトからセットアップを取得することもできます。 

Install-Module TwitterCmdlets

プロファイルに以下を追加すると、次のセッションでcmdlet がロードされます。 

Import-Module TwitterCmdlets;

Connect-Twitter cmdlet を使って、別のcmdlet に渡すことができる接続オブジェクトを作成します。 

$conn = Connect-Twitter

Twitter への接続（OAuth）

NOTE： どのバージョンのOAuth を使用するかは、アクセスしたいテーブルやビューによって異なります。StreamRules テーブルおよびTweetStream ビューの場合は、OAuth 2.0 App-Only を使用する必要があります。その他のテーブルおよびビューの場合は、OAuth 1.1 を使用します。

OAuth 2.0 App-Only（ベアラートークン）

StreamRules テーブルまたはTweetStream ビューの接続を確立するには、OAuth 2.0 App-Only 認証を使用する必要があります。

まず、Twitter のウェブサイトでベアラートークンを生成します。YourBearerToken の値は、Twitter のDeveloper Portal > ProjectOfInterest > Keys and Tokens で生成されます。詳しくは、Twitter 開発者プラットフォームドキュメント を参照してください。

トークンの生成と以下の設定が完了したら、接続の準備は完了です。

  • InitiateOAuth：OFF に設定。
  • OAuthAccessToken：YourBearerToken の値に設定。

その他のテーブルやビュー（StreamRules とTweetStream 以外）にアクセスする場合は、以下のOAuth 1.1 の手順に従います。

OAuth 1.1

デスクトップアプリケーション

ユーザー資格情報の接続プロパティを設定せずに接続できます。または、カスタムOAuth アプリケーションを作成することも可能です。カスタムOAuth アプリケーションについて詳しくは、カスタムOAuth アプリの作成 を参照してください。

2つの違いは、カスタムアプリケーションを使用する場合は追加の接続プロパティを設定する必要があることだけです。

以下を設定して、接続してください。

  • OAuthClientId（カスタムアプリのみ）：アプリ設定のコンシューマーキーに設定。
  • OAuthClientSecret（カスタムアプリのみ）：アプリケーション設定のコンシューマーシークレットに設定。
接続すると、本製品 はデフォルトブラウザでOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えます。本製品 がOAuth プロセスを完了します。

ヘッドレスマシン

ヘッドレスマシンのユーザーアカウントでOAuth を使用するようにドライバーを設定するには、インターネットブラウザに対応した別の端末で認証する必要があります。

  1. 以下のオプションから選択します。
    • オプション1：後述の「Verifier code を取得および交換」に従い、OAuthVerifier 値を取得します。
    • オプション2：インターネットブラウザに対応したマシンに本製品 をインストールし、後述の「OAuth 設定を転送」の説明に従い、通常のブラウザベースのフローで認証後にOAuth 認証値を転送します。
  2. 次に、ヘッドレスマシンからアクセストークンを自動的にリフレッシュするように本製品 を設定します。

オプション1：Verifier code を取得および交換

Verifier code を取得するには、OAuth Authorization URL で認証する必要があります。

インターネットブラウザに対応したマシンから認証してOAuthVerifier 接続プロパティを取得する方法は次のとおりです。

  1. 以下のオプションから選択します。
    • 埋め込みOAuth アプリケーションを使用する場合は、GetOAuthAuthorizationURL ストアドプロシージャを呼び出します。ストアドプロシージャによって返されたURL をブラウザで開きます。
    • カスタムOAuth アプリケーションを使用するには、以下のプロパティを設定します。
      • InitiateOAuth：OFF に設定。
      • OAuthClientId：アプリ設定のクライアントId に設定。
      • OAuthClientSecret：アプリ設定のクライアントシークレットに設定。
      次に、CallbackURL 入力パラメータを、アプリ設定で指定した正確なリダイレクトURI に設定して、GetOAuthAuthorizationURL ストアドプロシージャを呼び出します。ストアドプロシージャによって返されたURL をブラウザで開きます。
  2. ログインして、本製品 にアクセス許可を与えます。すると、verifier code を含むコールバックURL にリダイレクトされます。verifier code の値を保存します。後ほどこれをOAuthVerifier 接続プロパティに設定します。
次に、OAuth verifier code をOAuth リフレッシュトークンおよびアクセストークンと交換する必要があります。

ヘッドレスマシンでは、次の接続プロパティを設定してOAuth 認証値を取得します。

  • InitiateOAuth：REFRESH に設定。
  • OAuthVerifier：控えておいたverifier code（リダイレクトURI のcode パラメータの値）に設定。
  • OAuthClientId：（カスタムアプリケーションのみ）OAuth アプリ設定にあるApp key の値に設定。
  • OAuthClientSecret：（カスタムアプリケーションのみ）OAuth アプリ設定のApp secret に設定。
  • AuthToken：GetOAuthAuthorizationURL ストアドプロシージャによって返された認証トークンに設定。
  • AuthKey：GetOAuthAuthorizationURL ストアドプロシージャによって返された認証キーに設定。
  • OAuthSettingsLocation：これを設定すると、暗号化されたOAuth 認証値が指定された場所に永続化されます。

接続をテストしてOAuth 設定ファイルを生成し、以下のプロパティを再設定して接続します。

  • InitiateOAuth：REFRESH に設定。
  • OAuthClientId：（カスタムアプリケーションのみ）OAuth アプリ設定にあるApp key の値に設定。
  • OAuthClientSecret：（カスタムアプリケーションのみ）OAuth アプリ設定のApp secret に設定。
  • OAuthSettingsLocation：暗号化されたOAuth 認証値を含む場所に設定。アクセストークンの自動リフレッシュを有効にするために、この場所が本製品 に読み書きのアクセス許可を与えることを確認してください。

オプション2：OAuth 設定を転送

ヘッドレスマシンでの接続に先立ち、インターネットブラウザに対応したデバイスでドライバーとの接続をインストールし、作成する必要があります。上述の「デスクトップアプリケーション」の説明に従って、接続プロパティを設定します。

「デスクトップアプリケーション」の手順が完了すると、生成された認証値は、OAuthSettingsLocation で指定された場所に暗号化されて書き込まれます。デフォルトのファイル名はOAuthSettings.txt です。

接続をテストしてOAuth 設定ファイルを生成し、OAuth 設定ファイルをヘッドレスマシンにコピーします。

ヘッドレスマシンで、次の接続プロパティを設定し、データに接続します。

  • InitiateOAuth：REFRESH に設定。
  • OAuthClientId：（カスタムアプリケーションのみ）OAuth アプリ設定にあるApp key の値に設定。
  • OAuthClientSecret：（カスタムアプリケーションのみ）OAuth アプリ設定のApp secret に設定。
  • OAuthSettingsLocation：ブラウザでマシンからコピーしたOAuth 設定ファイルの場所に設定。アクセストークンの自動リフレッシュを有効にするために、この場所が本製品 に読み書きのアクセス許可を与えることを確認してください。

データの取得

Select-Twitter cmdlet はデータを取得するためのネイティブなPowerShell インターフェースを提供します。 

$results = Select-Twitter -Connection $conn -Table "Tweets" -Columns @("From_User_Name, Text") -Where "From_User_Name='twitter'"
Invoke-Twitter cmdlet はSQL インターフェースを提供します。このcmdlet を使うと、Query パラメータを介してSQL クエリを実行できます。

cmdlet 出力のパイプ処理

cmdlet は行オブジェクトをパイプラインに一度に一行ずつ返します。以下は、結果をCSV ファイルにエクスポートします。 

Select-Twitter -Connection $conn -Table Tweets -Where "From_User_Name = 'twitter'" | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myTweetsData.csv -NoTypeInformation

Select-Twitter からの結果をSelect-Object cmdlet にパイプして、Export-CSV cmdlet にパイプする前にいくつかのプロパティを実行していることがわかるでしょう。これをする理由は、CData Cmdlets は接続、テーブル、およびカラムの情報を結果セットの各行オブジェクトに追加しますが、必ずしもその情報がCSV ファイルに必要ではないからです。

ただし、これによってcmdlet の出力を別のcmdlet にパイプすることが容易になります。以下に、結果セットをJSON に変換する例を示します。 

 
PS C:\> $conn  = Connect-Twitter
PS C:\> $row = Select-Twitter -Connection $conn -Table "Tweets" -Columns (From_User_Name, Text) -Where "From_User_Name = 'twitter'" | select -first 1
PS C:\> $row | ConvertTo-Json
{
  "Connection":  {

  },
  "Table":  "Tweets",
  "Columns":  [

  ],
  "From_User_Name":  "MyFrom_User_Name",
  "Text":  "MyText"
}

データの削除

以下は、抽出条件に合うあらゆるレコードを削除します。 

Select-Twitter -Connection $conn -Table Tweets -Where "From_User_Name = 'twitter'" | Remove-Twitter

データの変更

cmdlet はデータクレンジング同様、データの変換を容易にします。次の例は、レコードがすでに存在するかどうか、挿入する前に更新が必要かどうかをチェックしてから、CSV ファイルのデータをTwitter にロードします。 

Import-Csv -Path C:\MyTweetsUpdates.csv | %{
  $record = Select-Twitter -Connection $conn -Table Tweets -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-Twitter -Connection $conn -Table Tweets -Columns @("From_User_Name","Text") -Values @($_.From_User_Name, $_.Text) -Where "Id  = `'$_.Id`'"
  }else{
    Add-Twitter -Connection $conn -Table Tweets -Columns @("From_User_Name","Text") -Values @($_.From_User_Name, $_.Text)
  }
}

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 23.0.8839