ディープリンクジェネレーター API
ディープリンクジェネレーターAPIは、TrueLink CoreおよびTrueLink Enterpriseプランをご契約のお客様にご利用いただけます。アップグレードをご希望の場合は、sales@adjust.comにお問い合わせください。
ディープリンクジェネレーター(Deep Link Generator、以下DLG)APIを使用すると、Adjustのディープリンクを自動で作成および管理することができます。Adjustダッシュボードでリンクを手動作成する代わりに、APIを使って、柔軟かつスケーラブルなリンク生成フローを構築できます。このワークフローは、個別リンクの作成にも、一括作成にも対応しています。
- 手動作業をなくし、APIによる自動生成でリンク作成をスケール
- CRMシステムやキャンペーン管理プラットフォームなどの既存のツールにディープリンク生成を実装
- 短いリンクや長いリンクを個別または一括で作成および管理
- 社内ユースケースに応じてカスタムのリンク生成ダッシュボードまたはスクリプトを構築
機能
DLG APIはAdjustのディープリンクジェネレーターと同じ機能を再現しており、リンク作成をプログラムで柔軟に制御できます。このAPIを使って、以下のことが可能です。
- 1回のリクエストで単一または複数のディープリンクを生成します。
- キャンペーンのニーズに応じて、短いリンクまたは長いリンクを作成できます。
- 既存のショートリンクのトークンを更新します。
- Adjustのオートメーションエンドポイントに直接接続するツールやワークフローを構築できます。
APIを使用することで、繰り返しのリンク作成プロセスを自動化し、キャンペーン計測の正確性と一貫性を維持できます。
ユースケース
仕組み
ディープリンクジェネレーターAPIは、AdjustのオートメーションエンドポイントへのHTTPSリクエストを使用します。全ての呼び出しは、既存のAdjust APIトークンを使用して承認されます。
エンドポイントの概要
- 単一のディープリンクを生成:POST
https://automate.adjust.com/engage/deep-links - ディープリンクを一括生成:POST
https://automate.adjust.com/engage/deep-links/bulk - ショートリンクトークンを更新:PUT
https://automate.adjust.com/engage/deep-links/{short_token} - ショートリンクデータを取得:GET
https://automate.adjust.com/engage/deep-links/short-link?short_token={short_token}&app_token={app_token}
開始方法
要件
- TrueLink CoreまたはTrueLink Enterpriseパッケージ
- iOSとAndroidの両方に対応する単一のブランドドメイン
- ディープリンクジェネレーターAPIへアクセス可能なAdjust APIトークン
設定の概要
- iOSおよびAndroidに対応するブランドドメインを設定します。
- Adjust APIトークンとリンクトークンを取得します。
- Adjustの開発者向けドキュメントに従って、APIコールを作成し、テストします。
- 自動化スクリプトやマクロを実装して、大量のリンクを生成できるようにします。
詳細については、ディープリンクジェネレーターAPIに関するAdjustの開発者向け公式ドキュメントを参照してください。
ベストプラクティス
- ショートリンクの解決処理との互換性を保つため、Adjust SDKを常に最新のバージョンに保ってください。
- レート制限の問題(最大で毎秒200リクエスト)を回避するため、大規模なキャンペーンには一括エンドポイントを使用してください。
- キャンペーンのメタデータをまとめて保存し、マクロまたはスクリプトでリンク作成を自動化してください。
- APIレスポンスを検証し、失敗したリクエストを再試行してください。
- リダイレクトの一貫性を維持するため、1つのブランドドメインを両方のプラットフォームで使用してください。
- APIトークンは秘密として扱い、セキュリティ確保のため定期的に入れ替えてください。
使用量のレポートとモニタリング
Deep Link Generator APIには、ショートリンク作成に関する利用制限が設けられています。Adjustダッシュボードおよび APIレスポンスを通じて、使用量をモニタリングすることができます。
ショートリンクの使用量
- ショートリンクの利用制限はアカウント単位で適用されます
- 制限は、生成された一意のショートトークンの数に基づいて設定されます
- 同一のリクエストに対しては既存のリンクが返されるため、使用量にはカウントされません
制限の対象となるもの
利用制限は、以下にのみ適用されます:
- API経由で作成されたショートリンク
利用制限は、以下には適用されません:
- ロングリンク
- ダッシュボード経由で作成されたショートリンク
Adjustダッシュボードでの使用量の確認
Adjust Suiteで使用量データを確認できます:
- アカウント設定(Account settings) に移動します
- プランと使用状況(Plan and usage) を選択します
このセクションには以下の情報が表示されます:
- ショートリンクの合計使用量
- 残りのショートリンクの数
- 連絡先情報
Datascapeで使用量データを確認したり、日付範囲を変更したり、アプリごとの使用量の内訳を確認したい場合は、こちらのダイレクトリンクもご利用いただけます
APIヘッダーから使用量を確認する
各APIレスポンスには、使用量および契約情報が記載されたヘッダーが含まれています。APIペイロードの構造について詳しくは、Developer Hubの「Deep Link Generator」ドキュメントをご確認ください
ヘッダーは以下の通りです:
x-shortlink-quota-limit
x-shortlink-quota-remaining
x-contract-status
x-contract-start-date
x-contract-end-date