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

レポート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アプリIDとアプリシークレットを使用する必要があります。

アプリIDとアプリシークレットを生成する手順は以下に説明されています。同じ手順でRokt Event APIの資格情報を生成することができます。

これらのクライアントアプリ資格情報を使用して、Rokt Reporting APIとのRESTインタラクションを行う必要があります。

アプリ ID とアプリ シークレットの生成​

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

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

    img

  3. 個人 API 資格情報の生成 セクションまでスクロールダウンします。

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

  5. 生成 をクリックします。

  6. Reporting API と Event API の両方の資格情報がすぐに生成され、次のようになります:

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

  7. アプリ ID とアプリ シークレットを安全な場所に保管してください。このセッションの後、再度アプリ シークレットにアクセスすることはできません。

  8. これらの資格情報をすぐに使用できます。

資格情報は機密に保ち、アカウントを保護するために、決してメールで送信しないでください。Rokt からの問い合わせのように見える場合でも、組織の外と共有しないでください。Rokt を正当に代表する人が、あなたにアプリ シークレットを求めることは決してありません。

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

アクセストークンは、Rokt Reporting APIの任意のエンドポイントを呼び出すために必要です。アクセストークンは、Roktがクライアントアプリを識別し、各クライアントアプリがアクセスしているデータの種類を把握し、悪意のあるアプリがアクセス権のないデータにアクセスするのを防ぎます。

APIへの認証は、OAuth 2.0を介して行われます。成功したAPI呼び出しを行うには、App IDとApp Secretを使用してアクセストークンを取得する必要があります。このアクセストークンはすべてのAPI呼び出しで使用する必要があります。App IDとApp Secretは、上記の説明にあるProfile SettingsページでOne Platformの中で生成できます。

認証なしの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

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

キー場所説明必須?例
Authorizationheaderapp_id と app_secret は、Basic HTTP 認証を通じて認証ヘッダーに渡す必要があり、One Platformのプロファイル設定で生成できます; ヘッダーの内容は Basic base64encode(app_id:app_secret) ですはいBasic base64encocde(12345:abcde)
Content-Typeheaderリクエストのメディアタイプは常に application/x-www-form-urlencoded でなければなりませんはいapplication/x-www-form-urlencoded

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

キー場所説明必須?例
grant_typebodyclient_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"

GET アカウント キャンペーン内訳​

指定された期間、タイムゾーン、通貨に対するRokt Ads広告主アカウントの全活動のパフォーマンス指標を返します。デフォルトでは、結果はキャンペーン別に内訳されますが、国別に活動を分けることもできます。

説明​

campaignidで内訳されたアカウントレベルのデータを受け取るために、このAPIエンドポイントを呼び出します。指定された期間、タイムゾーン、通貨での呼び出し可能な属性は、"groupby"パラメータを介して含まれます:

  • 国

リクエスト​

パス​
GET /reporting/accounts/{accountId}/campaigns/breakdown
パラメータ​
名前型入力説明必須例
dateStart文字列クエリリクエストされた日時範囲の開始時刻truedateStart=2020-03-01T00:00:00.000
dateEnd文字列クエリリクエストされた日時範囲の終了時刻truedateEnd=2020-03-31T23:59:59.000
currency列挙:
AUD
CAD
EUR
GBP
JPY
NZD
SGD
USD
KRW
CNY		クエリ財務指標を受け取る通貨コードtruecurrency=USD
timeZoneVariation列挙:
America/Chicago
Pacific/Honolulu
Australia/Sydney		クエリOlson形式で指定できる希望のタイムゾーンtruetimeZoneVariation=Australia/Sydney
accountId文字列パスあなたの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文字列クエリ要求された日時範囲の開始時刻truedateStart=2020-03-01T00:00:00.000
dateEnd文字列クエリ要求された日時範囲の終了時刻truedateEnd=2020-03-31T23:59:59.000
currency列挙:
AUD
CAD
EUR
GBP
JPY
NZD
SGD
USD
KRW
CNY		クエリ金銭的指標を受け取る通貨コード。truecurrency=USD
timeZoneVariation列挙:
America/Chicago
Pacific/Honolulu
Australia/Sydney		クエリ希望のタイムゾーンはこのパラメータを通して渡すことができます。オルソン形式である必要があります。truetimeZoneVariation=Australia/Sydney
accountId文字列パス 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文字列queryリクエストされた日付/時刻範囲の開始時間truedateStart=2020-03-01T00:00:00.000
dateEnd文字列queryリクエストされた日付/時刻範囲の終了時間truedateEnd=2020-03-31T23:59:59.000
currency列挙:
AUD
CAD
EUR
GBP
JPY
NZD
SGD
USD
KRW
CNY		query金銭的メトリックが受け取る通貨コード。truecurrency=USD
timeZoneVariation列挙:
America/Chicago
Pacific/Honolulu
Australia/Sydney		query希望するタイムゾーンはこのパラメータを通じて渡すことができます。オルソン形式でなければなりません。truetimeZoneVariation=Australia/Sydney
accountId文字列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
パラメータ​
名前タイプ入力説明必須例
dateStart文字列クエリリクエストされた日付/時刻範囲の開始時間truedateStart=2020-03-01T00:00:00.000
dateEnd文字列クエリリクエストされた日付/時刻範囲の終了時間truedateEnd=2020-03-31T23:59:59.000
currency列挙:
AUD
CAD
EUR
GBP
JPY
NZD
SGD
USD
KRW
CNY		クエリあなたが金銭的指標を受け取る通貨コード。truecurrency=USD
timeZoneVariation列挙:
America/Chicago
Pacific/Honolulu
Australia/Sydney		クエリ希望するタイムゾーンはこのパラメータを通じて渡すことができます。オルソン形式である必要があります。truetimeZoneVariation=Australia/Sydney
accountId文字列パス 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}
パラメータ​
名前種類所在地必須
accountId文字列パスtrue
campaignId文字列パスtrue
audienceId文字列パス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
パラメータ​
名前型入力説明必須例
dateStart文字列クエリ要求された日付/時間範囲の開始時刻truedateStart=2020-03-01T00:00:00.000
dateEnd文字列クエリ要求された日付/時間範囲の終了時刻truedateEnd=2020-03-31T23:59:59.000
currency列挙:
AUD
CAD
EUR
GBP
JPY
NZD
SGD
USD
KRW
CNY		クエリ金銭指標を受け取るための通貨コード。truecurrency=USD
timeZoneVariation列挙:
America/Chicago
Pacific/Honolulu
Australia/Sydney		クエリ希望するタイムゾーンはこのパラメータを通じて渡すことができます。オルソン形式である必要があります。truetimeZoneVariation=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文字列クエリ要求された日付/時間範囲の開始時間truedateStart=2020-03-01T00:00:00.000
dateEnd文字列クエリ要求された日付/時間範囲の終了時間truedateEnd=2020-03-31T23:59:59.000
currency列挙:
AUD
CAD
EUR
GBP
JPY
NZD
SGD
USD
KRW
CNY		クエリ金銭的指標を受け取る通貨コード。truecurrency=USD
timeZoneVariation列挙:
America/Chicago
Pacific/Honolulu
Australia/Sydney		クエリこのパラメーターを通じて望ましいタイムゾーンを指定できます。オルソン形式である必要があります。truetimeZoneVariation=Australia/Sydney
accountId文字列パス true 
campaignId文字列パス 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文字列クエリ要求された日付/時間範囲の開始時間truedateStart=2020-03-01T00:00:00.000
dateEnd文字列クエリ要求された日付/時間範囲の終了時間truedateEnd=2020-03-31T23:59:59.000
currency列挙:
AUD
CAD
EUR
GBP
JPY
NZD
SGD
USD
KRW
CNY		クエリ金銭的指標を受け取る通貨コード。truecurrency=USD
timeZoneVariation列挙:
America/Chicago
Pacific/Honolulu
Australia/Sydney		クエリ希望するタイムゾーンはこのパラメータを通じて渡すことができます。オルソン形式である必要があります。truetimeZoneVariation=Australia/Sydney
accountId文字列パス true 
campaignId文字列パス 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}
パラメーター​
名前型入力必須
accountIdStringpathtrue
campaignIdStringpathtrue

応答​

200 OK

{
  "accountId": "string",
  "campaignId": "string",
  "campaignName": "string",
  "campaignType": "string",
  "campaignObjective": "string",
  "countryCode": "string",
  "status": "string"
}

GET クリエイティブの概要​

指定された期間、タイムゾーン、および通貨に対するクリエイティブのパフォーマンス指標を返します。

説明​

指定された期間、タイムゾーン、および通貨に対するインプレッション、リファラル、コンバージョンなど、クリエイティブレベルのパフォーマンス指標を取得するためにこのAPIエンドポイントを呼び出します。

リクエスト​

パス​
GET /reporting/accounts/{accountId}/campaigns/{campaignId}/creatives/{creativeId}/overview
パラメータ​
名前タイプ場所説明必須例
dateStart文字列クエリリクエストされた日付/時間範囲の開始時間truedateStart=2020-03-01T00:00:00.000
dateEnd文字列クエリリクエストされた日付/時間範囲の終了時間truedateEnd=2020-03-31T23:59:59.000
currency列挙:
AUD
CAD
EUR
GBP
JPY
NZD
SGD
USD
KRW
CNY		クエリ金銭的指標を受け取る通貨コード。truecurrency=USD
timeZoneVariation列挙:
America/Chicago
Pacific/Honolulu
Australia/Sydney		クエリ希望するタイムゾーンはこのパラメータを通じて渡されます。オルソン形式である必要があります。truetimeZoneVariation=Australia/Sydney
accountId文字列パス true 
campaignId文字列パス true 
creativeId文字列path true 

レスポンス​

200 OK

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

GET クリエイティブの内訳​

指定された時間帯、タイムゾーン、および通貨に基づいて属性ごとに分解されたクリエイティブのパフォーマンス指標を返します。

説明​

特定のクリエイティブに関する詳細を取得するためにこのAPIエンドポイントを呼び出すことができます。これは、指定された時間帯、タイムゾーン、および通貨について、クエリ文字列で指定された属性に基づいています。「groupby」パラメーターを通じて呼び出すことができる属性は次のとおりです：

  • audience;

リクエスト​

パス​
GET /reporting/accounts/{accountId}/campaigns/{campaignId}/creatives/{creativeId}/breakdown
パラメータ​
名前型位置説明必須例
dateStart文字列クエリ要求された日付/時間範囲の開始時間truedateStart=2020-03-01T00:00:00.000
dateEnd文字列クエリ要求された日付/時間範囲の終了時間truedateEnd=2020-03-31T23:59:59.000
currency列挙:
AUD
CAD
EUR
GBP
JPY
NZD
SGD
USD
KRW
CNY		クエリ財務指標を受け取る通貨コードtruecurrency=USD
timeZoneVariation列挙:
America/Chicago
Pacific/Honolulu
Australia/Sydney		クエリこのパラメータを通じて希望するタイムゾーンを指定できます。Olson形式である必要があります。truetimeZoneVariation=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
}

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

説明​

このAPIエンドポイントを呼び出して、クリエイティブ名、タイトル、サブタイトル、テキスト、レスポンス、ステータスを含むクリエイティブメタデータを受信します。

リクエスト​

パス​
GET /metadata/accounts/{accountId}/campaigns/{campaignId}/creatives/{creativeId}
パラメータ​
名前種類入力必須
accountIdStringpathtrue
campaignIdStringpathtrue
creativeIdStringpathtrue

レスポンス​

200 OK

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