接続の確立
CData Cmdlets ユーザーは、データモジュールをインストールし、接続プロパティを設定してスクリプトを開始できます。このセクションでは、CSV インポートおよびエクスポートcmdlet などのネイティブPowerShell cmdlet でAdobeAnalytics Cmdlets を使用する例を示します。
インストールおよび接続
PSGet がある場合は、PowerShell Gallery から次のコマンドを使ってcmdlet をインストールできます。CData サイトからセットアップを取得することもできます。
Install-Module AdobeAnalyticsCmdlets
プロファイルに以下を追加すると、次のセッションでcmdlet がロードされます。
Import-Module AdobeAnalyticsCmdlets;
Connect-AdobeAnalytics cmdlet を使って、別のcmdlet に渡すことができる接続オブジェクトを作成します。
$conn = Connect-AdobeAnalytics -OAuthClientId "myOauthClientId" -OauthClientSecret "myOAuthClientSecret" -CallbackURL "myCallbackURL"
Adobe Analytics への接続
Adobe Analytics に接続するには、GlobalCompanyId、およびRSID が識別される必要があります。デフォルトで、本製品 は自動的に会社とレポートスイートの識別を試みます。代わりに、会社とレポートスイートを明示的に指定することもできます。
Global Company Id
GlobalCompanyId はオプションの接続プロパティです。空のままにすると、本製品 が自動的にGlobal Company ID の検出を試みます。 Global Company ID を見つけるには:
- Swagger UI 上のusers/me エンドポイントのリクエストURL で見つけます。
- ユーザーエンドポイントを展開し、GET users/me ボタンをクリックします。
- [Try it out]ボタン ->[Execute]ボタンをクリックします。
- GlobalCompanyId 接続プロパティを、リクエストURL のusers/me エンドポイントの直前に表示されるGlobal Company ID に設定します。
Report Suite Id
RSID はオプションの接続プロパティです。設定されていない場合、ドライバーが自動的に検出を試みます。名前の横にある識別子とともにレポートスイートの完全なリストを取得するには、[管理者]->[レポートスイート]に進みます。
Adobe Analytics への認証
Adobe Analytics はOAuth 認証標準を利用しています。 OAuth 統合またはサービスアカウント統合で認証できます。
ユーザーアカウント(OAuth)
AuthScheme は、すべてのユーザーアカウントフローでOAuth に設定する必要があります。
NOTE: OAuth 経由のAdobe 認証では、2週間ごとにリフレッシュトークンを更新する必要があります。代わりにOAuthJWT を使用することを推奨します。
デスクトップアプリケーション
CData は、OAuth デスクトップ認証を簡略化する埋め込みOAuth アプリケーションを提供します。代わりに、カスタムOAuth アプリケーションを作成することも可能です。カスタムアプリケーションの作成およびその理由については、カスタムOAuth アプリの作成 を参照してください。OAuth アクセストークンの取得およびリフレッシュ
以下を設定して、接続してください。
- OAuthClientId(カスタムアプリのみ):アプリの登録時に割り当てられたクライアントId に設定。
- OAuthClientSecret(カスタムアプリのみ):アプリの登録時に割り当てられたクライアントシークレットに設定。
- CallbackURL(カスタムアプリのみ):アプリの登録時に定義されたリダイレクトURI に設定。例:https://localhost:3333
ヘッドレスマシン
ヘッドレスマシンのユーザーアカウントでOAuth を使用するようにドライバーを設定するには、インターネットブラウザに対応した別の端末で認証する必要があります。
- 以下のオプションから選択します。
- オプション1:後述の「Verifier code を取得および交換」に従い、OAuthVerifier 値を取得します。
- オプション2:インターネットブラウザに対応したマシンに本製品 をインストールし、後述の「OAuth 設定を転送」の説明に従い、通常のブラウザベースのフローで認証後にOAuth 認証値を転送します。
- 次に、ヘッドレスマシンからアクセストークンを自動的にリフレッシュするように本製品 を設定します。
オプション1:Verifier code を取得および交換
Verifier code を取得するには、OAuth Authorization URL で認証する必要があります。
インターネットブラウザに対応したマシンから認証してOAuthVerifier 接続プロパティを取得する方法は次のとおりです。
- 以下のオプションから選択します。
- 埋め込みOAuth アプリケーションを使用する場合は、GetOAuthAuthorizationURL ストアドプロシージャを呼び出します。ストアドプロシージャによって返されたURL をブラウザで開きます。
- カスタムOAuth アプリケーションを使用するには、以下のプロパティを設定します。
- InitiateOAuth:OFF に設定。
- OAuthClientId:アプリケーションの登録時に割り当てられたクライアントId に設定。
- OAuthClientSecret:アプリケーションの登録時に割り当てられたクライアントシークレットに設定。
- ログインして、本製品 にアクセス許可を与えます。すると、リダイレクトURI にリダイレクトされます。リダイレクトURI にはcode というパラメータが付加されます。このパラメータの値を控えておきます。後ほどこれをOAuthVerifier 接続プロパティに設定します。
ヘッドレスマシンでは、次の接続プロパティを設定してOAuth 認証値を取得します。
- InitiateOAuth:REFRESH に設定。
- OAuthVerifier:これを、控えておいたverifier code(リダイレクトURI のcode パラメータの値)に設定します。
- OAuthClientId(カスタムアプリのみ):カスタムOAuth アプリケーション設定のクライアントId に設定。
- OAuthClientSecret(カスタムアプリのみ):カスタムOAuth アプリケーション設定のクライアントシークレットに設定。
- OAuthSettingsLocation:これを設定すると、暗号化されたOAuth 認証値が指定された場所に永続化されます。
接続をテストしてOAuth 設定ファイルを生成し、以下のプロパティを再設定して接続します。
- InitiateOAuth:REFRESH に設定。
- OAuthClientId:(カスタムアプリのみ)アプリケーションの登録時に割り当てられたクライアントId に設定。
- OAuthClientSecret:(カスタムアプリのみ)アプリケーションの登録時に割り当てられたクライアントシークレットに設定。
- OAuthSettingsLocation:暗号化されたOAuth 認証値が保存される場所に設定。アクセストークンの自動リフレッシュを有効にするために、この場所が本製品 に読み書きのアクセス許可を与えることを確認してください。
オプション2:OAuth 設定を転送
ヘッドレスマシンでの接続に先立ち、インターネットブラウザに対応したデバイスでドライバとの接続をインストールし、作成する必要があります。上述の「デスクトップアプリケーション」の説明に従って、接続プロパティを設定します。
「デスクトップアプリケーション」の手順が完了すると、生成された認証値は、OAuthSettingsLocation で指定された場所に暗号化されて書き込まれます。デフォルトのファイル名はOAuthSettings.txt です。
接続をテストしてOAuth 設定ファイルを生成し、OAuth 設定ファイルをヘッドレスマシンにコピーします。
ヘッドレスマシンで、次の接続プロパティを設定し、データに接続します。
- InitiateOAuth:REFRESH に設定。
- OAuthClientId:(カスタムアプリのみ)アプリケーションの登録時に割り当てられたクライアントId に設定。
- OAuthClientSecret:(カスタムアプリのみ)アプリケーションの登録時に割り当てられたクライアントシークレットに設定。
- OAuthSettingsLocation:ブラウザでマシンからコピーしたOAuth 設定ファイルの場所に設定。アクセストークンの自動リフレッシュを有効にするために、この場所が本製品 に読み書きのアクセス許可を与えることを確認してください。
サービスアカウント(JWT OAuth)
この方法で認証するには、AuthScheme をOAuthJWT に設定します。
サービスアカウントには、ブラウザによるユーザー認証が不要なサイレント認証があります。
このフローでは、アプリケーションを作成する必要があります。アプリの作成および認可については、カスタムOAuth アプリの作成 を参照してください。これでサービスアカウントにアクセス権があるAdobe Analytics データに接続できます。
次の接続プロパティを設定して、接続してください。
- OAuthClientId:アプリケーション設定のクライアントId に設定。
- OAuthClientSecret:アプリケーション設定のクライアントシークレットに設定。
- OAuthJWTCertType:"PUBLIC_KEY_FILE" に設定。
- OAuthJWTCert:生成した.key ファイルのパスに設定。
- OAuthJWTCertPassword:.key ファイルのパスワードに設定。
- OAuthJWTIssuer:Adobe I / O コンソール統合からのOrganization ID に設定。形式はorg_ident@AdobeOrg です。Adobe I / O API へのアクセス用に設定された組織を識別します。
接続すると、本製品 はサービスアカウントでのOAuth フローを完了します。
データの取得
Select-AdobeAnalytics cmdlet はデータを取得するためのネイティブなPowerShell インターフェースを提供します。
$results = Select-AdobeAnalytics -Connection $conn -Table "SampleTable_1" -Columns @("Id, Column1") -Where "Column2='Bob'"Invoke-AdobeAnalytics cmdlet はSQL インターフェースを提供します。このcmdlet を使うと、Query パラメータを介してSQL クエリを実行できます。
cmdlet 出力のパイプ処理
cmdlet は行オブジェクトをパイプラインに一度に一行ずつ返します。以下は、結果をCSV ファイルにエクスポートします。
Select-AdobeAnalytics -Connection $conn -Table SampleTable_1 -Where "Column2 = 'Bob'" | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\mySampleTable_1Data.csv -NoTypeInformation
Select-AdobeAnalytics からの結果をSelect-Object cmdlet にパイプして、Export-CSV cmdlet にパイプする前にいくつかのプロパティを実行していることがわかるでしょう。これをする理由は、CData Cmdlets は接続、テーブル、およびカラムの情報を結果セットの各行オブジェクトに追加しますが、必ずしもその情報がCSV ファイルに必要ではないからです。
ただし、これによってcmdlet の出力を別のcmdlet にパイプすることが容易になります。以下に、結果セットをJSON に変換する例を示します。
PS C:\> $conn = Connect-AdobeAnalytics -OAuthClientId "myOauthClientId" -OauthClientSecret "myOAuthClientSecret" -CallbackURL "myCallbackURL" PS C:\> $row = Select-AdobeAnalytics -Connection $conn -Table "SampleTable_1" -Columns (Id, Column1) -Where "Column2 = 'Bob'" | select -first 1 PS C:\> $row | ConvertTo-Json { "Connection": { }, "Table": "SampleTable_1", "Columns": [ ], "Id": "MyId", "Column1": "MyColumn1" }