パブリッシャーサマリーAPIを使用してパフォーマンスデータを取得できます。パフォーマンスデータレポートを生成する方法を学んでください。 

手順1：アクセストークンを使用して認証する。

パブリッシャーサマリーAPIの使用を開始するには、アクセストークンが必要です。アクセストークンを取得するには、MolocoパブリッシャーポータルにサインインするためのメールアドレスおよびパスワードとプラットフォームIDを準備する必要があります。 

メールアドレスとパスワードを準備する

登録を済ませると、Molocoからアカウントのパスワードを作成するためのメールが届きます。アカウントの登録に使用したメールアドレスの受信トレイにこのメールが届いていない場合は、Molocoの担当者までお問い合わせください。メールに記載されている指示に従ってパスワードを作成します。 

MolocoパブリッシャーポータルでプラットフォームIDを見つけてコピーする

プラットフォームIDを見つけるには、Molocoパブリッシャーポータルにサインインし、左サイドバーの [Publisher setting] をクリックします。お使いのアカウントのプラットフォームIDを見つけてコピーします。

APIリクエストを実行してアクセストークンを生成する

メールアドレス、パスワード、プラットフォームの準備ができたら、APIリクエストを実行してアクセストークンを生成します。以下のリクエスト例では、emailにメールアドレス、passwordにパスワード、workplace_idにプラットフォームIDをそれぞれ入力する必要があります。 

curl --request POST \
--url https://managefnt.adsmoloco.com/api/adcloud/publisher/v1/auth/tokens \
--header 'accept: application/json' \
--header 'content-type: application/json' \

--data @- <<EOF
{
"email": "<your-email-address-here>",
"password": "<your-password-here>",
"workplace_id": "<your-platform-id-here>"
}
EOF

返されるレスポンスには、パブリッシャーサマリーAPIエンドポイントを使用する際にヘッダーに含める必要があるトークンIDが含まれています。このトークンは最大で60分間有効で、その期間を過ぎたら、新しいAPIリクエストを実行して新しいアクセストークンを生成する必要があります。

{
"token": "your-token-here"
}

トークンが期限切れになる前に、以下のAPIリクエストに既存のトークンを含めて実行すると、新しいトークンがレスポンスで返されます。以下のリクエスト例を見ればわかるように、認証を必要とするAPIリクエストを実行する際には、アクセストークンをベアトークンとして含める必要があります。 

curl --request PUT \
--url https://managefnt.adsmoloco.com/api/adcloud/publisher/v1/auth/tokens \
--header 'Authorization: Bearer <your-token-here>' \
--header 'accept: application/json'

手順2：パブリッシャーサマリーAPIエンドポイントに対してAPIリクエストを実行する。

以下のAPIエンドポイントを使用する必要があります。

POST https://managefnt.adsmoloco.com/api/adcloud/publisher/v1/sdk/summary

必須プロパティ

以下のプロパティをリクエスト本文に含める必要があります。

"date_range": {
"start": "YYYY-MM-DD",
"end": "YYYY-MM-DD"
}

"dimension_filters": [
{
"dimension": "<DIMENSION_NAME>",
"values": ["string"]
}
]

"order_by": [
{
"dimension" | "metric": "<DIMENSION_NAME> | <METRIC_NAME>",
"is_descending": true|false
}
]

利用可能な指標

以下の指標のうち1つ以上をリクエスト本文に含める必要があります。 

利用可能な次元

以下の次元のうち1つ以上をリクエスト本文に含める必要があります。

YYYY-MM-DD HH:mm:SS +0000 UTC

リクエスト本文

リクエスト本文は以下のような形式でなければなりません。

{
"publisher_id": "<MOLOCO-PUBLISHER-ID>",
"date_range": {
"start": "YYYY-MM-DD",
"end": "YYYY-MM-DD"
},
"dimensions": ["<DIMENSION_NAME>"],
3
"metrics": ["<METRIC_NAME>"],
"dimension_filters": [
{
"dimension": "<DIMENSION_NAME>",
"values": ["string"]
}
],
"order_by": [
{
"dimension" | "metric": "<DIMENSION_NAME> | <METRIC_NAME>",
"is_descending": true|false
}
]
}

以下のリクエスト例は、2023年6月10日から2023年6月11日までの合計レベニューをレスポンスで返します。

curl --request POST \
--url https://managefnt.adsmoloco.com/api/adcloud/publisher/v1/sdk/summary \
4
--header 'content-type: application/json' \
--header 'Authorization: Bearer <your-token-here>' \
--data @- <<EOF
{
"publisher_id": "<your-publisher-id>",
"date_range": {
"start": "2023-06-10",
"end": "2023-06-11"
},
"dimensions": ["UTC_DATE"],
"metrics": ["REVENUE"]
}
EOF

データの絞り込み

データにフィルターを適用して、データのサブセットのみを取得できます。以下の例に示すように、利用可能な任意の次元をフィルターとして指定できます。 

{
"publisher_id": "<your-publisher-id>",
"date_range": {
"start": "2023-06-10",
"end": "2023-06-15"
6
},
"dimensions": ["UTC_DATE", "AD_UNIT_ID"],
"metrics": ["REVENUE", "IMPRESSIONS"],
"dimension_filters":[
{
"dimension": "PUBLISHER_APP_ID",
"values": [ "<moloco-app-id>"]
},{
"dimension": "GEO_COUNTRY",
"values": ["USA", "CAN"]
}]
}

このリクエスト例は、2023年6月10日から2023年6月15日までの、カナダと米国での、アプリキー<moloco-app-id>のアプリについての、日付と広告ユニットIDでグループ化された合計レベニューと合計インプレッション数をレスポンスで返します。 

1つ以上の次元および/または指標でデータをグループ化および整理する

データは、利用可能な1つ以上の次元および/または指標でグループ化できます。以下のリクエスト例は、日付とアプリキー別の広告フィルレートと合計クリック数をレスポンスで返します。日付は古いものから順番に、フィルレートは高いものから順番に表示されます。

{
"publisher_id": "<your-publisher-id>",
"date_range": {
"start": "2023-06-10",
"end": "2023-06-11"
},
"dimensions": ["UTC_DATE", "PUBLISHER_APP_ID"],
"metrics": ["FILL_RATE", "CLICKS"],
"order_by": [{
"dimension": "TIME_BUCKET",
"is_descending": false
}, {
"metric": "FILL_RATE",
"is_descending": true
}]
}

レスポンス本文

APIリクエストから返されるレスポンスは以下のように書式設定されます。APIリクエストで指定した次元および/または指標のみがレスポンスで返されます。

{
"rows": [
{
"utc_time_bucket": "YYYY-MM-DD",
"app": {
"app_id": "<moloco-app-id-in-inventory-sheet>",
"app_title": "<pretty-app-name>"
},
"ad_unit": {
"ad_unit_id": "<moloco-ad-unit-id-in-inventory-sheet>",
"ad_unit_title": "<pretty-ad-unit-name>",
"inventory_type": "BANNER" | "INTERSTITIAL" | "REWARD_VIDEO",
"bidfloor": string
},
"device": {
"os": "IOS" | "ANDROID"
},
"geo": {
"country": "<ISO 3166-1 alpha-3 country code>"
},
"metric": {
"revenue": float64,
"impressions": int64,
"requests": int64,
"clicks": int64,
"ecpm": float64,
"fill_rate": float64
}
}
]
}

Metrics

次元

YYYY-MM-DD HH:mm:SS +0000 UTC

2023年6月10日からの日付およびOSタイプ別のレベニューを取得するリクエスト例を以下に示します。

curl --request POST \
--url https://managefnt.adsmoloco.com/api/adcloud/publisher/v1/sdk/summary \
--header 'content-type: application/json' \
--header 'Authorization: Bearer <your-token-here>' \
--data @- <<EOF
{
"publisher_id": "<your-publisher-id>",
"date_range": {
"start": "2023-06-10",
"end": "2023-06-10"
},
"dimensions": ["UTC_DATE", "DEVICE_OS"],
"metrics": ["REVENUE"]
}
EOF

返されるレスポンスには、リクエストした情報のみが含まれます。 

{
"rows": [
{
"utc_time_bucket": "2023-06-10 00:00:00 +0000 UTC",
"device": {
"os": "IOS"
},
"metric": {
"revenue": 100.01
}
}, {
"utc_time_bucket": "2023-06-10 00:00:00 +0000 UTC",
"device": {
"os": "ANDROID"
},
"metric": {
"revenue": 99.99
}
}
]
}

タイムゾーンと利用可能性

当社は、データセットの取得および表示にUTCタイムゾーンを使用します。ほとんどのデータはリアルタイムで利用できますが、一部のデータは利用可能になるまでに数時間かかる場合があります。そのため、1日分のデータが利用可能になるのは、データが記録された日の真夜中（UTC）の最大6時間後になることがあります。 

サービスレベル契約

当社は、パブリッシャーから提起された問題の修正を、その問題が最初に報告されてから3営業日以内にリリースします。