Method: accounts.networkReport.generate

Menghasilkan laporan Jaringan AdMob berdasarkan spesifikasi laporan yang diberikan. Menampilkan hasil RPC streaming sisi server. Hasilnya ditampilkan dalam urutan respons.

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
parent

string

Nama resource akun yang laporannya akan dihasilkan. Contoh: accounts/pub-9876543210987654

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "reportSpec": {
    object (NetworkReportSpec)
  }
}
Kolom
reportSpec

object (NetworkReportSpec)

Spesifikasi laporan jaringan.

Isi respons

Respons streaming untuk laporan Jaringan AdMob dengan respons pertama berisi header laporan, lalu aliran respons baris, dan terakhir footer sebagai pesan respons terakhir.

Contoh:

[{
  "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}
}]

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi 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.
}
Kolom
Kolom union payload. Setiap pesan respons stream berisi satu jenis payload. payload hanya dapat berupa salah satu dari berikut:
header

object (ReportHeader)

Setelan pembuatan laporan yang mendeskripsikan konten laporan, seperti rentang tanggal laporan dan setelan pelokalan.
row

object (ReportRow)

Data laporan aktual.
footer

object (ReportFooter)

Informasi tambahan tentang laporan yang dibuat, seperti peringatan tentang data.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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

Untuk informasi selengkapnya, lihat Ringkasan OAuth 2.0.

NetworkReportSpec

Spesifikasi untuk membuat laporan Jaringan AdMob. Misalnya, spesifikasi untuk memperoleh klik dan estimasi penghasilan hanya untuk 'AS' dan 'CN' negara dapat terlihat seperti contoh berikut:

{
  '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'
  }
}

Untuk pemahaman yang lebih baik, Anda dapat memperlakukan spesifikasi sebelumnya seperti pseudo SQL berikut:

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;
Representasi JSON 
{
  "dateRange": {
    object (DateRange)
  },
  "dimensions": [
    enum (Dimension)
  ],
  "metrics": [
    enum (Metric)
  ],
  "dimensionFilters": [
    {
      object (DimensionFilter)
    }
  ],
  "sortConditions": [
    {
      object (SortCondition)
    }
  ],
  "localizationSettings": {
    object (LocalizationSettings)
  },
  "maxReportRows": integer,
  "timeZone": string
}
Kolom
dateRange

object (DateRange)

Rentang tanggal pembuatan laporan.
dimensions[]

enum (Dimension)

Daftar dimensi laporan. Kombinasi nilai dimensi ini menentukan baris laporan. Jika tidak ada dimensi yang ditentukan, laporan akan menampilkan satu baris metrik yang diminta untuk seluruh akun.
metrics[]

enum (Metric)

Daftar metrik laporan. Laporan harus mencantumkan setidaknya satu metrik.
dimensionFilters[]

object (DimensionFilter)

Menjelaskan baris laporan yang akan dicocokkan berdasarkan nilai dimensinya.
sortConditions[]

object (SortCondition)

Menjelaskan pengurutan baris laporan. Urutan kondisi dalam daftar menentukan prioritasnya; semakin awal kondisinya, semakin tinggi prioritasnya. Jika tidak ada kondisi pengurutan yang ditentukan, pengurutan baris tidak ditentukan.
localizationSettings

object (LocalizationSettings)

Setelan pelokalan laporan.
maxReportRows

integer

Jumlah maksimum baris data laporan yang akan ditampilkan. Jika nilai tidak ditetapkan, API akan menampilkan baris sebanyak mungkin, hingga 100.000. Nilai yang dapat diterima adalah 1-100000, inklusif. Nilai yang lebih besar dari 100000 akan menampilkan error.
timeZone

string

Zona waktu laporan. Menerima nilai nama TZ IANA, seperti "America/Los_Angeles". Jika tidak ada zona waktu yang ditentukan, setelan default akun akan diterapkan. Periksa nilai default berdasarkan tindakan get account.

Peringatan: "America/Los_Angeles" adalah satu-satunya nilai yang didukung saat ini.

Dimensi

Dimensi laporan jaringan. Dimensi adalah atribut data untuk mengelompokkan atau menyaring pengukuran kuantitatif (metrik) berdasarkan atribut tertentu, seperti format iklan atau platform tempat iklan dilihat.

Enum
DIMENSION_UNSPECIFIED Nilai default untuk kolom yang tidak ditetapkan. Jangan gunakan.
DATE Tanggal dalam format YYYYMMDD (misalnya, "20210701"). Permintaan dapat menentukan maksimal satu dimensi waktu.
MONTH Bulan dalam format YYYYMM (misalnya, "202107"). Permintaan dapat menentukan maksimal satu dimensi waktu.
WEEK Tanggal hari pertama dalam seminggu dalam format YYYYMMDD (misalnya, "20210701"). Permintaan dapat menentukan maksimal satu dimensi waktu.
AD_UNIT ID unik unit iklan (misalnya, "ca-app-pub-1234/1234"). Jika dimensi AD_UNIT ditentukan, APP disertakan secara otomatis.
APP ID unik aplikasi seluler (misalnya, "ca-app-pub-1234~1234").
AD_TYPE

Jenis iklan (misalnya, "teks" atau "gambar"), dimensi penayangan iklan.

Peringatan: Dimensi ini tidak kompatibel dengan metrik AD_REQUESTS, MATCH_RATE, dan IMPRESSION_RPM.
COUNTRY Kode negara CLDR tempat penayangan/klik iklan terjadi (misalnya, "US" atau "FR"). Ini adalah dimensi geografi.
FORMAT Format unit iklan (misalnya, "banner", "native"), dimensi penayangan iklan.
PLATFORM Platform OS seluler aplikasi (misalnya, "Android" atau "iOS").
MOBILE_OS_VERSION Versi sistem operasi seluler, misalnya "iOS 13.5.1".
GMA_SDK_VERSION Versi GMA SDK, mis. "iOS 7.62.0".
APP_VERSION_NAME Untuk Android, nama versi aplikasi dapat ditemukan di versionName di PackageInfo. Untuk iOS, nama versi aplikasi dapat ditemukan di CFBundleShortVersionString.
SERVING_RESTRICTION Mode pembatasan untuk penayangan iklan (mis., "Iklan yang tidak dipersonalisasi").

Metrik

Metrik laporan jaringan. Metrik adalah pengukuran kuantitatif yang menunjukkan performa bisnis penayang. Metrik ini digabungkan dari masing-masing peristiwa iklan dan dikelompokkan menurut dimensi laporan. Nilai metrik berupa bilangan bulat atau desimal (tanpa pembulatan).

Enum
METRIC_UNSPECIFIED Nilai default untuk kolom yang tidak ditetapkan. Jangan gunakan.
AD_REQUESTS

Jumlah permintaan iklan. Nilainya berupa bilangan bulat.

Peringatan: Metrik tidak kompatibel dengan dimensi AD_TYPE.
CLICKS Frekuensi pengguna mengklik iklan. Nilainya berupa bilangan bulat.
ESTIMATED_EARNINGS Estimasi penghasilan penayang AdMob. Unit mata uang (USD, EUR, atau lainnya) untuk metrik penghasilan ditentukan oleh setelan pelokalan untuk mata uang. Jumlahnya dalam mikro. Misalnya, $6,50 akan direpresentasikan sebagai 6500000.
IMPRESSIONS Total jumlah iklan yang ditampilkan kepada pengguna. Nilainya berupa bilangan bulat.
IMPRESSION_CTR Rasio klik terhadap tayangan. Nilainya adalah nilai desimal presisi ganda (perkiraan).
IMPRESSION_RPM

Estimasi penghasilan per seribu tayangan iklan. Nilainya dalam mikro. Misalnya, $1,03 akan direpresentasikan sebagai 1030000. Setara dengan eCPM di UI AdMob.

Peringatan: Metrik tidak kompatibel dengan dimensi AD_TYPE.
MATCHED_REQUESTS Frekuensi iklan ditampilkan sebagai tanggapan terhadap permintaan. Nilainya berupa bilangan bulat.
MATCH_RATE

Rasio permintaan iklan yang cocok terhadap total permintaan iklan. Nilainya adalah nilai desimal presisi ganda (perkiraan).

Peringatan: Metrik tidak kompatibel dengan dimensi AD_TYPE.
SHOW_RATE Rasio iklan yang ditampilkan di atas iklan yang ditampilkan, yang didefinisikan sebagai tayangan / permintaan yang cocok. Nilainya adalah nilai desimal presisi ganda (perkiraan).

DimensionFilter

Menjelaskan baris laporan yang akan dicocokkan berdasarkan nilai dimensinya.

Representasi 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.
}
Kolom
dimension

enum (Dimension)

Menerapkan kriteria filter ke dimensi yang ditentukan.
Kolom union operator. Operator filter yang akan diterapkan. operator hanya dapat berupa salah satu dari berikut:
matchesAny

object (StringList)

Mencocokkan baris jika nilainya untuk dimensi yang ditentukan berada di salah satu nilai yang ditentukan dalam kondisi ini.

SortCondition

Arah pengurutan yang akan diterapkan pada dimensi atau metrik.

Representasi 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.
}
Kolom
order

enum (SortOrder)

Mengurutkan urutan dimensi atau metrik.
Kolom union sort_on. Mengidentifikasi nilai mana yang akan diurutkan. sort_on hanya dapat berupa salah satu dari berikut:
dimension

enum (Dimension)

Urutkan menurut dimensi yang ditentukan.
metric

enum (Metric)

Urutkan menurut metrik yang ditentukan.