メインコンテンツまでスキップ

レポートAPI

概要​

Rokt Reporting APIは、広告主やパートナーがRoktプラットフォームからパフォーマンスデータを取得し、独自のレポートやダッシュボードを作成するためのものです。これはHTTPベースのAPIであり、Roktデータを外部のビジネスアプリケーションにプログラム的にクエリや統合するために使用することができます。このAPIは、HTTPリクエストを行うことができる言語で動作します。ほとんどのリクエストはhttps://api.rokt.comのホストURLに送信されます。

データの安全性とセキュリティを確保するために、Rokt Reporting APIはアクセストークンを使用してリクエストを認証します。アクセストークンにより、Roktはクライアントアプリケーションとアクセスされるデータの種類を識別し、悪意のあるアプリが閲覧すべきでないデータにアクセスすることを防ぎます。

APIへの認証はOAuth 2.0を使用して行われます。正常なAPI呼び出しを行うためには、アプリIDとアプリシークレットを使用してアクセストークンを取得する必要があります。認証されていない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 App IDとApp Secretを使用する必要があります。

App IDとApp Secretの生成手順は以下に説明されています。これらの手順でRokt Event APIの認証情報を生成することもできます。

これらのクライアントアプリの認証情報をRokt Reporting APIとのRESTインタラクションで使用する必要があります。

App IDとApp Secretの生成​

  1. my.rokt.comにサインインします。

  2. アカウントアイコンの下部左側にあるプロファイル設定に移動します。

    img

  3. Generate Personal API Credentialsセクションまでスクロールします。

  4. アプリの名前を入力します。

  5. Generateをクリックします。

  6. Reporting APIとEvent APIの認証情報がすぐに生成され、以下のような形式になります。

    AppId: "40svbin0d194subpohl079rhck"
    AppSecret: "1dimhvr1v6skae9uhvtgs3chs2astnjf0469df6ul9hurubtoovn"

  7. App IDとApp Secretを安全な場所に保存してください。このセッションの後に再びApp Secretにアクセスすることはできません。

  8. これらの認証情報をすぐに使用することができます。

認証情報は機密情報として保持し、アカウントを保護するためにメールで送信しないでください。組織外で共有しないでください。Roktからの問い合わせであっても、正当なRoktの代表者はApp Secretを求めることはありません。

アクセストークンの取得​

Rokt Reporting APIの任意のエンドポイントを呼び出すには、アクセストークンが必要です。アクセストークンにより、Roktはクライアントアプリを識別し、各クライアントアプリがアクセスしているデータの種類を把握し、悪意のあるアプリがアクセス権限のないデータにアクセスするのを防ぎます。 APIへの認証は、OAuth 2.0を介して行われます。成功したAPI呼び出しを実行するには、すべてのAPI呼び出しで使用する必要のあるアプリIDとアプリシークレットを使用してアクセストークンを取得する必要があります。アプリ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

ヘッダー内のリクエストパラメータ​

キー場所説明必須？例
Authorizationヘッダーapp_idとapp_secretはBasic HTTP認証を介して認証ヘッダーに渡す必要があります。これはOne Platformのプロファイル設定で生成できます。ヘッダーの内容はBasic base64encode(app_id:app_secret)です。はいBasic base64encocde(12345:abcde)
Content-Typeヘッダーリクエストのメディアタイプは常にapplication/x-www-form-urlencodedである必要があります。はいapplication/x-www-form-urlencoded

ボディ内のリクエストパラメータ​

キー場所説明必須？例
grant_typeボディ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&
### アカウントキャンペーンの概要を取得する

指定された期間、タイムゾーン、通貨に対して、アカウントの総アクティビティのパフォーマンスメトリクスを返します。結果はデフォルトでキャンペーンごとに分割されますが、国ごとに分割することもできます。

#### 説明
このAPIエンドポイントを呼び出して、指定された期間、タイムゾーン、通貨に対して、インプレッション、リファラル、コンバージョンなどのアカウントレベルのパフォーマンスメトリクスを受け取ります。

#### リクエスト

##### パス

```json
GET /reporting/accounts/{accountId}/campaigns/overview

パラメータ​

名前タイプIn説明必須例
dateStartStringqueryリクエストされた日時範囲の開始時間truedateStart=2020-03-01T00:00:00.000
dateEndStringqueryリクエストされた日時範囲の終了時間truedateEnd=2020-03-31T23:59:59.000
currencyEnum:
AUD
CAD
EUR
GBP
JPY
NZD
SGD
USD
KRW
CNY		query金銭的なメトリクスを受け取る通貨コードtruecurrency=USD
timeZoneVariationEnum:
America/Chicago
Pacific/Honolulu
Australia/Sydney		queryオルソン形式で指定されたタイムゾーンtruetimeZoneVariation=Australia/Sydney
groupByEnum:
country
campaign
audience
creative		query結果を分割する基準。デフォルトは 'campaign'です。truecampaign
accountIdStringpath 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,
"uniqueSessions": 0
}

アカウントキャンペーンの詳細を取得する​

指定された期間、タイムゾーン、通貨に対して、Rokt Ads広告主アカウントの総アクティビティのパフォーマンスメトリクスを返します。デフォルトでは、結果はキャンペーンごとに分割されますが、国ごとにもアクティビティを分割することができます。

説明​

このAPIエンドポイントを呼び出して、指定された期間、タイムゾーン、通貨に対して、camapignidごとに分割されたアカウントレベルのデータを受け取ります。 "groupby"パラメータを介して呼び出すことができる属性には、次のものがあります：

  • country

リクエスト​

パス​
GET /reporting/accounts/{accountId}/campaigns/breakdown
パラメータ​
名前タイプIn説明必須例
dateStartStringqueryリクエストされた日時範囲の開始時間truedateStart=2020-03-01T00:00:00.000
dateEndStringqueryリクエストされた日時範囲の終了時間truedateEnd=2020-03-31T23:59:59.000
currencyEnum:
AUD
CAD
EUR
GBP
JPY
NZD
SGD
USD
KRW
CNY		query通貨コード、金銭のメトリクスを受け取るための通貨コードtruecurrency=USD
timeZoneVariationEnum:
America/Chicago
Pacific/Honolulu
Australia/Sydney		query欲しいタイムゾーンをOlson形式で指定するtruetimeZoneVariation=Australia/Sydney
accountIdStringpathRoktアカウントID、One Platformで見つけるか、アカウントマネージャーから提供されるtrue 

レスポンス​

200 OK

{
 "groupByValue": "string",
 "grossCost": 0,
 "netCost": 0,
 "impressions": 0,
 "uniqueSessions": 0,
 "referrals": 0,
 "campaignCountries": 0,
 "campaigns": 0,
 "acquisitionsByConversionDate": 0,
 "acquisitionsByReferralDate": 0,
 "creatives": 0,
 "Audiences": 0,
 "campaignName": "string"
}

アカウントの概要を取得する(GET Account Summary)​

指定された期間、タイムゾーン、通貨に対するアカウントの総アクティビティのパフォーマンスメトリクスを返します。このAPIエンドポイントは、Rokt EcommerceパートナーアカウントデータとRokt Ads広告主アカウントデータの両方に使用できます。

説明​

指定された期間、タイムゾーン、通貨に対するアカウントレベルのパフォーマンスメトリクスを受け取るために、このAPIエンドポイントを呼び出します。

リクエスト​

パス​
GET /reporting/accounts/{accountId}/summary
パラメータ​
名前タイプIn説明必須例
dateStartStringqueryリクエストされた日時範囲の開始時間truedateStart=2020-03-01T00:00:00.000
dateEndStringqueryリクエストされた日時範囲の終了時間truedateEnd=2020-03-31T23:59:59.000
currencyEnum:
AUD
CAD
EUR
GBP
JPY
NZD
SGD
USD
KRW
CNY		query通貨コード、金銭のメトリクスを受け取るための通貨コードtruecurrency=USD
timeZoneVariationEnum:
America/Chicago
Pacific/Honolulu
Australia/Sydney		query欲しいタイムゾーンをOlson形式で指定するtruetimeZoneVariation=Australia/Sydney
accountIdStringpath true 

レスポンス​

200 OK

{
  "campaignsSummary": {
  "grossCost": 0,
  "netCost": 0,
  "impressions": 0,
  "uniqueSessions": 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 Account Transactions Overview)​

指定された期間、タイムゾーン、通貨に対するRokt Ecommerceパートナーアカウントのパフォーマンスメトリクスを返します。

説明​

指定された期間、タイムゾーン、通貨に対するパートナーアカウントのトランザクションメトリクス（配置のインプレッション、リファラル、収益など）を受け取るために、このAPIエンドポイントを呼び出します。

リクエスト​

パス​
GET /reporting/accounts/{accountId}/transactions/overview

パラメータ

名前タイプIn説明必須例
dateStartStringqueryリクエストされた日時範囲の開始時間truedateStart=2020-03-01T00:00:00.000
dateEndStringqueryリクエストされた日時範囲の終了時間truedateEnd=2020-03-31T23:59:59.000
currencyEnum:
AUD
CAD
EUR
GBP
JPY
NZD
SGD
USD
KRW
CNY		query通貨コード。金銭の指標を受け取るための通貨コードです。truecurrency=USD
timeZoneVariationEnum:
America/Chicago
Pacific/Honolulu
Australia/Sydney		queryオルソン形式で指定されたタイムゾーンを渡すことができます。truetimeZoneVariation=Australia/Sydney
accountIdStringpath true 

レスポンス​

200 OK

{
  "revenue": 0,
  "transactions": 0,
  "placementImpressions": 0,
  "impressions": 0,
  "referrals": 0,
  "rpt": 0,
  "rpm": 0,
  "positivePlacementEngagements": 0,
  "purchases": 0
}

アカウントトランザクションの詳細を取得する​

指定された期間、タイムゾーン、通貨に基づいて、Rokt Ecommerceパートナーアカウントのトランザクションメトリクスを属性ごとに分解して返します。

説明​

このAPIエンドポイントを呼び出して、指定された期間、タイムゾーン、通貨に基づいて、クエリ文字列で指定された属性ごとに分解されたアカウントレベルのトランザクションメトリクスを受け取ります。 "groupby"パラメータを介して呼び出すことができる属性には次のものがあります。

  • 年齢
  • 性別
  • ページ
  • ページタイプ
  • プレースメント
  • ポジション
注記

プレースメントの分解では、トランザクション、購入、またはRPTを含むページレベルのメトリクスの結果は返されません。

リクエスト​

パス​
GET /reporting/accounts/{accountId}/transactions/breakdown
パラメータ​
名前タイプIn説明必須例
dateStartStringqueryリクエストされた日時範囲の開始時刻truedateStart=2020-03-01T00:00:00.000
dateEndStringqueryリクエストされた日時範囲の終了時刻truedateEnd=2020-03-31T23:59:59.000
currencyEnum:
AUD
CAD
EUR
GBP
JPY
NZD
SGD
USD
KRW
CNY		query金銭メトリクスを受け取る通貨コードtruecurrency=USD
timeZoneVariationEnum:
America/Chicago
Pacific/Honolulu
Australia/Sydney		queryオルソン形式で指定されたタイムゾーンを渡すことができます。truetimeZoneVariation=Australia/Sydney
accountIdStringpath true 

レスポンス​

200 OK

{
  "groupByValue": "string",
  "revenue": 0,
  "transactions": 0,
  "placementImpressions": 0,
  "impressions": 0,
  "referrals": 0,
  "purchases": 0,
  "positivePlacementEngagements": 0,
  "rpt": 0,
  "rpm": 0
}

オーディエンスメタデータを取得する​

説明​

このAPIエンドポイントを呼び出して、オーディエンスのメタデータ（オーディエンス名、年齢層、性別、デバイスなど）を受け取ります。

リクエスト​

パス​
GET /metadata/accounts/{accountId}/campaigns/{campaignId}/audiences/{audienceId}
パラメータ​
名前タイプIn必須
accountIdStringpathtrue
campaignIdStringpathtrue
audienceIdStringpathtrue

レスポンス​

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
パラメータ​
名前タイプIn説明必須例
dateStartStringqueryリクエストされた日時範囲の開始時刻truedateStart=2020-03-01T00:00:00.000
dateEndStringqueryリクエストされた日時範囲の終了時刻truedateEnd=2020-03-31T23:59:59.000
currencyEnum:
AUD
CAD
EUR
GBP
JPY
NZD
SGD
USD
KRW
CNY		query金銭メトリクスを受け取る通貨コードtruecurrency=USD
timeZoneVariationEnum:
America/Chicago
Pacific/Honolulu
Australia/Sydney		queryオルソン形式で指定されたタイムゾーンを渡すことができます。truetimeZoneVariation=Australia/Sydney
accountIdStringpath true 
campaignIdStringpath true 

レスポンス​

200 OK

{
  "grossCost": 0,
  "netCost": 0,
  "impressions": 0,
  "uniqueSessions": 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
パラメータ​
名前タイプIn説明必須例
dateStartStringqueryリクエストされた日時範囲の開始時刻truedateStart=2020-03-01T00:00:00.000
dateEndStringqueryリクエストされた日時範囲の終了時刻truedateEnd=2020-03-31T23:59:59.000
currencyEnum:
AUD
CAD
EUR
GBP
JPY
NZD
SGD
USD
KRW
CNY		query通貨コードで受け取る通貨メトリクス。truecurrency=USD
timeZoneVariationEnum:
America/Chicago
Pacific/Honolulu
Australia/Sydney		queryOlson形式で指定されたタイムゾーンを渡すことができます。truetimeZoneVariation=Australia/Sydney
accountIdStringpath true 
campaignIdStringpath true 

レスポンス​

200 OK

{
 "groupByValue": "string",
 "grossCost": 0,
 "netCost": 0,
 "impressions": 0,
 "uniqueSessions": 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
パラメータ​
名前タイプIn説明必須例
dateStartStringqueryリクエストされた日時範囲の開始時刻truedateStart=2020-03-01T00:00:00.000
dateEndStringqueryリクエストされた日時範囲の終了時刻truedateEnd=2020-03-31T23:59:59.000
currencyEnum:
AUD
CAD
EUR
GBP
JPY
NZD
SGD
USD
KRW
CNY		query通貨コードで受け取る通貨メトリクス。truecurrency=USD
timeZoneVariationEnum:
America/Chicago
Pacific/Honolulu
Australia/Sydney		queryOlson形式で指定されたタイムゾーンを渡すことができます。truetimeZoneVariation=Australia/Sydney
accountIdStringpath true 
campaignIdStringpath true 

レスポンス​

200 OK

{
  "intervalTimestamp": "string",
  "grossCost": 0,
  "netCost": 0,
  "impressions": 0,
  "uniqueSessions": 0,
  "referrals": 0,
  "acquisitionsByConversionDate": 0,
  "acquisitionsByReferralDate": 0,
  "campaigns": 0,
  "creatives": 0,
  "audiences": 0,
  "campaignCountries": 0
  },
 {
  "intervalTimestamp": "string",
  "grossCost": 0,
  "netCost": 0,
  "impressions": 0,
  "uniqueSessions": 0,
  "referrals": 0,
  "acquisitionsByConversionDate": 0,
  "acquisitionsByReferralDate": 0,
  "campaigns": 0,
  "creatives": 0,
  "audiences": 0,
  "campaignCountries": 0
 }

キャンペーンのメタデータを取得する​

説明​

特定のキャンペーンのメタデータを受け取るためにこのAPIエンドポイントを呼び出します。

リクエスト​

パス​
GET /metadata/accounts/{accountId}/campaigns/{campaignId}
パラメータ​
名前タイプIn必須
accountIdStringpathtrue
campaignIdStringpathtrue

レスポンス​

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
パラメータ​
名前タイプIn説明必須例
dateStartStringqueryリクエストされた日時範囲の開始時刻truedateStart=2020-03-01T00:00:00.000
dateEndStringqueryリクエストされた日時範囲の終了時刻truedateEnd=2020-03-31T23:59:59.000
通貨Enum:
AUD
CAD
EUR
GBP
JPY
NZD
SGD
USD
KRW
CNY		クエリ通貨コードで受け取る金銭指標。truecurrency=USD
タイムゾーンの変動Enum:
America/Chicago
Pacific/Honolulu
Australia/Sydney		クエリOlson形式で指定されたタイムゾーン。truetimeZoneVariation=Australia/Sydney
アカウントIDStringパス true 
キャンペーンIDStringパス true 
クリエイティブIDStringパス true 

レスポンス​

200 OK

{
  "grossCost": 0,
  "netCost": 0,
  "impressions": 0,
  "uniqueSessions": 0,
  "referrals": 0,
  "uniqueReferrals": 0,
  "acquisitionsByConversionDate": 0,
  "acquisitionsByReferralDate": 0,
  "creatives": 0,
  "audiences": 0
}

クリエイティブの分析を取得する​

指定された期間、タイムゾーン、通貨で、指定された属性で分析されたクリエイティブのパフォーマンスメトリクスを返します。

説明​

指定された期間、タイムゾーン、通貨で、クエリ文字列で指定された属性で分析された特定のクリエイティブの詳細については、このAPIエンドポイントを呼び出します。 "groupby"パラメータを介して呼び出すことができる属性は次のとおりです。

  • オーディエンス;

リクエスト​

パス​
GET /reporting/accounts/{accountId}/campaigns/{campaignId}/creatives/{creativeId}/breakdown
パラメータ​
名前タイプIn説明必須例
dateStartStringクエリ要求された日時範囲の開始時間truedateStart=2020-03-01T00:00:00.000
dateEndStringクエリ要求された日時範囲の終了時間truedateEnd=2020-03-31T23:59:59.000
currencyEnum:
AUD
CAD
EUR
GBP
JPY
NZD
SGD
USD
KRW
CNY		クエリ金銭メトリクスを受け取る通貨コード。truecurrency=USD
timeZoneVariationEnum:
America/Chicago
Pacific/Honolulu
Australia/Sydney		クエリOlson形式で指定されたタイムゾーン。truetimeZoneVariation=Australia/Sydney
accountIdStringパス true 
campaignIdStringパス true 
creativeIdStringパス true 

レスポンス​

200 OK

{
  "groupByValue": "string",
  "grossCost": 0,
  "netCost": 0,
  "impressions": 0,
  "uniqueSessions": 0,
  "uniqueReferrals": 0,
  "referrals": 0,
  "acquisitionsByConversionDate": 0,
  "acquisitionsByReferralDate": 0,
  "creatives": 0,
  "audiences": 0
}

クリエイティブのメタデータを取得する​

説明​

クリエイティブのメタデータ、クリエイティブ名、タイトル、サブタイトル、テキスト、応答、ステータスを含むクリエイティブのメタデータを受け取るために、このAPIエンドポイントを呼び出します。

リクエスト​

パス​
GET /metadata/accounts/{accountId}/campaigns/{campaignId}/creatives/{creativeId}
パラメータ​
名前タイプIn必須
accountIdStringパスtrue
campaignIdStringパスtrue
creativeIdStringパスtrue

レスポンス​

200 OK

{
  "accountId": "string",
  "campaignId": "string",
  "creativeId": "string",
  "name": "string",
  "title": "string",
  "subtitle": "string",
  "text": "string",
  "responses": [
    "string"
  ],
  "status": "string"
}
この記事は役に立ちましたか？