接続の確立

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

インストールおよび接続

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

Install-Module SmartsheetCmdlets

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

Import-Module SmartsheetCmdlets;

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

$conn = Connect-Smartsheet -OAuthClientId 'MyOAuthClientId' -OAuthClientSecret 'MyOAuthClientSecret' -CallbackURL 'http://localhost:33333'

Smartsheet への接続

Smartsheet は、以下の認証メソッドによる接続をサポートしています。

個人用アクセストークンの使用

個人用アクセストークン

個人用トークンを使用して、自分のデータをテストし、アクセスします。個人用トークンを取得する方法は次のとおりです。

Smartsheet にログインします。
［アカウント］をクリックして［個人用の設定］を選択します。
［API アクセス］をクリックし、フォームを使用して新しいアクセストークンを生成するか、既存のアクセストークンを管理します。

AuthScheme をPersonalAccessToken に設定します。その後、PersonalAccessToken を生成したトークンに設定します。

Synch 接続

接続の前に、以下の変数を設定します。

OAuthClientId：カスタムOAuth アプリケーションの登録時に割り当てられたクライアントId。
OAuthClientSecret：カスタムOAuth アプリケーションの登録時に割り当てられたクライアントシークレット。

Smartsheet への接続 をクリックして、デフォルトブラウザでOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えます。

ドライバーは、以下のようにOAuth プロセスを完了します。

コールバックURL からアクセストークンを取得します。
古いトークンの期限が切れたときは、新しいアクセストークンを取得します。
OAuth 値を保存し、接続間で永続化します。

データの取得

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

$results = Select-Smartsheet -Connection $conn -Table "Sheet_Test_Sheet" -Columns @("Id, Name") -Where "Favorite='True'"

Invoke-Smartsheet cmdlet はSQL インターフェースを提供します。このcmdlet を使うと、Query パラメータを介してSQL クエリを実行できます。

cmdlet 出力のパイプ処理

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

Select-Smartsheet -Connection $conn -Table Sheet_Test_Sheet -Where "Favorite = 'True'" | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\mySheet_Test_SheetData.csv -NoTypeInformation

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

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

 
PS C:\> $conn  = Connect-Smartsheet -OAuthClientId 'MyOAuthClientId' -OAuthClientSecret 'MyOAuthClientSecret' -CallbackURL 'http://localhost:33333'
PS C:\> $row = Select-Smartsheet -Connection $conn -Table "Sheet_Test_Sheet" -Columns (Id, Name) -Where "Favorite = 'True'" | select -first 1
PS C:\> $row | ConvertTo-Json
{
  "Connection":  {

  },
  "Table":  "Sheet_Test_Sheet",
  "Columns":  [

  ],
  "Id":  "MyId",
  "Name":  "MyName"
}

データの削除

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

Select-Smartsheet -Connection $conn -Table Sheet_Test_Sheet -Where "Favorite = 'True'" | Remove-Smartsheet

データの変更

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

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

Cmdlets for Smartsheet