指定された仕様に基づいてキャンペーン レポートを生成します。
HTTP リクエスト
POST https://admob.googleapis.com/v1beta/{parent=accounts/*}/campaignReport:generate
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ | |
---|---|
parent |
レポートを生成するアカウントのリソース名。例: accounts/pub-9876543210987654 |
リクエスト本文
リクエストの本文には、次の構造のデータが含まれます。
JSON 表現 |
---|
{
"reportSpec": {
object ( |
フィールド | |
---|---|
reportSpec |
キャンペーン レポート仕様。 |
レスポンスの本文
Campaign Report API レスポンス。
成功すると、レスポンスの本文に次の構造のデータが含まれます。
JSON 表現 |
---|
{
"rows": [
{
object ( |
フィールド | |
---|---|
rows[] |
指定したパブリッシャーのキャンペーン レポートデータ。API から最大 100,000 行が返されます。 |
認可スコープ
次の OAuth スコープのいずれかが必要です。
https://www.googleapis.com/auth/admob.readonly
https://www.googleapis.com/auth/admob.report
詳細については、OAuth 2.0 の概要をご覧ください。
CampaignReportSpec
キャンペーン レポートを生成するための仕様。たとえば、インプレッションとクリックを CAMPAIGN_ID でスライスする仕様は次のようになります。
{
"dateRange": {
"startDate": {"year": 2021, "month": 12, "day": 1},
"endDate": {"year": 2021, "month": 12, "day": 30}
},
"dimensions": ["CAMPAIGN_ID"],
"metrics": ["IMPRESSIONS", "CLICKS"],
}
JSON 表現 |
---|
{ "dateRange": { object ( |
フィールド | |
---|---|
dateRange |
レポートが生成される期間。最大範囲は 30 日です。 |
dimensions[] |
レポートのディメンションのリスト。これらのディメンションの値の組み合わせによって、レポートの行が決まります。ディメンションを指定しないと、アカウント全体に対してリクエストされた指標が 1 行で返されます。 |
metrics[] |
レポートの指標のリスト。レポートでは少なくとも 1 つの指標を指定する必要があります。 |
languageCode |
ローカライズされたテキストに使用される言語(該当するディメンション値など)。言語タグは IETF BCP47 で定義されています。指定されていない場合または無効な場合、デフォルトは「en-US」です。 |
ディメンション
キャンペーン レポートのディメンション。
列挙型 | |
---|---|
DIMENSION_UNSPECIFIED |
未指定のディメンションのデフォルト値。使用しないでください。 |
DATE |
YYYYMMDD 形式の日付(例: 20210701)。 |
CAMPAIGN_ID |
キャンペーンの一意の ID(例: 123456789)。キャンペーン リスト API のキャンペーン ID と一致します。 |
CAMPAIGN_NAME |
キャンペーンの名前です。 |
AD_ID |
広告の一意の ID(例: 「123456789」)。 |
AD_NAME |
広告の名前。一意ではありません。 |
PLACEMENT_ID |
広告が表示されるアプリのベンダー固有の一意の ID です。たとえば、Android の場合は com.goog.bar、iOS の場合は 123456789 です。 |
PLACEMENT_NAME |
広告が表示されるアプリの名前。 |
PLACEMENT_PLATFORM |
広告が表示されるアプリのプラットフォーム。 |
COUNTRY |
対象国の名前。 |
FORMAT |
広告ユニットのフォーマット(「バナー」、「ネイティブ」など)、広告配信ディメンション。 |
指標
キャンペーン レポートの指標。
列挙型 | |
---|---|
METRIC_UNSPECIFIED |
未設定のフィールドのデフォルト値。使用しないでください。 |
IMPRESSIONS |
広告がユーザーに表示された回数。 |
CLICKS |
ユーザーが広告をクリックした回数。 |
CLICK_THROUGH_RATE |
「広告がクリックされた回数」を「広告の表示回数」で割った値です。 |
INSTALLS |
アプリがデバイスにダウンロードされた回数です。 |
ESTIMATED_COST |
収益を得ている広告ではなく、キャンペーンの広告を配信するための推定費用。通貨はキャンペーンのレポート通貨です。 |
AVERAGE_CPI |
平均インストール単価。新規ユーザーの獲得にかかった平均費用です。通貨はキャンペーンのレポート通貨です。 |
INTERACTIONS |
ユーザーが広告を操作した回数。(クリック数とエンゲージメント数)。 |