接続の確立
コネクタ内で利用可能なオブジェクトは、"cdata.adobeanalytics" モジュールからアクセスできます。モジュールのオブジェクトを直接使用するには：
- モジュールを以下のようにインポートします。
import cdata.adobeanalytics as mod
- 接続を確立するには、以下のような適切な接続文字列を使用してコネクタオブジェクトからconnect() メソッドを呼び出します。
mod.connect("InitiateOAuth=GETANDREFRESH;")
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 メソッドを使用することもできますが、このメソッドは2025年1月に廃止される予定であることに注意してください。Adobe は、継続的なアクセスを確保するために、Server-to-Server OAuth メソッドへの移行を推奨しています。
デスクトップアプリケーション
CData は、OAuth デスクトップ認証を簡略化する埋め込みOAuth アプリケーションを提供します。代わりに、カスタムOAuth アプリケーションを作成することも可能です。詳しくはカスタムOAuth アプリの作成 を参照してください。OAuth アクセストークンの取得およびリフレッシュ
接続するには次のプロパティを設定します。
- InitiateOAuth：GETANDREFRESH に設定すると、OAuth 交換の繰り返しや、手動でのOAuthAccessToken 設定を避けられます。
- OAuthClientId（カスタムアプリケーションのみ）：アプリの登録時に割り当てられたクライアントID に設定。
- OAuthClientSecret（カスタムアプリケーションのみ）：アプリの登録時に割り当てられたクライアントシークレットに設定。
- CallbackURL（カスタムアプリのみ）：アプリの登録時に定義されたリダイレクトURI に設定。例：https://localhost:3333
- 本製品 はAdobe Analytics からアクセストークンを取得し、それを使ってデータをリクエストします。
- OAuth 値はOAuthSettingsLocation で指定された場所に保存され、接続間で永続化されるようにします。
Web アプリケーション
Web アプリケーション経由で接続する場合は、Adobe Analytics にカスタムOAuth アプリケーションを登録する必要があります。それから本製品 を使用してOAuth トークンの値を取得および管理します。詳しくはカスタムOAuth アプリの作成 を参照してください。
OAuth アクセストークンの取得
次の接続プロパティを設定します。
- OAuthClientId：アプリケーション設定のクライアントId に設定。
- OAuthClientSecret：アプリケーション設定のクライアントシークレットに設定。
次に、ストアドプロシージャを使用してOAuth 交換を完了します。
- GetOAuthAuthorizationURL ストアドプロシージャを呼び出し、CallbackURL をアプリケーション設定で指定したRedirect URI に設定します。ストアドプロシージャがOAuth エンドポイントURL を返します。
- ステップ1でストアドプロシージャが返したURL に移動します。ログインして、Web アプリケーションを認可します。認証後、ブラウザはリダイレクトURI にリダイレクトします。リダイレクトURI に付加されるcode パラメータを控えておきます。
- GetOAuthAccessToken ストアドプロシージャを呼び出し、AuthMode インプットをWEB に設定します。Verifier インプットを、Step 2 で控えておいたcode パラメータに設定します。
アクセストークンとリフレッシュトークンを取得したのち、データに接続してOAuth アクセストークンを自動または手動でリフレッシュできます。
OAuth アクセストークンの自動リフレッシュ
本製品 がOAuth アクセストークンを自動的にリフレッシュするようにするには、最初のデータ接続で次のように設定します。
- InitiateOAuth：REFRESH に設定。
- OAuthClientId：アプリケーション設定のクライアントId に設定。
- OAuthClientSecret：アプリケーション設定のクライアントシークレットに設定。
- OAuthAccessToken：GetOAuthAccessToken によって返されたアクセストークンに設定。
- OAuthRefreshToken：GetOAuthAccessToken によって返されたリフレッシュトークンに設定。
- OAuthSettingsLocation：本製品 がOAuth 値を保存する場所に設定。これは接続間で維持されます。
OAuth アクセストークンの手動リフレッシュ
データ接続時に手動でOAuth アクセストークンをリフレッシュするために必要な値は、OAuth リフレッシュトークンのみです。 RefreshOAuthAccessToken ストアドプロシージャを使用して、GetOAuthAccessToken によって返されたExpiresIn パラメータ値が経過した後に手動でOAuthAccessToken をリフレッシュし、次の接続プロパティを設定します。
- OAuthClientId：アプリケーション設定のクライアントId に設定。
- OAuthClientSecret：アプリケーション設定のクライアントシークレットに設定。
次に、RefreshOAuthAccessToken を呼び出し、OAuthRefreshToken にGetOAuthAccessToken によって返されたOAuth リフレッシュトークンを指定します。新しいトークンが取得できたら、OAuthAccessToken プロパティにRefreshOAuthAccessToken によって返された値を設定し、新しい接続をオープンします。
最後に、OAuth リフレッシュトークンを保存し、OAuth アクセストークンの有効期限が切れた後に手動でリフレッシュできるようにします。
ヘッドレスマシン
ヘッドレスマシンのユーザーアカウントで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 設定ファイルの場所に設定。アクセストークンの自動リフレッシュを有効にするために、この場所が本製品 に読み書きのアクセス許可を与えることを確認してください。
サービスアカウント
サービスアカウントには、ブラウザによるユーザー認証が不要なサイレント認証があります。
このフローでは、アプリケーションを作成する必要があります。アプリケーションの作成および認可については、カスタムOAuth アプリの作成 を参照してください。これでサービスアカウントにアクセス権があるAdobe Analytics データに接続できます。
Server-to-Server OAuth
この方法で認証するには、AuthScheme をOAuthClient に設定します。
接続するには次のプロパティを設定します。
- InitiateOAuth：GETANDREFRESH に設定。
- OAuthClientId：アプリケーション設定のクライアントId に設定。
- OAuthClientSecret：アプリケーション設定のクライアントシークレットに設定。
接続すると、本製品 はサービスアカウントでのOAuth フローを完了します。
- クライアントクレデンシャルOAuth フローで指定されたOAuthClientId およびOAuthClientSecret を使用して、アクセストークンを取得します。
- OAuthSettingsLocation にOAuth 値を保存し、接続間で永続化されるようにします。
- トークンが期限切れになった際に、新しいアクセストークンを要求します。
JWT OAuth
この方法で認証するには、AuthScheme をOAuthJWT に設定します。
Note： OAuthJWT は現在AuthScheme としてサポートされていますが、サポートは2025年1月に終了します。Adobe は、継続的なアクセスを確保するために、Server-to-Server OAuth メソッドへの移行を推奨しています。
接続するには次のプロパティを設定します。
- InitiateOAuth：GETANDREFRESH に設定。
- 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 フローを完了します。
- 本製品 に要求されるクレームセットでJWT を作成し、サインします。
- JWT はアクセストークンと交換されます。
- OAuthSettingsLocation にOAuth 値を保存し、接続間で永続化されるようにします。
- トークンの期限が切れたときは、JWT を送り、新しいアクセストークンと交換します。