Reporting API - 开发者

上次更新时间：2025年1月22日

概览

作为开发者，您可以使用Reporting API检索使用Offerwall的应用的报告数据。

**开始之前：**您必须按照此处的步骤使用API进行身份验证。

有关如何通过Reporting API管理内容的信息，请参阅内容管理。
有关 Reporting API 的错误处理和限制信息，请参阅Reporting API 最佳实践。

开发者报告指标

Reporting API 可用于请求您的Offerwall的效果数据，包括点击次数、转化次数和总收入等指标。所有可用的开发者报告指标均列于下表。

我们建议开发者首先使用以下基本查询来检索效果指标：

{
  publisher {
    placements(appId: "00000000-0000-0000-0000-000000000000") {
      id
      name
      insights(
        timeRange: {from: "YYYY-MM-DDT00:00:00Z", until: "YYYY-MM-DDT00:00:00Z"}
      ) {
        timestamps
        reports {
          dailyUniqueViewers
          earnings
        }
      }
    }
  }
}

开发者指标	描述	国家/地区	应用组	开发者应用	展示位置
averageDuc	在应用、展示位置或广告内容中的积分墙广告上转化的平均唯一用户数（每位用户每24小时计算一次）除以天数	x	x	x	x
arpdau	每位每日活跃用户的平均收入（总收入除以每日活跃用户数）	x	x	x
arpduv	每位每日唯一积分墙浏览者的平均收入（总收入除以应用中浏览积分墙的唯一用户数（每位用户每 24 小时统计一次）	x	x	x
averageDau	平均每日活跃用户数（每位用户每 24 小时统计一次）除以天数	x	x	x
averageDuv	应用中浏览积分墙的唯一用户数（每位用户每 24 小时统计一次）除以天数	x	x	x
clicks	源自展示位置的点击次数	x			x
converts	源自展示位置的转化次数	x			x
dailyActiveUsers	每日活跃用户数	x	x	x
dailyUniqueConversions	通过此展示位置或内容卡上的广告进行转化的用户数（每位用户每 24 小时统计一次）。目前仅适用于积分墙内容卡	x			x
dailyUniqueOfferwallEngagements	在应用中通过积分墙广告进行转化的唯一用户数（每位用户每 24 小时计算一次）	x	x	x
dailyUniqueOfferwallViewers	在应用中浏览积分墙的唯一用户数（每位用户每 24 小时计算一次）	x	x	x
dailyUniqueViewers	在此展示位置或广告内容中浏览广告的唯一用户数（每位用户每 24 小时计算一次）。目前仅适用于积分墙广告内容	x			x
ducduv	在此展示位置或广告内容中通过广告进行转化的用户数（每位用户每 24 小时计算一次）除以在此展示位置或广告内容中浏览广告的用户数（每位用户每 24 小时计算一次）	x	x	x	x
duvDau	在应用中查看过积分墙的独立用户数（每位用户每 24 小时统计一次）除以日活跃用户数	x	x	x
earnings	总收入	x			x
impressions	源自展示位置的展示次数	x			x
newUsers	新用户数	x	x	x
offerwallViews	打开积分墙的总数	x	x	x
sessions	应用打开次数	x	x	x
totalRevenue	总收入	x	x	x

后台中提供的其他开发者指标：

展示次数/浏览量
转化率 (CVR)
eCPM

指标细分

通过在查询中添加细分字段，API 可以返回按应用、展示位置和/或国家/地区细分的效果数据。

报告 API 支持按以下细分进行细分：

国家/地区
ID（应用组ID）
ID（开发者应用ID）
展示位置

细分示例

按国家/地区细分

Query

Result

{
  publisher {
    placements(appId: "00000000-0000-0000-0000-000000000000") {
      id
      insights(timePreset: TODAY) {
        timestamps
        reports {
          country
          dailyUniqueViewers
        }
      }
    }
  }
}

按应用组细分

Query

Result

{
  publisher {
    apps(first: 3) {
      nodes {
        appGroupId
        insights(timePreset: TODAY) {
          reports {
            dailyActiveUsers
          }
        }
      }
    }
  }
}

按开发者应用细分

Query

Result

query {
  publisher {
  apps(first:3) {
      edges {
        node {
          name
          insights(timePreset:TODAY) {
            reports {
              dailyActiveUsers
            }
          }
        }
      }
    }
  }
}

按展示位置细分

Query

Result

{
  publisher{
    placements(appId: "00000000-0000-0000-0000-000000000000") {
      id
      name
      insights(timePreset: TODAY) {
        reports {
          impressions
        }
        timestamps
      }
    }
  }
}

过滤功能

通过在查询中添加过滤器，API 将仅返回指定来源的性能指标。报告 API 支持以下过滤功能：

appId（单个应用）
apps（多个应用）
content
timePreset
timeRange

过滤示例

按应用过滤

这会将结果限制为单个应用

{
  publisher{
    app(id: "<app ID>") {
      id
      name
      insights(timePreset: TODAY) {
        reports {
          arpdau
        }
        timestamps
      }
    }
  }
}

过滤多个应用程序

这将结果限制为_first_ 或者 last x个应用程序

{
  publisher {
    apps(first: 3) {
      nodes {
        id
        platform
        insights {
          reports {
            arpdau
            totalRevenue
          }
        }
      }
    }
  }
}

按广告内容过滤

这会将结果限制为单个广告内容ID

{
  publisher {
    placements(appId: "<app ID>") {
      id
      name
      content(id: "<content ID>") {
        id
        type
        insights(timePreset: TODAY) {
        timestamps
          reports {
            earnings
          }
        }
      }
    }
  }
}

按预设时间范围过滤

这会将结果限制在预设时间范围内。这是一个相对时间范围，结果会根据查询的运行时间而变化。

选项：LAST_30D、LAST_WEEK、TODAY、YESTERDAY。

注意：要定义数据聚合级别，请包含timeIncrement，其值可以是_DAILY_、HOURLY、MONTHLY。timeIncrement 是可选参数，默认为_ALL_

{
  publisher {
    placements(appId: “<app ID>”) {
      content(id: “<content card ID>") {
        insights(timePreset:LAST_30D, timeIncrement: DAILY) {
        timestamps
          reports {
            dailyUniqueViewers
          }
        }
      }
    }
  }
}

按绝对时间范围过滤

这会将结果限制在指定的绝对时间范围内。

最大范围为 3 个月，支持的最早日期为 2 年前。

注意：要定义数据聚合级别，请添加 timeIncrement，其值可以是 DAILY、HOURLY 和 MONTHLY。timeIncrement 是可选参数，默认为 ALL

{
  publisher {
    placements(appId: “<app ID>”) {
      content(id: “<content card ID>") {
        insights(timeRange: {from: "2024-11-15T00:00:00Z", until: "2024-11-17T00:00:00Z"}, timeIncrement: DAILY) {
        timestamps
          reports {
            dailyUniqueViewers
          }
        }
      }
    }
  }
}

已弃用的维度

以下旧版维度将于 2025 年 2 月 3 日从 Reporting API 中移除。请确保您的 API 查询不引用下方粗体列出的任何维度，以免从 Tapjoy 的 offerwall 获取数据时出现错误。

Objects > ContentCard > ecpmSettings

Enums > PublisherContentType:

ANNOUNCEMENT
DIRECT_PLAY_HOUSE_AD
FEATURED
FSI_HOUSE_AD
IAP_PROMOTION
INTERSTITIAL_VIDEO
MEDIATED_DIRECT_PLAY
MEDIATED_FSI
PREVIEW_CODE
PROGRAMMATIC_INTERSTITIAL_VIDEO
PROGRAMMATIC_REWARDED_VIDEO
REWARDED_VIDEO
TJ_RECOMMENDED
REWARD_UNLOCK

Input Objects > CreatePlacementAndContentSetInput > ecpmSettingsToAdd

Input Objects > UpdatePlacementAndContentSetInput:

ecpmSettingsToAdd
ecpmSettingsToDelete
ecpmSettingsToUpdate

Reporting API - 开发者
概览
开发者报告指标
指标细分
过滤功能
已弃用的维度

Reporting API - 开发者

概览

开发者报告指标

指标细分

细分示例

按国家/地区细分

按应用组细分

按开发者应用细分

按展示位置细分

过滤功能

过滤示例

按应用过滤

过滤多个应用程序

按广告内容过滤

按预设时间范围过滤

按绝对时间范围过滤

已弃用的维度

Contents