レポート API
概要
Rokt レポート API は、広告主やパートナーが Rokt プラットフォームからパフォーマンスデータを取得し、自分たちのレポートやダッシュボードを作成できるようにします。これは HTTP ベースの API で、プログラム的にクエリを実行し、Rokt データを外部のビジネスアプリケーションに統合するために使用できます。この API は、HTTP リクエストを行うことができる任意の言語で動作します。ほとんどのリクエストは https://api.rokt.com ホスト URL に送信されます。
データを安全かつセキュアに保つために、Rokt レポート API はアクセス トークンを使用してリクエストを認証します。アクセス トークンにより、Rokt はクライアント アプリケーションとアクセスされるデータの種類を識別し、悪意のあるアプリがアクセスすべきでないデータにアクセスするのを防ぐことができます。
API への認証は OAuth 2.0 を介して行われます。API コールを成功させるには、App ID と App Secret を使用してアクセス トークンを取得する必要があります。認証なしの API リクエストは失敗します。Rokt レポート API は、ユーザー資格情報がアクセスできるアカウントからのみデータを取得できます。
バージョン
APIのアルファリリースバージョンを使用するアーリーアダプターのために、APIリクエストヘッダーに "rokt-version":"alpha-20200701" を使用して、可能な限り破壊的変更を最小限に抑えるようにしてください。rokt-version ヘッダーが使用されていない場合、エンドポイントリクエストは常にRokt Reporting APIの LATEST バージョンを指します。
認証
Rokt Reporting APIは、クライアント統合にOAuth 2.0アプローチを活用しています。詳細については、OAuth 2.0 Credentials Flow を参照してください。Rokt Reporting APIにアクセスするには、Rokt App IDとApp Secretを使用する必要があります。
App IDとApp Secretを生成する手順は以下に説明されています。同じ手順でRokt Event APIの資格情報を生成できます。
これらのクライアントアプリの資格情報をRRESTとのやり取りで使用する必要があります。
アプリIDとアプリシークレットの生成
my.rokt.comでOne Platformにサインインします。
左下のアカウントアイコンの下にあるプロフィール設定に移動します。
個人用API資格情報の生成セクションまでスクロールします。
アプリの名前を入力します。
生成をクリックします。
レポートAPIとイベントAPIの資格情報がすぐに生成され、次のようになります:
AppId: "40svbin0d194subpohl079rhck"
AppSecret: "1dimhvr1v6skae9uhvtgs3chs2astnjf0469df6ul9hurubtoovn"アプリIDとアプリシークレットを安全な場所に保管してください。このセッションの後はアプリシークレットにアクセスできなくなります。
これらの資格情報はすぐに使用できます。
資格情報は機密情報として扱い、アカウントを保護するために決してメールで送信しないでください。Roktからの問い合わせであっても、組織外に共有しないでください。Roktを正当に代表する者がアプリシークレットを尋ねることは決してありません。
アクセストークンの取得
Rokt Reporting API のエンドポイントを呼び出すにはアクセストークンが必要です。アクセストークンは、Rokt がクライアントアプリを識別し、各クライアントアプリがアクセスするデータの種類を特定し、悪意のあるアプリがアクセス権のないデータにアクセスするのを防ぐために使用されます。
API への認証は OAuth 2.0 を介して行われます。API 呼び出しを成功させるには、App ID と App Secret を使用してアクセストークンを取得し、すべての API 呼び出しで使用する必要があります。App ID と App Secret は、上記の説明に従って One Platform の Profile Settings ページで生成できます。
認証なし、または不正な認証での API リクエストは失敗します。API は 400 または 403 エラーコードを返します。Rokt Reporting API からは、ユーザー資格情報がアクセスできるアカウントのデータのみを取得できます。
アクセストークンは、前のステップで作成した App ID と App Secret に基づいて生成されます。アクセストークンは 1 時間有効です。その 1 時間の間に、アクセストークンを使用して Rokt Reporting API のすべてのエンドポイントを呼び出すことができます。有効期限が切れる前に、クライアントアプリの資格情報に基づいてアクセストークンを再生成する必要があります。
アクセストークンを取得するために、Rokt Reporting API にはエンドポイントが公開されています:
POST https://api.rokt.com/auth/oauth2/token
ヘッダー内のリクエストパラメータ
| キー | 場所 | 説明 | 必須? | 例 |
|---|---|---|---|---|
Authorization | header | app_id と app_secret は Basic HTTP 認証を通じて認証ヘッダーに渡される必要があり、One Platform の Profile Settings で生成できます。ヘッダーの内容は Basic base64encode(app_id:app_secret) です。 | はい | Basic base64encocde(12345:abcde) |
Content-Type | header | リクエストのメディアタイプは常に application/x-www-form-urlencoded でなければなりません。 | はい | application/x-www-form-urlencoded |
ボディ内のリクエストパラメータ
| キー | 場所 | 説明 | 必須? | 例 |
|---|---|---|---|---|
grant_type | body | client_credentials でなければなりません。 | はい | client_credentials |
成功したリクエストの例
サンプルリクエスト:
POST https://api.rokt.com/auth/oauth2/token&
Content-Type='application/x-www-form-urlencoded'&
Authorization=Basic xxx
grant_type=authorization_code
サンプルレスポンス:
{
"access_token": "eyJraWQiOiJPVUpHT1RjM09FWXROakkzUlMwME5UUkJMVGxCTkRrdFJqWXdOVVV3UkRNNE1FTTJDZz09IiwiYWxnIjoiSFMyNTYifQ.eyJzdWIiOiJkZW1vIiwidG9rZW5fdXNlIjoiYWNjZXNzIiwic2NvcGUiOiJyZXBvcnQtYXBpL3JlYWQtcmVwb3J0LWFwaSIsImF1dGhfdGltZSI6MTU4NTExMDA0MSwiaXNzIjoiaHR0cHM6Ly9jb2duaXRvLWlkcC51cy13ZXN0LTIuYW1hem9uYXdzLmNvbS91cy13ZXN0LTJfZG93Tlp1elRYIiwiZXhwIjoxNTg1MTEzNjQxLCJpYXQiOjE1ODUxMTAwNDEsInZlcnNpb24iOjIsImp0aSI6IkYwNzY5RDVDLTRDNTAtNDVDOC04OTcyLTI4MkUwODlDMkFFOSIsImNsaWVudF9pZCI6ImRlbW8ifQ.NOJIx7qLHFVXqKNZfJKsJlwitOvbHOLdknQ\_D33WjYe8O9ZE08t7LFgs7ANiwBicN5ejmdS7iND0cth5ViUWK5MKZxvLKI6dPG5RljegfpZJtGKqDT\_MFfpayvcOlkkZc5yRw9Bcgz\_fW2ha7q6BGRsUb-e9DZ0Pcb5zL\_HbRLbnvlhYCYi9rPmYOYG6BronvLwB8sg2kVubLQGn\_ASbK\_FW8bKPhqH4BL2\_JunGBzUKJPL9yNvOnFy7VKwlvH1OKUqKlCYbewOtUd1utcMNIb\_AbSGRtzJKslbE5VwQtL5bZ34kOCNH07gSolSGvqqw4dyxU4l0QSVXVmqgVYdKfA",
"expires_in": 3600,
"token_type": "Bearer"
}
API エンドポイント
API エンドポイントの呼び出し
前のステップで取得したアクセストークンを使用して、Rokt Reporting API のエンドポイントを呼び出すことができます。トークンは Authorization ヘッダーに Bearer トークンとして送信する必要があることに注意してください。
API リクエストのサンプル:
GET https://api.rokt.com/reporting/performance-reports/partner/1/stats?dateStart=2020-02-05&dateEnd=2020-02-12&
Authorization=Bearer "eyJraWQiOiJNMDJyQmZzT3pNKzRVMjhHRjVuaDdIREphWlIwaytDMlwvNFl5dXYxZ2N0ST0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0MHN2YmluMGQxOTRzdWJwb2hsMDc5cmhjayIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoicmVwb3J0LWFwaVwvcmVhZC1yZXBvcnQtYXBpIiwiYXV0aF90aW1lIjoxNTg1MTEwMDQxLCJpc3MiOiJodHRwczpcL1wvY29nbml0by1pZHAudXMtd2VzdC0yLmFtYXpvbmF3cy5jb21cL3VzLXdlc3QtMl9kb3dOWnV6VFgiLCJleHAiOjE1ODUxMTM2NDEsImlhdCI6MTU4NTExMDA0MSwidmVyc2lvbiI6MiwianRpIjoiZDFlNjgyMDYtNWVlNy00NThjLTkwODYtZjAwYjhiMjEzYjJhIiwiY2xpZW50X2lkIjoiNDBzdmJpbjBkMTk0c3VicG9obDA3OXJoY2sifQ.NOJIx7qLHFVXqKNZfJKsJlwitOvbHOLdknQ\_D33WjYe8O9ZE08t7LFgs7ANiwBicN5ejmdS7iND0cth5ViUWK5MKZxvLKI6dPG5RljegfpZJtGKqDT\_MFfpayvcOlkkZc5yRw9Bcgz\_fW2ha7q6BGRsUb-e9DZ0Pcb5zL\_HbRLbnvlhYCYi9rPmYOYG6BronvLwB8sg2kVubLQGn\_ASbK\_FW8bKPhqH4BL2\_JunGBzUKJPL9yNvOnFy7VKwlvH1OKUqKlCYbewOtUd1utcMNIb\_AbSGRtzJKslbE5VwQtL5bZ34kOCNH07gSolSGvqqw4dyxU4l0QSVXVmqgVYdKfA"
アカウントキャンペーン概要を取得
指定された期間、タイムゾーン、および通貨に対するアカウントの総活動のパフォーマンス指標を返します。結果はデフォルトでキャンペーンごとに分けられますが、国ごとにも分けることができます。
説明
このAPIエンドポイントを呼び出して、指定された期間、タイムゾーン、および通貨に対するcamapignidごとに分けられたインプレッション、リファラル、コンバージョンなどのアカウントレベルのパフォーマンス指標を受け取ります。
リクエスト
パス
GET /reporting/accounts/{accountId}/campaigns/overview
パラメータ
| 名前 | タイプ | 場所 | 説明 | 必須 | 例 |
|---|---|---|---|---|---|
dateStart | String | query | 要求された日付/時間範囲の開始時間 | true | dateStart=2020-03-01T00:00:00.000 |
dateEnd | String | query | 要求された日付/時間範囲の終了時間 | true | dateEnd=2020-03-31T23:59:59.000 |
currency | Enum: AUD CAD EUR GBP JPY NZD SGD USD KRW CNY | query | 金銭的指標を受け取る通貨コード。 | true | currency=USD |
timeZoneVariation | Enum: America/Chicago Pacific/Honolulu Australia/Sydney | query | このパラメータを通じて希望するタイムゾーンを渡すことができます。Olson形式である必要があります。 | true | timeZoneVariation=Australia/Sydney |
groupBy | Enum: country campaign audience creative | query | 結果を分ける基準。デフォルトでは「campaign」です。 | true | campaign |
accountId | String | path | true |
レスポンス
200 OK
{
"acquisitionsByConversionDate": 0,
"acquisitionsByReferralDate": 0,
"audiences": 0,
"campaignCountries": 0,
"campaignId": "string",
"campaignName": "string",
"campaigns": 0,
"creatives": 0,
"grossCost": 0,
"impressions": 0,
"netCost": 0,
"referrals": 0,
}
GET アカウントキャンペーンの内訳
指定された期間、タイムゾーン、および通貨に対するRokt Ads広告主アカウントの総活動のパフォーマンス指標を返します。デフォルトでは、結果はキャンペーンごとに分類されますが、国ごとに活動を分類することもできます。
説明
指定された期間、タイムゾーン、および通貨に対してcamapignidごとに分類されたアカウントレベルのデータを受け取るには、このAPIエンドポイントを呼び出します。"groupby"パラメータを通じて呼び出すことができる属性には以下が含まれます:
- 国
リクエスト
パス
GET /reporting/accounts/{accountId}/campaigns/breakdown
パラメータ
| 名前 | タイプ | In | 説明 | 必須 | 例 |
|---|---|---|---|---|---|
dateStart | 文字列 | query | 要求された日付/時間範囲の開始時間 | true | dateStart=2020-03-01T00:00:00.000 |
dateEnd | 文字列 | query | 要求された日付/時間範囲の終了時間 | true | dateEnd=2020-03-31T23:59:59.000 |
currency | 列挙: AUD CAD EUR GBP JPY NZD SGD USD KRW CNY | query | 金銭的指標を受け取る通貨コード | true | currency=USD |
timeZoneVariation | 列挙: America/Chicago Pacific/Honolulu Australia/Sydney | query | オルソン形式での希望するタイムゾーン | true | timeZoneVariation=Australia/Sydney |
accountId | 文字列 | path | あなたのRoktアカウントID。One Platformで見つけるか、アカウントマネージャーから提供されます。 | true |
レスポンス
200 OK
{
"groupByValue": "string",
"grossCost": 0,
"netCost": 0,
"impressions": 0,
"referrals": 0,
"campaignCountries": 0,
"campaigns": 0,
"acquisitionsByConversionDate": 0,
"acquisitionsByReferralDate": 0,
"creatives": 0,
"Audiences": 0,
"campaignName": "string"
}
アカウントサマリーを取得
指定された期間、タイムゾーン、および通貨に対するアカウントの総活動のパフォーマンス指標を返します。このAPIエンドポイントは、Rokt EcommerceパートナーアカウントデータおよびRokt Ads広告主アカウントデータの両方に使用できます。
説明
指定された期間、タイムゾーン、および通貨に対するアカウントレベルのパフォーマンス指標を受け取るためにこのAPIエンドポイントを呼び出します。
リクエスト
パス
GET /reporting/accounts/{accountId}/summary
パラメータ
| 名前 | タイプ | 位置 | 説明 | 必須 | 例 |
|---|---|---|---|---|---|
dateStart | String | query | 要求された日付/時間範囲の開始時間 | true | dateStart=2020-03-01T00:00:00.000 |
dateEnd | String | query | 要求された日付/時間範囲の終了時間 | true | dateEnd=2020-03-31T23:59:59.000 |
currency | Enum: AUD CAD EUR GBP JPY NZD SGD USD KRW CNY | query | 金銭的指標を受け取る通貨コード。 | true | currency=USD |
timeZoneVariation | Enum: America/Chicago Pacific/Honolulu Australia/Sydney | query | このパラメータを通じて希望するタイムゾーンを渡すことができます。Olson形式である必要があります。 | true | timeZoneVariation=Australia/Sydney |
accountId | String | path | true |
レスポンス
200 OK
{
"campaignsSummary": {
"grossCost": 0,
"netCost": 0,
"impressions": 0,
"referrals": 0,
"acquisitionsByConversionDate": 0,
"acquisitionsByReferralDate": 0,
"campaigns": 0,
"creatives": 0,
"audiences": 0,
"campaignCountries": 0
},
"transactionsSummary": {
"revenue": 0,
"transactions": 0,
"placementImpressions": 0,
"impressions": 0,
"referrals": 0,
"rpt": 0,
"rpm": 0,
"positivePlacementEngagements": 0,
"purchases": 0
}
}
アカウント取引概要の取得
指定された期間、タイムゾーン、および通貨に対するRokt Ecommerceパートナーアカウントのパフォーマンス指標を返します。
説明
このAPIエンドポイントを呼び出して、指定された期間、タイムゾーン、および通貨に対するアカウントレベルの取引指標（配置インプレッション、紹介、および収益など）を受け取ります。
リクエスト
パス
GET /reporting/accounts/{accountId}/transactions/overview
パラメータ
| 名前 | タイプ | 場所 | 説明 | 必須 | 例 |
|---|---|---|---|---|---|
dateStart | String | query | 要求された日付/時間範囲の開始時間 | true | dateStart=2020-03-01T00:00:00.000 |
dateEnd | String | query | 要求された日付/時間範囲の終了時間 | true | dateEnd=2020-03-31T23:59:59.000 |
currency | Enum: AUD CAD EUR GBP JPY NZD SGD USD KRW CNY | query | 金銭的指標を受け取る通貨コード。 | true | currency=USD |
timeZoneVariation | Enum: America/Chicago Pacific/Honolulu Australia/Sydney | query | このパラメータを通じて希望するタイムゾーンを指定できます。Olson形式である必要があります。 | true | timeZoneVariation=Australia/Sydney |
accountId | String | path | true |
レスポンス
200 OK
{
"revenue": 0,
"transactions": 0,
"placementImpressions": 0,
"impressions": 0,
"referrals": 0,
"rpt": 0,
"rpm": 0,
"positivePlacementEngagements": 0,
"purchases": 0
}
GET アカウントトランザクションの内訳
指定された期間、タイムゾーン、および通貨に対して、属性ごとに分けられたRokt Ecommerceパートナーアカウントのパフォーマンス指標を返します。
説明
このAPIエンドポイントを呼び出して、指定された期間、タイムゾーン、および通貨に対して、クエリ文字列で指定された属性ごとに分けられたアカウントレベルのトランザクション指標を受け取ります。"groupby"パラメータを通じて呼び出すことができる属性には以下が含まれます:
- 年齢
- 性別
- ページ
- ページタイプ
- 配置
- 位置
配置の内訳は、トランザクション、購入、またはRPTを含むページレベルの指標の結果を返しません。
リクエスト
パス
GET /reporting/accounts/{accountId}/transactions/breakdown
パラメータ
| 名前 | タイプ | In | 説明 | 必須 | 例 |
|---|---|---|---|---|---|
dateStart | 文字列 | query | 要求された日付/時間範囲の開始時間 | true | dateStart=2020-03-01T00:00:00.000 |
dateEnd | 文字列 | query | 要求された日付/時間範囲の終了時間 | true | dateEnd=2020-03-31T23:59:59.000 |
currency | 列挙: AUD CAD EUR GBP JPY NZD SGD USD KRW CNY | query | 金銭的な指標を受け取る通貨コード。 | true | currency=USD |
timeZoneVariation | 列挙: America/Chicago Pacific/Honolulu Australia/Sydney | query | このパラメータを通じて希望するタイムゾーンを渡すことができます。Olson形式である必要があります。 | true | timeZoneVariation=Australia/Sydney |
accountId | 文字列 | path | true |
レスポンス
200 OK
{
"groupByValue": "string",
"revenue": 0,
"transactions": 0,
"placementImpressions": 0,
"impressions": 0,
"referrals": 0,
"purchases": 0,
"positivePlacementEngagements": 0,
"rpt": 0,
"rpm": 0
}
GET オーディエンスメタデータ
説明
このAPIエンドポイントを呼び出して、オーディエンス名、年齢範囲、性別、デバイスなどのオーディエンスメタデータを受け取ります。
リクエスト
パス
GET /metadata/accounts/{accountId}/campaigns/{campaignId}/audiences/{audienceId}
パラメータ
| 名前 | タイプ | 場所 | 必須 |
|---|---|---|---|
accountId | String | path | true |
campaignId | String | path | true |
audienceId | String | path | true |
レスポンス
200 OK
{
"accountId": "string",
"campaignId": "string",
"audienceId": "string",
"name": "string",
"ageRange": {
"min": 0,
"max": 0
},
"device": {
"desktop": true,
"tablet": true,
"mobile": true
},
"gender": "string"
}
キャンペーン概要を取得
指定された期間、タイムゾーン、および通貨に対するキャンペーンのパフォーマンス指標を返します。
説明
このAPIエンドポイントを呼び出して、指定された期間、タイムゾーン、および通貨に対するインプレッション、リファラル、コンバージョンなどのキャンペーンレベルのパフォーマンス指標を受け取ります。
リクエスト
パス
GET /reporting/accounts/{accountId}/campaigns/{campaignId}/overview
パラメータ
| 名前 | タイプ | 入力場所 | 説明 | 必須 | 例 |
|---|---|---|---|---|---|
dateStart | 文字列 | クエリ | 要求された日付/時間範囲の開始時間 | true | dateStart=2020-03-01T00:00:00.000 |
dateEnd | 文字列 | クエリ | 要求された日付/時間範囲の終了時間 | true | dateEnd=2020-03-31T23:59:59.000 |
currency | 列挙型: AUD CAD EUR GBP JPY NZD SGD USD KRW CNY | クエリ | 金銭的指標を受け取る通貨コード。 | true | currency=USD |
timeZoneVariation | 列挙型: America/Chicago Pacific/Honolulu Australia/Sydney | クエリ | このパラメータを通じて希望するタイムゾーンを渡すことができます。Olson形式である必要があります。 | true | timeZoneVariation=Australia/Sydney |
accountId | 文字列 | パス | true | ||
campaignId | 文字列 | パス | true |
応答
200 OK
{
"grossCost": 0,
"netCost": 0,
"impressions": 0,
"referrals": 0,
"acquisitionsByConversionDate": 0,
"acquisitionsByReferralDate": 0,
"campaigns": 0,
"creatives": 0,
"audiences": 0,
"campaignCountries": 0
}
キャンペーン内訳の取得
指定された期間、タイムゾーン、または通貨に対して、国、キャンペーン、オーディエンス、またはクリエイティブごとに分けられたキャンペーンのパフォーマンス指標を返します。
説明
指定された期間、タイムゾーン、または通貨に対して、クエリ文字列で指定された属性ごとに分けられたキャンペーンレベルのデータを受け取るためにこのAPIエンドポイントを呼び出します。"groupby"パラメータを通じて呼び出すことができる属性には以下が含まれます:
- 国;
- キャンペーン;
- オーディエンス;
- クリエイティブ; または
- サブバーティカル。
リクエスト
パス
GET /reporting/accounts/{accountId}/campaigns/{campaignId}/breakdown?groupby=creative
パラメータ
| 名前 | タイプ | 入力場所 | 説明 | 必須 | 例 |
|---|---|---|---|---|---|
dateStart | 文字列 | クエリ | 要求された日時範囲の開始時間 | true | dateStart=2020-03-01T00:00:00.000 |
dateEnd | 文字列 | クエリ | 要求された日時範囲の終了時間 | true | dateEnd=2020-03-31T23:59:59.000 |
currency | 列挙型: AUD CAD EUR GBP JPY NZD SGD USD KRW CNY | クエリ | 金銭的な指標を受け取る通貨コード。 | true | currency=USD |
timeZoneVariation | 列挙型: America/Chicago Pacific/Honolulu Australia/Sydney | クエリ | 希望するタイムゾーンをこのパラメータで渡すことができます。Olson形式である必要があります。 | true | timeZoneVariation=Australia/Sydney |
accountId | 文字列 | パス | true | ||
campaignId | 文字列 | パス | true |
Response
200 OK
{
"groupByValue": "string",
"grossCost": 0,
"netCost": 0,
"impressions": 0,
"referrals": 0,
"acquisitionsByConversionDate": 0,
"acquisitionsByReferralDate": 0,
"campaigns": 0,
"creatives": 0,
"audiences": 0,
"campaignCountries": 0,
"creativeName": "string"
}
GET Campaign Histogram
指定された期間、タイムゾーン、および通貨に分解されたキャンペーンのパフォーマンス指標を返します。
Description
このAPIエンドポイントを呼び出して、指定された期間、タイムゾーン、および通貨に対するキャンペーンのパフォーマンス指標（インプレッション、リファーラル、コンバージョンなど）のヒストグラムを受け取ります。
Request
Path
GET /reporting/accounts/{accountId}/campaigns/{campaignId}/histogram
Parameters
| Name | Type | In | Description | Required | Example |
|---|---|---|---|---|---|
dateStart | String | query | リクエストされた日付/時間範囲の開始時間 | true | dateStart=2020-03-01T00:00:00.000 |
dateEnd | String | query | リクエストされた日付/時間範囲の終了時間 | true | dateEnd=2020-03-31T23:59:59.000 |
currency | Enum: AUD CAD EUR GBP JPY NZD SGD USD KRW CNY | query | 金銭的指標を受け取る通貨コード。 | true | currency=USD |
timeZoneVariation | Enum: America/Chicago Pacific/Honolulu Australia/Sydney | query | このパラメータを通じて希望するタイムゾーンを渡すことができます。Olson形式である必要があります。 | true | timeZoneVariation=Australia/Sydney |
accountId | String | path | true | ||
campaignId | String | path | true |
レスポンス
200 OK
{
"intervalTimestamp": "string",
"grossCost": 0,
"netCost": 0,
"impressions": 0,
"referrals": 0,
"acquisitionsByConversionDate": 0,
"acquisitionsByReferralDate": 0,
"campaigns": 0,
"creatives": 0,
"audiences": 0,
"campaignCountries": 0
},
{
"intervalTimestamp": "string",
"grossCost": 0,
"netCost": 0,
"impressions": 0,
"referrals": 0,
"acquisitionsByConversionDate": 0,
"acquisitionsByReferralDate": 0,
"campaigns": 0,
"creatives": 0,
"audiences": 0,
"campaignCountries": 0
}
キャンペーンメタデータの取得
説明
特定のキャンペーンのメタデータを受け取るためにこのAPIエンドポイントを呼び出します。
リクエスト
パス
GET /metadata/accounts/{accountId}/campaigns/{campaignId}
パラメータ
| 名前 | タイプ | 場所 | 必須 |
|---|---|---|---|
accountId | String | path | true |
campaignId | String | path | true |
レスポンス
200 OK
{
"accountId": "string",
"campaignId": "string",
"campaignName": "string",
"campaignType": "string",
"campaignObjective": "string",
"countryCode": "string",
"status": "string"
}
クリエイティブ概要の取得
指定された期間、タイムゾーン、および通貨に対するクリエイティブのパフォーマンス指標を返します。
説明
指定された期間、タイムゾーン、および通貨に対するインプレッション、リファラル、コンバージョンなどのクリエイティブレベルのパフォーマンス指標を取得するために、このAPIエンドポイントを呼び出します。
リクエスト
パス
GET /reporting/accounts/{accountId}/campaigns/{campaignId}/creatives/{creativeId}/overview
パラメータ
| 名前 | タイプ | 場所 | 説明 | 必須 | 例 |
|---|---|---|---|---|---|
| dateStart | 文字列 | クエリ | 要求された日付/時間範囲の開始時間 | true | dateStart=2020-03-01T00:00:00.000 |
| dateEnd | 文字列 | クエリ | 要求された日付/時間範囲の終了時間 | true | dateEnd=2020-03-31T23:59:59.000 |
| currency | 列挙: AUD CAD EUR GBP JPY NZD SGD USD KRW CNY | クエリ | 金銭的指標を受け取る通貨コード。 | true | currency=USD |
| timeZoneVariation | 列挙: America/Chicago Pacific/Honolulu Australia/Sydney | クエリ | このパラメータを通じて希望するタイムゾーンを渡すことができます。Olson形式である必要があります。 | true | timeZoneVariation=Australia/Sydney |
| accountId | 文字列 | パス | true | ||
| campaignId | 文字列 | パス | true | ||
| creativeId | String | path | true |
レスポンス
200 OK
{
"grossCost": 0,
"netCost": 0,
"impressions": 0,
"referrals": 0,
"uniqueReferrals": 0,
"acquisitionsByConversionDate": 0,
"acquisitionsByReferralDate": 0,
"creatives": 0,
"audiences": 0
}
クリエイティブの内訳を取得
指定された期間、タイムゾーン、および通貨に対して、属性ごとに分解されたクリエイティブのパフォーマンス指標を返します。
説明
このAPIエンドポイントを呼び出して、指定された期間、タイムゾーン、および通貨に対して、クエリ文字列で指定された属性ごとに分解された特定のクリエイティブの詳細を取得します。"groupby"パラメータを通じて呼び出すことができる属性は次のとおりです:
- audience;
リクエスト
パス
GET /reporting/accounts/{accountId}/campaigns/{campaignId}/creatives/{creativeId}/breakdown
パラメータ
| 名前 | タイプ | In | 説明 | 必須 | 例 |
|---|---|---|---|---|---|
dateStart | 文字列 | query | 要求された日付/時間範囲の開始時間 | true | dateStart=2020-03-01T00:00:00.000 |
dateEnd | 文字列 | query | 要求された日付/時間範囲の終了時間 | true | dateEnd=2020-03-31T23:59:59.000 |
currency | 列挙: AUD CAD EUR GBP JPY NZD SGD USD KRW CNY | query | 金銭的な指標を受け取る通貨コード。 | true | currency=USD |
timeZoneVariation | 列挙: America/Chicago Pacific/Honolulu Australia/Sydney | query | このパラメータを通じて希望するタイムゾーンを渡すことができます。Olson形式である必要があります。 | true | timeZoneVariation=Australia/Sydney |
accountId | 文字列 | path | true | ||
campaignId | 文字列 | path | true | ||
creativeId | 文字列 | path | true |
レスポンス
200 OK
{
"groupByValue": "string",
"grossCost": 0,
"netCost": 0,
"impressions": 0,
"uniqueReferrals": 0,
"referrals": 0,
"acquisitionsByConversionDate": 0,
"acquisitionsByReferralDate": 0,
"creatives": 0,
"audiences": 0
}
クリエイティブメタデータの取得
説明
このAPIエンドポイントを呼び出して、クリエイティブのメタデータ（クリエイティブ名、タイトル、サブタイトル、テキスト、レスポンス、ステータスなど）を受け取ります。
リクエスト
パス
GET /metadata/accounts/{accountId}/campaigns/{campaignId}/creatives/{creativeId}
パラメータ
| 名前 | タイプ | 場所 | 必須 |
|---|---|---|---|
accountId | String | path | true |
campaignId | String | path | true |
creativeId | String | path | true |
レスポンス
200 OK
{
"accountId": "string",
"campaignId": "string",
"creativeId": "string",
"name": "string",
"title": "string",
"subtitle": "string",
"text": "string",
"responses": [
"string"
],
"status": "string"
}