■ はじめに
https://dk521123.hatenablog.com/entry/2022/07/29/000000
の続き。 Adobe Analyticsの API について、調べてみた。
目次
【１】Adobe Analytics API 【２】API使用前の準備 【３】認証の仕方（Authentication） １）OAuth ２）JWT (JSON web token) 【４】API リファレンス １）Annotations ２）Calculated Metrics ３）Component Meta Data ４）Date Ranges ５）Dimensions ６）Metrics ７）Projects ８）Reports ９）Segments １０）Users １１）Usage Logs 【５】その他の事項 １）タイムアウト ２）APIコール制限 【６】APIコールする上で参考になりそうなサイト
【１】Adobe Analytics API
* Adobe Analytic が用意してくれるAPI
Adobe Analytics 2.0 APIs
https://developer.adobe.com/analytics-apis/docs/2.0/
【２】API使用前の準備
https://developer.adobe.com/analytics-apis/docs/2.0/guides/#permissions
より抜粋 Give a developer correct API permissions as a product profile admin: ~~~~ 1. Navigate to adminconsole.adobe.com. 2. Check the organization name in the top right to make sure that you are logged in to the correct company. 3. Click Products, then click Adobe Analytics. 4. Select the desired product profile, or create a new product profile. 5. Under the Permissions tab, assign the desired permissions to the product profile. 6. Once the desired permissions are set, click the Developers tab. 7. Click Add Developer, and enter the user name or email address that you want to assign the permissions to. 8. Click Save. ~~~~
【３】認証の仕方（Authentication）
https://developer.adobe.com/analytics-apis/docs/2.0/guides/#authentication
によると、以下の2通り。 ~~~~~~~~~ １）OAuth ２）JWT (JSON web token) ~~~~~~~~~
https://developer.adobe.com/developer-console/docs/guides/authentication/#types-of-authentication
１）OAuth
* 以下の公式ドキュメントを参照
https://developer.adobe.com/developer-console/docs/guides/authentication/OAuthIntegration/
より ~~~~~~~~ Step 1: Create a project in Adobe Developer Console Step 2: Add an API to your project using OAuth authentication and authorization Step 3: Try It Step 4: Integrate OAuth authentication in your application ~~~~~~~~
補足：OAuth(オーオース)とは？
* 以下の関連記事を参照のこと
https://dk521123.hatenablog.com/entry/2022/07/21/000000
２）JWT (JSON web token)
* 以下の公式ドキュメントを参照
https://developer.adobe.com/developer-console/docs/guides/authentication/ServiceAccountIntegration/
手順
https://developer.adobe.com/developer-console/docs/guides/authentication/ServiceAccountIntegration/#service-account-connection-workflow
より ~~~~~~~~ Step 1: Create a project in Adobe Developer Console Step 2: Add an API to your project using Service Account authentication Step 3: Try It ~~~~~~~~
補足：JWT (JSON web token)とは？
* 以下の関連記事を参照のこと
https://dk521123.hatenablog.com/entry/2022/07/20/000000
【４】API リファレンス
* 以下の公式ドキュメントを参照しながら実装していけばよさそう
https://developer.adobe.com/analytics-apis/docs/2.0/apis/
より抜粋 ~~~~~ １）Annotations ２）Calculated Metrics ３）Component Meta Data ４）Date Ranges ５）Dimensions ６）Metrics ７）Projects ８）Reports ９）Segments １０）Users １１）Usage Logs ~~~~~ => 以下の公式ドキュメントからのそれぞれのAPIの説明リンクが辿れる
https://developer.adobe.com/analytics-apis/docs/2.0/guides/endpoints/
１）Annotations
https://developer.adobe.com/analytics-apis/docs/2.0/guides/endpoints/annotations/
* Annotations (注釈) については、以下の公式ドキュメントを参照。
２）Calculated Metrics
https://developer.adobe.com/analytics-apis/docs/2.0/guides/endpoints/calculatedmetrics/
３）Component Meta Data
https://developer.adobe.com/analytics-apis/docs/2.0/guides/endpoints/componentmetadata/
４）Date Ranges
* Date Ranges (日付範囲) については、以下の公式ドキュメントを参照。
５）Dimensions
* Dimensions（ディメンション） については、以下の公式ドキュメントを参照。
https://experienceleague.adobe.com/docs/analytics/components/dimensions/overview.html?lang=jp
６）Metrics
* Metrics（指標） については、以下の公式ドキュメントを参照。
https://experienceleague.adobe.com/docs/analytics/components/metrics/overview.html?lang=jp
７）Projects
https://developer.adobe.com/analytics-apis/docs/2.0/guides/endpoints/projects/
８）Reports
https://developer.adobe.com/analytics-apis/docs/2.0/guides/endpoints/reports/
９）Segments
https://developer.adobe.com/analytics-apis/docs/2.0/guides/endpoints/segments/
１０）Users
* Users（ユーザ） については、以下の公式ドキュメントを参照。
https://helpx.adobe.com/jp/enterprise/using/users.html
１１）Usage Logs
https://developer.adobe.com/analytics-apis/docs/2.0/guides/endpoints/usage/
【５】その他の事項
https://developer.adobe.com/analytics-apis/docs/2.0/guides/faq/
１）タイムアウト
* 60 seconds
２）APIコール制限
* 12 requests every 6 seconds per user (or approximately 120 requests per minute)
【６】APIコールする上で参考になりそうなサイト
* Analytics 2.0 API を使用した同時視聴者の JSON レポートデータの取得した例
デモ（動画）
* 以下の動画で、APIコールしたデモが見れる。
https://experienceleague.adobe.com/docs/analytics-learn/tutorials/apis/using-analysis-workspace-to-build-api-2-requests.html?lang=ja
https://experienceleague.adobe.com/docs/analytics-learn/tutorials/exporting/report-builder/using-report-builder-to-learn-the-adobe-analytics-api.html?lang=ja
https://experienceleague.adobe.com/docs/analytics-learn/tutorials/apis/using-postman-to-make-adobe-analytics-2-0-api-requests.html?lang=ja
OAuth2認証の例
https://ex-ture.com/blog/2017/11/21/adobe-analytics-segmentapi/
JWT認証の例
https://ex-ture.com/blog/2020/12/03/adobeanalytics-adobeio-api-to-retrieve-saint-classification-data/
https://domohelp.domo.com/hc/ja/articles/360063205353-JWT%E8%AA%8D%E8%A8%BC%E3%81%A8%E3%83%91%E3%83%BC%E3%83%86%E3%82%A3%E3%82%B7%E3%83%A7%E3%83%B3%E3%82%92%E3%82%B5%E3%83%9D%E3%83%BC%E3%83%88%E3%81%99%E3%82%8BAdobe-Analytics-API-v2%E3%82%B3%E3%83%8D%E3%82%AF%E3%82%BF%E3%83%BC
Pythonでの例
https://developer.adobe.com/analytics-apis/docs/2.0/guides/use-cases/python/
https://qiita.com/dressmaker/items/1b11826763f19a23ef0f
https://qiita.com/fukunarihiroshi/items/bd6ed0fa19d8138770a1
関連記事
Adobe Analytics ～ 基礎知識編 ～
https://dk521123.hatenablog.com/entry/2022/07/29/000000
Adobe Analytics ～ 用語整理編 ～
https://dk521123.hatenablog.com/entry/2022/07/27/000000
Python ～ 基本編 / urllib ～
https://dk521123.hatenablog.com/entry/2022/08/05/000000
トークン認証 ～ JWT ～
https://dk521123.hatenablog.com/entry/2022/07/20/000000
トークン認証 ～ OAuth ～
https://dk521123.hatenablog.com/entry/2022/07/21/000000
