您可以使用 Publisher Summary API 提取效果数据。了解如何生成效果数据报告。 

第 1 步：使用访问令牌进行身份验证。

您需要访问令牌才能开始使用 Publisher Summary API。要获取访问令牌，您必须准备好用于登录 Moloco Publisher 门户的电子邮件地址和密码以及平台 ID。 

准备好电子邮件地址和密码

注册后，您会收到 Moloco 发送的电子邮件，要求您为账户创建密码。如果在用于注册我们账户的电子邮件地址的收件箱中没有收到此电子邮件，请联系您的 Moloco 代表寻求帮助。按照电子邮件中的说明创建密码。 

在 Moloco Publisher 门户中查找并复制平台 ID

要查找平台 ID，登录 Moloco Publisher 门户，在左侧边栏中点击 Publisher setting。查找并复制账户的平台 ID。

发出 API 请求以生成访问令牌

获得电子邮件地址、密码和平台 ID 后，您必须发出 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

返回的响应包含使用 Publisher Summary API 端点时需要包含在标头中的 Token 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 步：为 Publisher Summary 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
}
]

可用指标

您必须在请求正文中包含以下一个或多个指标。 

可用维度

您必须在请求正文中包含以下一个或多个维度。

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"]
}]
}

此示例请求在响应中返回 App Key 为 <moloco-app-id> 的 App 自 2023 年 6 月 10 日至 2023 年 6 月 15 日来自加拿大和美国的总收入金额和总展示次数，按日期和广告单元 ID 分组。 

按一个或多个维度和/或指标分组和排列数据

您可以按一个或多个可用维度和/或指标对数据分组。以下示例请求在响应中返回广告填充率和总点击次数，按日期和 App Key 分组，日期按最早到最近显示，填充率从最大到最小显示。

{
"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 日起按日期和操作系统类型分组的收入金额的示例请求。

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 时区来提取和显示数据集。虽然大多数数据都是实时可用的，但部分数据可能需要几个小时才能提供。因此，预计在记录数据当天的 UTC 时间午夜后的 6 小时内，即可获取一整天的数据。 

服务级别协议

我们会在问题首次报告之日起三个工作日内针对 Publisher 提出的问题发布修补程序。