Cmdlets for Gmail

Build 20.0.7654

接続の確立

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

インストールおよび接続

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

Install-Module GmailCmdlets

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

Import-Module GmailCmdlets;

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

$conn = Connect-Gmail -User 'MyUser' -Password 'MyPassword'

Gmail に接続する方法は2つあります。ログインクレデンシャルを使うか、OAuth を使うかです。まず、IMAP 経由のGmail へのクライアントアクセスを有効にする必要があります。

REST スキーマ

OAuth 認証

Gmail への接続には、OAuth 認証標準を使います。ユーザーアカウントを使用して認証できます。

ユーザーアカウントで認証する

このアプローチは、他のユーザーが本製品 経由でデータにアクセスする場合に適しています。Password を設定する代わりにOAuth 認証標準を使用できます。

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

  • User:Gmail アカウントのユーザーに設定。
接続すると、本製品 はデフォルトブラウザでOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えます。本製品 がOAuth プロセスを完了します。

その他のOAuth 認証フローについては、OAuth 認証の使用 を参照してください。

IMAP スキーマ

IMAP の有効化

本製品 は、IMAP プロトコル経由でGmail と通信します。 IMAP を使用すると、すべてのクライアントデバイスで個々のコピーではなく、同じリモートデータを使用できます。以下の手順に従って、IMAP 経由のGmail へのアクセスを有効にします。

  1. Gmail Web インターフェースを開き、[設定]ボタン(歯車のアイコン)をクリックします。
  2. [Forwarding and POP/IMAP]タブで[Enable IMAP]を選択します。
  3. 変更を保存します。

ログイン認証

このアプローチは、自分のデータにアクセスする場合に適しています。Authentication セクションのUser プロパティとPassword プロパティに、有効なGmail ユーザー資格情報を設定します。

OAuth 認証

Gmail への接続には、OAuth 認証標準を使います。ユーザーアカウントまたはサービスアカウントで認証できます。組織全体のアクセススコープを本製品 に許可するには、サービスアカウントが必要です。下記で説明するとおり、本製品 はこれらの認証フローをサポートします。

ユーザーアカウントで認証する

このアプローチは、他のユーザーが本製品 経由でデータにアクセスする場合に適しています。Password を設定する代わりにOAuth 認証標準を使用できます。

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

  • User:Gmail アカウントのユーザーに設定。
接続すると、本製品 はデフォルトブラウザでOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えます。本製品 がOAuth プロセスを完了します。

その他のOAuth 認証フローについては、[はじめに]セクションのOAuth 認証の使用 を参照してください。

サービスアカウントで認証する

サービスアカウントには、ブラウザによるユーザー認証なしのサイレント認証があります。また、サービスアカウントを使用して、エンタープライズ全体のアクセススコープを本製品 に委任することもできます。

このフローでは、OAuth アプリケーションを作成する必要があります。アプリの作成および認可については、[はじめに]セクションのカスタムOAuth アプリの作成 を参照してください。これでサービスアカウントにアクセス権があるGmail データに接続できます。

次の接続プロパティを設定して、接続してください。

  • OAuthJWTCertType:"PFXFILE" に設定。
  • OAuthJWTCert:生成した.p12ファイルのパスに設定。
  • OAuthJWTCertPassword:.p12ファイルのパスワードに設定。
  • OAuthJWTCertSubject:"*" に設定すると、証明書ストアの1番目の証明書が選択されます。
  • OAuthJWTSubject:アクセスの委譲を要求しているアプリケーションのユーザーのE メールアドレスを設定。管理者がアクセス委譲を承認しなければならないので、ご注意ください。
  • User:接続するGmail アカウントのユーザーに設定。
接続すると、本製品 はサービスアカウントでのOAuth フローを完了します。

データの取得

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

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

cmdlet 出力のパイプ処理

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

Select-Gmail -Connection $conn -Table Inbox -Where "From = 'test@test.com'" | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myInboxData.csv -NoTypeInformation

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

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

 
PS C:\> $conn  = Connect-Gmail -User 'MyUser' -Password 'MyPassword'
PS C:\> $row = Select-Gmail -Connection $conn -Table "Inbox" -Columns (Id, MessageBody) -Where "From = 'test@test.com'" | select -first 1
PS C:\> $row | ConvertTo-Json
{
  "Connection":  {

  },
  "Table":  "Inbox",
  "Columns":  [

  ],
  "Id":  "MyId",
  "MessageBody":  "MyMessageBody"
} 

データの削除

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

Select-Gmail -Connection $conn -Table Inbox -Where "From = 'test@test.com'" | Remove-Gmail

データの更新

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

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

Copyright (c) 2020 CData Software, Inc. - All rights reserved.
Build 20.0.7654