Method: accounts.networkReport.generate

指定されたレポート仕様に基づいて AdMob ネットワーク レポートを生成します。サーバーサイドのストリーミング RPC の結果を返します。結果は一連のレスポンスとして返されます。

HTTP リクエスト

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

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

パスパラメータ

パラメータ
parent

string

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

リクエスト本文

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

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

object (NetworkReportSpec)

ネットワーク レポートの仕様。

レスポンスの本文

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": {"microsValue": 6500000}
    }
  }
},
{
  "footer": {"matchingRowCount": 1}
}]

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

JSON 表現 
{

  // Union field payload can be only one of the following:
  "header": {
    object (ReportHeader)
  },
  "row": {
    object (ReportRow)
  },
  "footer": {
    object (ReportFooter)
  }
  // End of list of possible types for union field payload.
}
フィールド
共用体フィールド payload。各ストリーム レスポンス メッセージには、1 種類のペイロードが含まれます。payload は次のいずれかになります。
header

object (ReportHeader)

レポートの期間やローカライズの設定など、レポートの内容を説明するレポート生成の設定。
row

object (ReportRow)

実際のレポートデータ。
footer

object (ReportFooter)

生成されたレポートに関する追加情報（データに関する警告など）。

認可スコープ

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

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

詳しくは、OAuth 2.0 の概要をご覧ください。

NetworkReportSpec

AdMob ネットワーク レポートを生成するための仕様。たとえば、「米国」のクリック数と推定収益額を取得する仕様の場合、と「CN」次に例を示します。

{
  'dateRange': {
    'startDate': {'year': 2021, 'month': 9, 'day': 1},
    'endDate': {'year': 2021, 'month': 9, 'day': 30}
  },
  'dimensions': ['DATE', 'APP', 'COUNTRY'],
  'metrics': ['CLICKS', 'ESTIMATED_EARNINGS'],
  'dimensionFilters': [
    {
      'dimension': 'COUNTRY',
      'matchesAny': {'values': [{'value': 'US', 'value': 'CN'}]}
    }
  ],
  'sortConditions': [
    {'dimension':'APP', order: 'ASCENDING'},
    {'metric':'CLICKS', order: 'DESCENDING'}
  ],
  'localizationSettings': {
    'currencyCode': 'USD',
    'languageCode': 'en-US'
  }
}

理解を深めるために、上記の仕様を次の疑似 SQL のように扱うことができます。

SELECT DATE, APP, COUNTRY, CLICKS, ESTIMATED_EARNINGS
FROM NETWORK_REPORT
WHERE DATE >= '2021-09-01' AND DATE <= '2021-09-30'
    AND COUNTRY IN ('US', 'CN')
GROUP BY DATE, APP, COUNTRY
ORDER BY APP ASC, CLICKS DESC;
JSON 表現 
{
  "dateRange": {
    object (DateRange)
  },
  "dimensions": [
    enum (Dimension)
  ],
  "metrics": [
    enum (Metric)
  ],
  "dimensionFilters": [
    {
      object (DimensionFilter)
    }
  ],
  "sortConditions": [
    {
      object (SortCondition)
    }
  ],
  "localizationSettings": {
    object (LocalizationSettings)
  },
  "maxReportRows": integer,
  "timeZone": string
}
フィールド
dateRange

object (DateRange)

レポートが生成される期間。
dimensions[]

enum (Dimension)

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

enum (Metric)

レポートの指標のリスト。レポートには指標を少なくとも 1 つ指定する必要があります。
dimensionFilters[]

object (DimensionFilter)

ディメンション値に基づいて照合するレポートの行を表します。
sortConditions[]

object (SortCondition)

レポートの行の並べ替えについて説明します。リスト内の条件の順序によって優先度が定義されます。条件が早いほど優先順位が高くなります。並べ替え条件が指定されていない場合、行の順序は定義されません。
localizationSettings

object (LocalizationSettings)

レポートのローカライズ設定。
maxReportRows

integer

返されるレポートデータ行の最大数。この値が設定されていない場合、API はできるだけ多くの行（最大 100,000 行）を返します。有効な値は 1 ～ 100, 000 です。値が 100,000 を超えるとエラーが返されます。
timeZone

string

レポートのタイムゾーン。「America/Los_Angeles」などの IANA TZ 名の値を指定できます。タイムゾーンが定義されていない場合は、アカウントのデフォルトが適用されます。get account アクションでデフォルト値を確認します。

警告: "America/Los_Angeles"現時点でサポートされている値は のみです。

ディメンション

ネットワーク レポートのディメンション。ディメンションとは、広告が視聴された広告フォーマットやプラットフォームなど、特定の属性ごとに定量的測定値（指標）を分類または絞り込みするためのデータ属性です。

列挙型
DIMENSION_UNSPECIFIED 未設定のフィールドのデフォルト値。使用しないでください。
DATE YYYYMMDD 形式の日付（例: 20210701）。リクエストには、最大 1 つの時間ディメンションを指定できます。
MONTH YYYYMM 形式の月（例: 202107）。リクエストには、最大 1 つの時間ディメンションを指定できます。
WEEK YYYYMMDD 形式の週の最初の日の日付（例: 20210701）。リクエストには、最大 1 つの時間ディメンションを指定できます。
AD_UNIT 広告ユニットの一意の ID（例: ca-app-pub-1234/1234）。AD_UNIT ディメンションが指定されている場合、APP は自動的に含まれます。
APP モバイルアプリの一意の ID（例: ca-app-pub-1234~1234）。
AD_TYPE

広告のタイプ（「テキスト」や「画像」など）、広告配信ディメンション。

警告: このディメンションは、AD_REQUESTS、MATCH_RATE、IMPRESSION_RPM の指標とは互換性がありません。
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

広告リクエストの数。この値は整数です。

警告: この指標は、AD_TYPE ディメンションに対応していません。
CLICKS ユーザーが広告をクリックした回数。この値は整数です。
ESTIMATED_EARNINGS AdMob パブリッシャーの推定収益額。収益指標の通貨単位（USD、EUR など）は、通貨のローカライズ設定によって決まります。金額はマイクロ秒単位です。たとえば、$6.50 は 6500000 と表されます。
IMPRESSIONS ユーザーに表示される広告の総数です。この値は整数です。
IMPRESSION_CTR インプレッション数に対するクリック数の割合。値は倍精度（近似）10 進数値です。
IMPRESSION_RPM

広告インプレッション 1,000 回あたりの推定収益額。値はマイクロ秒単位です。たとえば、$1.03 は 1030000 と表されます。AdMob 管理画面の eCPM と同等。

警告: この指標は、AD_TYPE ディメンションに対応していません。
MATCHED_REQUESTS リクエストに応じて広告が返された回数。この値は整数です。
MATCH_RATE

広告リクエスト数全体に対する一致した広告リクエストの割合。値は倍精度（近似）10 進数値です。

警告: この指標は、AD_TYPE ディメンションに対応していません。
SHOW_RATE 返された広告のうち表示された広告の割合（インプレッション数 ÷ 一致したリクエスト数）値は倍精度（近似）10 進数値です。

DimensionFilter

ディメンション値に基づいて照合するレポートの行を表します。

JSON 表現 
{
  "dimension": enum (Dimension),

  // Union field operator can be only one of the following:
  "matchesAny": {
    object (StringList)
  }
  // End of list of possible types for union field operator.
}
フィールド
dimension

enum (Dimension)

指定したディメンションにフィルタ条件を適用します。
共用体フィールド operator。適用するフィルタ演算子。operator は次のいずれかになります。
matchesAny

object (StringList)

指定したディメンションの値が、この条件で指定された値のいずれかに該当する場合に、行が一致します。

SortCondition

ディメンションまたは指標に適用される並べ替えの方向。

JSON 表現 
{
  "order": enum (SortOrder),

  // Union field sort_on can be only one of the following:
  "dimension": enum (Dimension),
  "metric": enum (Metric)
  // End of list of possible types for union field sort_on.
}
フィールド
order

enum (SortOrder)

ディメンションまたは指標の並べ替え順。
共用体フィールド sort_on。並べ替える値を指定します。sort_on は次のいずれかになります。
dimension

enum (Dimension)

指定したディメンションで並べ替えます。
metric

enum (Metric)

指定した指標で並べ替えます。