- HTTP リクエスト
- パスパラメータ
- リクエストの本文
- レスポンスの本文
- 認可スコープ
- MediationReportSpec
- ディメンション
- 指標
- DimensionFilter
- SortCondition
- 例
- 試してみる
指定されたレポート仕様に基づいて AdMob メディエーション レポートを生成します。サーバーサイド ストリーミング RPC の結果を返します。結果はレスポンスのシーケンスで返されます。
HTTP リクエスト
POST https://admob.googleapis.com/v1beta/{parent=accounts/*}/mediationReport:generate
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ | |
---|---|
parent |
レポートを生成するアカウントのリソース名。例: accounts/pub-9876543210987654 |
リクエスト本文
リクエストの本文には、次の構造のデータが含まれます。
JSON 表現 |
---|
{
"reportSpec": {
object ( |
フィールド | |
---|---|
reportSpec |
ネットワーク レポートの仕様。 |
レスポンスの本文
AdMob メディエーション レポートのストリーミング レスポンス。最初のレスポンスにはレポート ヘッダーが含まれ、次に行のレスポンスのストリームが含まれ、最後に最後のレスポンス メッセージとしてのフッターが含まれます。
次に例を示します。
[{
"header": {
"dateRange": {
"startDate": {"year": 2018, "month": 9, "day": 1},
"endDate": {"year": 2018, "month": 9, "day": 1}
},
"localizationSettings": {
"currencyCode": "USD",
"languageCode": "en-US"
}
}
},
{
"row": {
"dimensionValues": {
"DATE": {"value": "20180918"},
"APP": {
"value": "ca-app-pub-8123415297019784~1001342552",
"displayLabel": "My app name!"
}
},
"metricValues": {
"ESTIMATED_EARNINGS": {"decimal_value": "1324746"}
}
}
},
{
"footer": {"matchingRowCount": 1}
}]
成功した場合、レスポンスの本文には次の構造のデータが含まれます。
JSON 表現 |
---|
{ // Union field |
フィールド | |
---|---|
共用体フィールド payload 。各ストリームのレスポンス メッセージには、1 種類のペイロードが含まれます。payload は次のいずれかになります。 |
|
header |
レポートの期間やローカライズの設定など、レポートの内容を説明するレポート生成設定。 |
row |
実際のレポートデータ。 |
footer |
生成されたレポートに関する追加情報(データに関する警告など)。 |
認可スコープ
次の OAuth スコープのいずれかが必要です。
https://www.googleapis.com/auth/admob.readonly
https://www.googleapis.com/auth/admob.report
詳細については、OAuth 2.0 の概要をご覧ください。
MediationReportSpec
AdMob メディエーション レポートを生成するための仕様。たとえば、「US」と「CN」の国について、広告ソースとアプリ別にスライス化された実測 ECPM を取得するための仕様は、次の例のようになります。
{
"dateRange": {
"startDate": {"year": 2021, "month": 9, "day": 1},
"endDate": {"year": 2021, "month": 9, "day": 30}
},
"dimensions": ["AD_SOURCE", "APP", "COUNTRY"],
"metrics": ["OBSERVED_ECPM"],
"dimensionFilters": [
{
"dimension": "COUNTRY",
"matchesAny": {"values": [{"value": "US", "value": "CN"}]}
}
],
"sortConditions": [
{"dimension":"APP", order: "ASCENDING"}
],
"localizationSettings": {
"currencyCode": "USD",
"languageCode": "en-US"
}
}
わかりやすくするために、上記の仕様を次の疑似 SQL のように扱うことができます。
SELECT AD_SOURCE, APP, COUNTRY, OBSERVED_ECPM
FROM MEDIATION_REPORT
WHERE DATE >= '2021-09-01' AND DATE <= '2021-09-30'
AND COUNTRY IN ('US', 'CN')
GROUP BY AD_SOURCE, APP, COUNTRY
ORDER BY APP ASC;
JSON 表現 |
---|
{ "dateRange": { object ( |
フィールド | |
---|---|
dateRange |
レポートが生成される期間。 |
dimensions[] |
レポートのディメンションのリスト。これらのディメンションの値の組み合わせによって、レポートの行が決まります。ディメンションが指定されていない場合、レポートにはアカウント全体のリクエストされた指標が 1 行で返されます。 |
metrics[] |
レポートの指標のリスト。レポートには少なくとも 1 つの指標を指定する必要があります。 |
dimensionFilters[] |
ディメンション値に基づいて照合するレポートの行を示します。 |
sortConditions[] |
レポートの行の並べ替えについて説明します。リスト内の条件の順序によって優先順位が定義されます。条件が早ければ早いほど優先順位が高くなります。並べ替え条件が指定されていない場合、行の順序は定義されません。 |
localizationSettings |
レポートのローカライズ設定。 |
maxReportRows |
返されるレポートデータ行の最大数。値が設定されていない場合、API は 100,000 を上限としてできるだけ多くの行を返します。有効な値は 1 ~ 100, 000(両端を含む)です。値が 100,000 を超えるとエラーが返されます。 |
timeZone |
レポートのタイムゾーン。IANA TZ 名の値(「America/Los_Angeles」など)を受け入れます。タイムゾーンが定義されていない場合は、アカウントのデフォルトが適用されます。アカウント取得アクションでデフォルト値を確認します。 警告: 現時点でサポートされている値は「America/Los_Angeles」のみです。 |
ディメンション
メディエーション レポートのディメンション。ディメンションとは、定量的測定値(指標)を特定の属性(広告フォーマットや広告が表示されたプラットフォームなど)ごとに分類したり、絞り込んだりするためのデータ属性です。
列挙型 | |
---|---|
DIMENSION_UNSPECIFIED |
設定されていないフィールドのデフォルト値。使用しないでください。 |
DATE |
YYYYMMDD 形式の日付(例: 20210701)。リクエストで指定できる時間ディメンションは 1 つまでです。 |
MONTH |
YYYYMM 形式の月(例: 202107)。リクエストで指定できる時間ディメンションは 1 つまでです。 |
WEEK |
週の初日の日付。YYYYMMDD 形式で指定します(例: 20210701)。リクエストで指定できる時間ディメンションは 1 つまでです。 |
AD_SOURCE |
広告ソースの一意の ID(ラベル値として「5450213213286189855」や「AdMob Network」など)。 |
AD_SOURCE_INSTANCE |
広告ソース インスタンスの一意の ID(ラベル値として「ca-app-pub-1234:asi:5678」や「AdMob(デフォルト)」など)。 |
AD_UNIT |
広告ユニットの一意の ID(例: 「ca-app-pub-1234/8790」)。AD_UNIT ディメンションが指定されている場合、APP が自動的に含まれます。 |
APP |
モバイルアプリの一意の ID(例: ca-app-pub-1234~1234)。 |
MEDIATION_GROUP |
メディエーション グループの一意の ID(ラベル値として「ca-app-pub-1234:mg:1234」や「AdMob(デフォルト)」など)。 |
COUNTRY |
広告が表示またはクリックされる場所の CLDR 国コード(「US」や「FR」など)。これは地域ディメンションです。 |
FORMAT |
広告ユニットの形式(「バナー」、「ネイティブ」など)。広告配信ディメンション。 |
PLATFORM |
アプリのモバイル OS プラットフォーム(「Android」、「iOS」など)。 |
MOBILE_OS_VERSION |
モバイル オペレーティング システムのバージョン(「iOS 13.5.1」など)。 |
GMA_SDK_VERSION |
GMA SDK のバージョン(「iOS 7.62.0」など)。 |
APP_VERSION_NAME |
Android の場合、アプリのバージョン名は PackageInfo の versionName で確認できます。iOS の場合、アプリのバージョン名は CFBundleShortVersionString にあります。 |
SERVING_RESTRICTION |
広告配信の制限モード(「非パーソナライズド広告」など)。 |
指標
メディエーション レポートの指標。指標とは、パブリッシャーのビジネスのパフォーマンスを示す定量的な測定値である。これらは個々の広告イベントから集計され、レポートのディメンションごとにグループ化されます。指標の値は、整数または小数(丸めなし)です。
列挙型 | |
---|---|
METRIC_UNSPECIFIED |
設定されていないフィールドのデフォルト値。使用しないでください。 |
AD_REQUESTS |
リクエスト数。値は整数です。 |
CLICKS |
ユーザーが広告をクリックした回数。値は整数です。 |
ESTIMATED_EARNINGS |
AdMob パブリッシャーの推定収益額。収益指標の通貨単位(USD、EUR など)は、通貨のローカライズ設定によって決まります。金額はマイクロ秒単位です。たとえば、$6.50 は 6500000 になります。 メディエーション グループごと、および広告ソースのインスタンス レベルごとの推定収益額は、2019 年 10 月 20 日からサポートされています。2019 年 10 月 20 日より前の日付については、第三者の推定収益額は「0」と表示されます。 |
IMPRESSIONS |
ユーザーに表示された広告の合計数。値は整数です。 |
IMPRESSION_CTR |
インプレッション数に対するクリック数の比率。値は倍精度(近似)10 進値です。 |
MATCHED_REQUESTS |
リクエストへのレスポンスとして広告が返される回数。値は整数です。 |
MATCH_RATE |
広告リクエスト数全体に対する、一致した広告リクエスト数の割合です。値は倍精度(近似)10 進値です。 |
OBSERVED_ECPM |
第三者広告ネットワークの推定平均 eCPM。収益指標の通貨単位(USD、EUR など)は、通貨のローカライズ設定によって決まります。金額はマイクロ秒単位です。たとえば、2.30 ドルは 2300000 になります。 メディエーション グループおよび広告ソースのインスタンス レベルごとの推定平均 eCPM は、2019 年 10 月 20 日からサポートされています。2019 年 10 月 20 日より前の日付については、第三者の推定平均 eCPM は「0」と表示されます。 |
DimensionFilter
ディメンション値に基づいて照合するレポートの行を示します。
JSON 表現 |
---|
{ "dimension": enum ( |
フィールド | |
---|---|
dimension |
指定したディメンションにフィルタ条件を適用します。 |
共用体フィールド operator 。適用するフィルタ演算子。operator は次のいずれかになります。 |
|
matchesAny |
指定されたディメンションの値がこの条件で指定されたいずれかの値に含まれている場合、行を照合します。 |
SortCondition
ディメンションまたは指標に適用される並べ替えの方向。
JSON 表現 |
---|
{ "order": enum ( |
フィールド | |
---|---|
order |
ディメンションまたは指標の並べ替え順序。 |
共用体フィールド sort_on 。並べ替える値を指定します。sort_on は次のいずれかになります。 |
|
dimension |
指定したディメンションで並べ替えます。 |
metric |
指定した指標で並べ替えます。 |