Reporting API - パブリッシャー

最終更新日: 2025年1月22日

概要

パブリッシャーとして、オファーウォール を提供するアプリのレポートデータを取得するために Reporting API を使用できます。

開始する前に: API を使用するには、こちらの手順に従って認証を行ってください。

• Reporting API を使ったコンテンツ管理の方法については、コンテンツ管理をご覧ください。
• Reporting API におけるエラー処理と制限事項については、Reporting API ベストプラクティスをご覧ください。

パブリッシャー向けレポート メトリックス

Reporting API を使用すると、オファーウォール コンテンツに関するパフォーマンスデータ（クリック数、コンバージョン数、総収益など）をリクエストできます。利用可能なすべてのパブリッシャー向けレポート メトリックスは、以下の表に示されています。

以下の基本クエリから始めて、パフォーマンス メトリックを取得することを推奨します:

{
  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	オファーウォール 広告でコンバージョンしたユニークユーザーの 1 日あたりの平均数（ユーザーごとに 24 時間に 1 回カウント）÷ 日数	x	x	x	x
arpdau	1 日あたりのアクティブユーザーごとの平均収益（総収益 ÷ 1 日あたりのアクティブユーザー数）	x	x	x
arpduv	オファーウォール を閲覧したユニークユーザーごとの平均収益（総収益 ÷ 1 日あたりのユニーク閲覧ユーザー数）	x	x	x
averageDau	1 日あたりのアクティブユーザーの平均数（ユーザーごとに 24 時間に 1 回カウント）÷ 日数	x	x	x
averageDuv	オファーウォール を閲覧したユニークユーザーの平均数（ユーザーごとに 24 時間に 1 回カウント）÷ 日数	x	x	x
clicks	プレースメントから発生したクリック数	x			x
conversions	プレースメントから発生したコンバージョン数	x			x
dailyActiveUsers	1 日あたりのアクティブユーザー数	x	x	x
dailyUniqueConversions	このプレースメントまたはコンテンツカードで広告をコンバージョンしたユニークユーザー数（ユーザーごとに 24 時間に 1 回カウント）。現在は オファーウォール コンテンツカードにのみ適用されます	x			x
dailyUniqueOfferwallEngagements	オファーウォール 広告でコンバージョンしたユニークユーザー数（ユーザーごとに 24 時間に 1 回カウント）	x	x	x
dailyUniqueOfferwallViewers	オファーウォール を閲覧したユニークユーザー数（ユーザーごとに 24 時間に 1 回カウント）	x	x	x
dailyUniqueViewers	このプレースメントまたはコンテンツカードで広告を閲覧したユニークユーザー数（ユーザーごとに 24 時間に 1 回カウント）。現在は オファーウォール コンテンツカードにのみ適用されます	x			x
ducduv	このプレースメントまたはコンテンツカードでコンバージョンしたユーザー数 ÷ このプレースメントまたはコンテンツカードを閲覧したユーザー数（どちらもユーザーごとに 24 時間に 1 回カウント）	x	x	x	x
duvDau	オファーウォール を閲覧したユニークユーザー数 ÷ 1 日あたりのアクティブユーザー数	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

メトリックのセグメンテーション

クエリにセグメントフィールドを追加することで、アプリ・プレースメント・国単位でパフォーマンスデータを分割して取得できます。

Reporting API がサポートするセグメントの内訳：

• country（国）
• id（アプリグループ ID）
• id（パブリッシャーアプリ ID）
• placement（プレースメント）

セグメンテーションの例

国ごとのセグメント

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

アプリグループごとのセグメント

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

パブリッシャーアプリごとのセグメント

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

プレースメントごとのセグメント

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

フィルター機能

クエリにフィルターを追加すると、指定したソースのみに基づいてパフォーマンス メトリックを取得できます。Reporting API は以下のフィルターに対応しています：

• appId（単一のアプリ）
• apps（複数のアプリ）
• content
• timePreset
• timeRange

フィルターの例

アプリでフィルター

この場合、結果は一つのアプリのみになります

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

複数のアプリでフィルター

この場合、結果は first または last 数分の Apps になります

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

コンテンツカードでフィルター

この場合、ケッkは一つの Content Card 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 を含めてください。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 を含めてください。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 から削除されます。Tapjoy の Offerwall からデータを取得する際にエラーを防ぐため、API クエリで 太字 のディメンションを参照しないようにしてください。

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