レポート API
概要
Rokt Reporting API を使用すると、広告主およびパートナーは Rokt プラットフォームからパフォーマンス データを取得し、自分たちのレポートやダッシュボードを作成できます。これは HTTP ベースの API であり、プログラム的にクエリを行い、Rokt データを外部のビジネス アプリケーションに統合するために使用できます。この API は、HTTP リクエストを行うことができる任意の言語で使用できます。ほぼすべてのリクエストは https://api.rokt.com ホスト URL に送信されます。
データの安全性とセキュリティを保つために、Rokt Reporting API はアクセス トークンを使用してリクエストを認証します。アクセス トークンは、Rokt がクライアント アプリケーションとアクセスしているデータの種類を識別するのに役立ち、悪意のあるアプリがアクセスしてはいけないデータを取得するのを防ぎます。
API の認証は OAuth 2.0 を通して行われます。API コールを成功させるには、App ID および App Secret を使用してアクセス トークンを取得する必要があります。認証なしでは API リクエストは失敗します。Rokt Reporting API は、ユーザー資格情報でアクセスできるアカウントからのみデータを取得できます。
バージョン
API のアルファリリースバージョンを使用している早期導入者の方は、API リクエストヘッダーで "rokt-version":"alpha-20200701" を使用して、可能な限りの破壊的変更を最小限に抑えてください。rokt-version ヘッダーが使用されていない場合、エンドポイントリクエストは常に Rokt Reporting API の LATEST バージョンを指します。
認証
Rokt Reporting API は、OAuth 2.0 アプローチを活用してクライアント統合を行います。詳細については、OAuth 2.0 クレデンシャルフローを参照してください。Rokt Reporting API にアクセスするには、Rokt アプリの ID とシークレットを使用する必要があります。
アプリ ID とアプリ シークレットを生成する手順は以下に説明されています。同じ手順で Rokt Event API のクレデンシャルを生成できます。
Rokt Reporting API との REST のやり取りでは、これらのクライアントアプリのクレデンシャルを使用する必要があります。
アプリ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呼び出しを成功させるには、アプリIDとアプリシークレットを使用してアクセストークンを取得し、すべてのAPI呼び出しで使用する必要があります。アプリIDとアプリシークレットは、上記のようにOne Platformのプロファイル設定ページで生成できます。
認証なしまたは不正な認証によるAPIリクエストは失敗します。APIは400または403のエラーコードを返します。Rokt Reporting APIからは、ユーザーの資格情報がアクセスできるアカウントのデータのみを取得できます。
アクセストークンは、前のステップで作成したアプリIDとアプリシークレットに基づいて生成されます。アクセストークンの有効期間は1時間です。その1時間の間に、アクセストークンを使用してRokt Reporting APIのすべてのエンドポイントを呼び出すことができます。有効期限が切れる前に、クライアントアプリの認証情報に基づいてアクセストークンを再生成する必要があります。
アクセストークンを取得するために、Rokt Reporting APIにエンドポイントが公開されています：
POST https://api.rokt.com/auth/oauth2/token
リクエストパラメータ (ヘッダー内)
| Key | In | Description | Required? | Example |
|---|---|---|---|---|
Authorization | header | app_id と app_secret はベーシックHTTP認証を通じて認証ヘッダーで渡され、「One Platform」のプロファイル設定で生成できます。ヘッダーの内容は Basic base64encode(app_id:app_secret) です。 | Yes | Basic base64encocde(12345:abcde) |
Content-Type | header | リクエストのメディアタイプは常に application/x-www-form-urlencoded でなければなりません。 | Yes | application/x-www-form-urlencoded |
リクエストパラメータ (ボディ内)
| Key | In | Description | Required? | Example |
|---|---|---|---|---|
grant_type | body | client_credentialsでなければなりません。 | Yes | client_credentials |
成功したリクエストの例
サンプルリクエスト:
curl -vX POST https://api.rokt.com/auth/oauth2/token \
-H 'Authorization: Basic ${AuthToken}' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-d 'grant_type=client_credentials'
サンプルレスポンス:
{
"access_token": "eyJraWQiOiJPVUpHT1RjM09FWXROakkzUlMwME5UUkJMVGxCTkRrdFJqWXdOVVV3UkRNNE1FTTJDZz09IiwiYWxnIjoiSFMyNTYifQ.eyJzdWIiOiJkZW1vIiwidG9rZW5fdXNlIjoiYWNjZXNzIiwic2NvcGUiOiJyZXBvcnQtYXBpL3JlYWQtcmVwb3J0LWFwaSIsImF1dGhfdGltZSI6MTU4NTExMDA0MSwiaXNzIjoiaHR0cHM6Ly9jb2duaXRvLWlkcC51cy13ZXN0LTIuYW1hem9uYXdzLmNvbS91cy13ZXN0LTJfZG93Tlp1elRYIiwiZXhwIjoxNTg1MTEzNjQxLCJpYXQiOjE1ODUxMTAwNDEsInZlcnNpb24iOjIsImp0aSI6IkYwNzY5RDVDLTRDNTAtNDVDOC04OTcyLTI4MkUwODlDMkFFOSIsImNsaWVudF9pZCI6ImRlbW8ifQ.NOJIx7qLHFVXqKNZfJKsJlwitOvbHOLdknQ\_D33WjYe8O9ZE08t7LFgs7ANiwBicN5ejmdS7iND0cth5ViUWK5MKZxvLKI6dPG5RljegfpZJtGKqDT\_MFfpayvcOlkkZc5yRw9Bcgz\_fW2ha7q6BGRsUb-e9DZ0Pcb5zL\_HbRLbnvlhYCYi9rPmYOYG6BronvLwB8sg2kVubLQGn\_ASbK\_FW8bKPhqH4BL2\_JunGBzUKJPL9yNvOnFy7VKwlvH1OKUqKlCYbewOtUd1utcMNIb\_AbSGRtzJKslbE5VwQtL5bZ34kOCNH07gSolSGvqqw4dyxU4l0QSVXVmqgVYdKfA",
"expires_in": 3600,
"token_type": "Bearer"
}
API エンドポイント
API エンドポイントの呼び出し
前のステップで取得したアクセストークンを使用して、Rokt レポート 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"
アカウントキャンペーンの内訳の取得
指定された期間、タイムゾーン、および通貨に対するRokt Ads広告主アカウントの総活動のパフォーマンス指標を返します。デフォルトでは、結果はキャンペーンごとに分解されますが、国ごとにも活動を分解することができます。
説明
指定された期間、タイムゾーン、および通貨に対するアカウントレベルのデータをcamapignidによって分解して受け取るために、このAPIエンドポイントを呼び出します。「groupby」パラメータを通じて呼び出すことができる属性には以下が含まれます：
- 国
リクエスト
パス
GET /reporting/accounts/{accountId}/campaigns/breakdown
パラメータ
| 名前 | 型 | 位置 | 説明 | 必須 | 例 |
|---|---|---|---|---|---|
dateStart | 文字列 | クエリ | 要求された日付/時間範囲の開始時刻 | はい | dateStart=2020-03-01T00:00:00.000 |
dateEnd | 文字列 | クエリ | 要求された日付/時間範囲の終了時刻 | はい | dateEnd=2020-03-31T23:59:59.000 |
currency | 列挙型: AUD CAD EUR GBP JPY NZD SGD USD KRW CNY | クエリ | 貨幣指標を受け取る通貨コード | はい | currency=USD |
timeZoneVariation | 列挙型: America/Chicago Pacific/Honolulu Australia/Sydney | クエリ | 希望するタイムゾーン（Olson形式） | はい | timeZoneVariation=Australia/Sydney |
accountId | 文字列 | パス | あなたのRoktアカウントID。One Platformで見つけるか、アカウントマネージャーによって提供されます。 | はい |
応答
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
}
}
GET アカウントトランザクション概要
指定された期間、タイムゾーン、および通貨におけるRokt Ecommerceパートナーアカウントのパフォーマンス指標を返します。
説明
このAPIエンドポイントを呼び出して、指定された期間、タイムゾーン、および通貨におけるアカウントレベルのトランザクション指標（プレースメントインプレッション、リファラル、収益など）を取得します。
リクエスト
パス
GET /reporting/accounts/{accountId}/transactions/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 |
応答
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
パラメータ
| 名前 | タイプ | 所在 | 説明 | 必須 | 例 |
|---|---|---|---|---|---|
dateStart | String | クエリ | リクエストされた日付/時間範囲の開始時刻 | true | dateStart=2020-03-01T00:00:00.000 |
dateEnd | String | クエリ | リクエストされた日付/時間範囲の終了時刻 | true | dateEnd=2020-03-31T23:59:59.000 |
currency | Enum: AUD CAD EUR GBP JPY NZD SGD USD KRW CNY | クエリ | 金銭的指標を受け取るための通貨コード | true | currency=USD |
timeZoneVariation | Enum: America/Chicago Pacific/Honolulu Australia/Sydney | クエリ | 希望するタイムゾーンをこのパラメータを通して渡すことができます。Olson形式である必要があります。 | true | timeZoneVariation=Australia/Sydney |
accountId | String | パス | 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 | パス | true |
campaignId | String | パス | true |
audienceId | String | パス | 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"
}
GET キャンペーン概要
指定された期間、タイムゾーン、および通貨に対するキャンペーンのパフォーマンス指標を返します。
説明
このAPIエンドポイントを呼び出して、指定された期間、タイムゾーン、通貨別のインプレッション、リファラル、コンバージョンなどのキャンペーンレベルのパフォーマンス指標を取得します。
リクエスト
パス
GET /reporting/accounts/{accountId}/campaigns/{campaignId}/overview
パラメータ
| 名前 | タイプ | In | 説明 | 必須 | 例 |
|---|---|---|---|---|---|
dateStart | 文字列 | クエリ | 要求された日付/時間範囲の開始時刻 | true | dateStart=2020-03-01T00:00:00.000 |
dateEnd | 文字列 | クエリ | 要求された日付/時間範囲の終了時刻 | true | dateEnd=2020-03-31T23:59:59.000 |
currency | Enum: AUD CAD EUR GBP JPY NZD SGD USD KRW CNY | クエリ | 金銭的指標を受け取るための通貨コード。 | true | currency=USD |
timeZoneVariation | Enum: America/Chicago Pacific/Honolulu Australia/Sydney | クエリ | このパラメータを使用して希望するタイムゾーンを指定できます。オルソン形式である必要があります。 | 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
}
GET キャンペーン内訳
指定された期間、タイムゾーン、または通貨に対して、国、キャンペーン、オーディエンス、またはクリエイティブごとに内訳されたキャンペーンのパフォーマンス指標を返します。
説明
このAPIエンドポイントを呼び出して、指定された期間、タイムゾーン、または通貨に対して、クエリ文字列で指定された属性ごとに内訳されたキャンペーンレベルのデータを受け取ります。 "groupby"パラメータを使用して呼び出すことができる属性には以下が含まれます：
- country;
- campaign;
- audience;
- creative; または
- subvertical.
リクエスト
パス
GET /reporting/accounts/{accountId}/campaigns/{campaignId}/breakdown?groupby=creative
パラメータ
| 名前 | タイプ | In | 説明 | 必須 | 例 |
|---|---|---|---|---|---|
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
{
"groupByValue": "string",
"grossCost": 0,
"netCost": 0,
"impressions": 0,
"referrals": 0,
"acquisitionsByConversionDate": 0,
"acquisitionsByReferralDate": 0,
"campaigns": 0,
"creatives": 0,
"audiences": 0,
"campaignCountries": 0,
"creativeName": "string"
}
キャンペーンヒストグラムの取得
指定された期間、タイムゾーン、および通貨に基づいて、キャンペーンのパフォーマンス指標を返します。
説明
指定された期間、タイムゾーン、および通貨に対する、インプレッション、リファーラル、コンバージョンなどのキャンペーンのパフォーマンス指標のヒストグラムを受け取るには、このAPIエンドポイントを呼び出します。
リクエスト
パス
GET /reporting/accounts/{accountId}/campaigns/{campaignId}/histogram
パラメータ
| 名前 | 型 | イン | 説明 | 必須 | 例 |
|---|---|---|---|---|---|
dateStart | String | クエリ | 要求された日時範囲の開始時間 | true | dateStart=2020-03-01T00:00:00.000 |
dateEnd | String | クエリ | 要求された日時範囲の終了時間 | true | dateEnd=2020-03-31T23:59:59.000 |
currency | Enum: AUD CAD EUR GBP JPY NZD SGD USD KRW CNY | クエリ | 財務指標を受け取る通貨コード。 | true | currency=USD |
timeZoneVariation | Enum: America/Chicago Pacific/Honolulu Australia/Sydney | クエリ | このパラメータを使用して希望のタイムゾーンを渡すことができます。Olson形式である必要があります。 | true | timeZoneVariation=Australia/Sydney |
accountId | String | パス | true | ||
campaignId | String | パス | 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
}
GET キャンペーンメタデータ
説明
特定のキャンペーンに関するメタデータを受け取るためにこの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 | 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 | ||
| 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
パラメーター
| 名前 | 型 | 入力 | 説明 | 必須 | 例 |
|---|---|---|---|---|---|
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 | 文字列 | パス | true |
レスポンス
200 OK
{
"groupByValue": "string",
"grossCost": 0,
"netCost": 0,
"impressions": 0,
"uniqueReferrals": 0,
"referrals": 0,
"acquisitionsByConversionDate": 0,
"acquisitionsByReferralDate": 0,
"creatives": 0,
"audiences": 0
}
GET クリエイティブ メタデータ
説明
この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"
}