Method: accounts.campaignReport.generate

指定された仕様に基づいてキャンペーン レポートを生成します。

HTTP リクエスト

POST https://admob.googleapis.com/v1beta/{parent=accounts/*}/campaignReport:generate

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
parent

string

レポートを生成するアカウントのリソース名。例: accounts/pub-9876543210987654

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現 
{
  "reportSpec": {
    object (CampaignReportSpec)
  }
}
フィールド
reportSpec

object (CampaignReportSpec)

キャンペーン レポートの仕様。

レスポンスの本文

Campaign Report API レスポンス。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "rows": [
    {
      object (ReportRow)
    }
  ]
}
フィールド
rows[]

object (ReportRow)

指定されたパブリッシャーのキャンペーン レポート データ。API から返される行数は最大 100,000 行です。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/admob.readonly
  • https://www.googleapis.com/auth/admob.report

詳細については、OAuth 2.0 Overview をご覧ください。

CampaignReportSpec

キャンペーン レポートを生成するための仕様。たとえば、CAMPAIGN_ID でスライスされた IMPRESSIONS と CLICKS を取得するための仕様は、次の例のようになります。

{
  "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)
  },
  "dimensions": [
    enum (Dimension)
  ],
  "metrics": [
    enum (Metric)
  ],
  "languageCode": string
}
フィールド
dateRange

object (DateRange)

レポートが生成される期間。最長期間は 30 日です。
dimensions[]

enum (Dimension)

レポートのディメンションのリスト。これらのディメンションの値の組み合わせにより、レポートの行が決まります。ディメンションが指定されていない場合、レポートはアカウント全体に対してリクエストされた指標の単一行を返します。
metrics[]

enum (Metric)

レポートの指標のリスト。少なくとも 1 つの指標を選択する必要があります。
languageCode

string

特定のディメンション値など、ローカライズされたテキストに使用される言語。言語タグは 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 インストール単価の平均額です。これは新規ユーザー獲得 1 件あたりの費用の平均額を指します。通貨はキャンペーンのレポート通貨です。
INTERACTIONS ユーザーが広告を操作した回数。クリック数とエンゲージメント数で構成されます。