- HTTP isteği
- Yol parametreleri
- İstek metni
- Yanıt metni
- Yetkilendirme kapsamları
- NetworkReportSpec
- Boyut
- Metrik
- DimensionFilter
- SortCondition
- Örnekler
- Deneyin.
Belirtilen rapor spesifikasyonuna göre bir AdMob Ağı raporu oluşturur. Sunucu taraflı akış RPC'sinin sonucunu döndürür. Sonuç, bir dizi yanıt olarak döndürülür.
HTTP isteği
POST https://admob.googleapis.com/v1/{parent=accounts/*}/networkReport:generate
URL, gRPC Kod Dönüştürme söz dizimini kullanır.
Yol parametreleri
| Parametreler | |
|---|---|
parent |
Raporun oluşturulacağı hesabın kaynak adı. Örnek: accounts/pub-9876543210987654 |
İstek metni
İstek içeriği aşağıdaki yapıyla birlikte verileri içerir:
| JSON gösterimi |
|---|
{
"reportSpec": {
object ( |
| Alanlar | |
|---|---|
reportSpec |
Ağ raporu spesifikasyonu. |
Yanıt metni
İlk yanıtta rapor başlığı, ardından bir dizi satır yanıtı ve son olarak da son yanıt mesajı olarak bir altbilgi içeren AdMob Ağı raporunun akış yanıtı.
Örneğin:
[{
"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}
}]
Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:
| JSON gösterimi |
|---|
{ // Union field |
| Alanlar | |
|---|---|
payload birleşik alanı. Her akış yanıtı mesajı bir tür yük içerir. payload aşağıdakilerden yalnızca biri olabilir: |
|
header |
Raporun tarih aralığı ve yerelleştirme ayarları gibi rapor içeriklerini açıklayan rapor oluşturma ayarları. |
row |
Gerçek rapor verileri. |
footer |
Oluşturulan rapor hakkında ek bilgiler (ör. verilerle ilgili uyarılar). |
Yetkilendirme kapsamları
Aşağıdaki OAuth kapsamlarından birini gerektirir:
https://www.googleapis.com/auth/admob.readonlyhttps://www.googleapis.com/auth/admob.report
Daha fazla bilgi için OAuth 2.0 Overview sayfasına bakın.
NetworkReportSpec
AdMob Ağı raporu oluşturma spesifikasyonu. Örneğin, yalnızca "ABD" ve "Çin" ülkeleri için tıklama ve tahmini kazanç elde etme spesifikasyonu aşağıdaki örnek gibi görünebilir:
{
'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'
}
}
Daha iyi anlamak için önceki spesifikasyonu aşağıdaki sahte SQL gibi değerlendirebilirsiniz:
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 gösterimi |
|---|
{ "dateRange": { object ( |
| Alanlar | |
|---|---|
dateRange |
Raporun oluşturulduğu tarih aralığı. |
dimensions[] |
Raporun boyutlarının listesi. Bu boyutların değer kombinasyonu, raporun satırını belirler. Boyut belirtilmezse rapor, hesabın tamamı için istenen metriklerin tek bir satırını döndürür. |
metrics[] |
Rapordaki metriklerin listesi. Bir raporda en az bir metrik belirtilmelidir. |
dimensionFilters[] |
Boyut değerlerine göre hangi rapor satırlarının eşleştirileceğini açıklar. |
sortConditions[] |
Rapor satırlarının sıralanmasını açıklar. Listedeki koşulun sırası, önceliğini belirler. Koşul ne kadar erken olursa önceliği o kadar yüksek olur. Sıralama koşulu belirtilmemişse satır sıralaması tanımlanmamıştır. |
localizationSettings |
Raporun yerelleştirme ayarları. |
maxReportRows |
Döndürülecek maksimum rapor verisi satırı sayısı. Değer ayarlanmamışsa API, 100.000'e kadar mümkün olduğunca çok satır döndürür. Kabul edilen değerler 1-100000 arasıdır (1 ve 100000 dahil). 100.000'den büyük değerler hata döndürür. |
timeZone |
Rapor saat dilimi. "America/Los_Angeles" gibi IANA TZ adı değerlerini kabul eder. Saat dilimi tanımlanmamışsa hesap varsayılanı geçerli olur. Hesap alma işlemiyle varsayılan değeri kontrol edin. Uyarı: Şu anda yalnızca "America/Los_Angeles" değeri desteklenmektedir. |
Boyut
Ağ raporunun boyutları. Boyutlar, nicel ölçümleri (metrikler) reklam biçimi veya reklamın görüntülendiği platform gibi belirli özelliklere göre dökümlendirmek ya da hassaslaştırmak için kullanılan veri özellikleridir.
| Sıralamalar | |
|---|---|
DIMENSION_UNSPECIFIED |
Ayarlanmamış bir alanın varsayılan değeri. Kullanmayın. |
DATE |
YYYYMMDD biçiminde bir tarih (örneğin, "20210701"). İsteklerde en fazla bir zaman boyutu belirtilebilir. |
MONTH |
YYYYAA biçiminde bir ay (örneğin, "202107"). İsteklerde en fazla bir zaman boyutu belirtilebilir. |
WEEK |
Bir haftanın ilk gününün YYYYAAGG biçimindeki tarihi (ör. "20210701"). İsteklerde en fazla bir zaman boyutu belirtilebilir. |
AD_UNIT |
Reklam biriminin benzersiz kimliği (örneğin, "ca-app-pub-1234/1234"). AD_UNIT boyutu belirtilirse APP otomatik olarak dahil edilir. |
APP |
Mobil uygulamanın benzersiz kimliği (ör. "ca-app-pub-1234~1234"). |
AD_TYPE |
Reklamın türü (örneğin, "metin" veya "resim"), bir reklam yayınlama boyutu. Uyarı: Boyut, AD_REQUESTS, MATCH_RATE ve IMPRESSION_RPM metrikleriyle uyumlu değildir. |
COUNTRY |
Reklam görüntülemelerinin/tıklamalarının gerçekleştiği yerin CLDR ülke kodu (örneğin, "US" veya "FR"). Bu bir coğrafya boyutudur. |
FORMAT |
Reklam biriminin biçimi (örneğin, "banner", "doğal"), bir reklam yayınlama boyutu. |
PLATFORM |
Uygulamanın mobil işletim sistemi platformu (örneğin, "Android" veya "iOS"). |
MOBILE_OS_VERSION |
Mobil işletim sistemi sürümü (ör. "iOS 13.5.1"). |
GMA_SDK_VERSION |
GMA SDK sürümü (ör. "iOS 7.62.0"). |
APP_VERSION_NAME |
Android'de uygulama sürümü adı, PackageInfo'daki versionName içinde bulunabilir. iOS'te uygulama sürümü adı CFBundleShortVersionString'de bulunabilir. |
SERVING_RESTRICTION |
Reklam yayınlama için kısıtlama modu (ör. "Kişiselleştirilmemiş reklamlar"). |
Metrik
Ağ raporunun metrikleri. Metrikler, yayıncı işletmesinin nasıl performans gösterdiğini belirten nicel ölçümlerdir. Bu metrikler, tek tek reklam etkinliklerinden toplanır ve rapor boyutlarına göre gruplandırılır. Metrik değeri tam sayı veya ondalık sayıdır (yuvarlama olmadan).
| Sıralamalar | |
|---|---|
METRIC_UNSPECIFIED |
Ayarlanmamış bir alanın varsayılan değeri. Kullanmayın. |
AD_REQUESTS |
Reklam isteklerinin sayısı. Değer bir tam sayıdır. Uyarı: Metrik, AD_TYPE boyutuyla uyumlu değil. |
CLICKS |
Kullanıcıların bir reklamı tıklama sayısıdır. Değer bir tam sayıdır. |
ESTIMATED_EARNINGS |
AdMob yayıncısının tahmini kazançları. Kazanç metriklerinin para birimi (ABD doları, avro vb.), para biriminin yerelleştirme ayarına göre belirlenir. Tutar, mikro cinsindendir. Örneğin 6,50 ABD doları, 6500000 olarak gösterilir. |
IMPRESSIONS |
Kullanıcılara gösterilen toplam reklam sayısıdır. Değer bir tam sayıdır. |
IMPRESSION_CTR |
Tıklama sayısının gösterim sayısına oranı. Değer, çift duyarlıklı (yaklaşık) bir ondalık değerdir. |
IMPRESSION_RPM |
Bin reklam gösterimi başına tahmini kazanç. Değer, mikro cinsinden belirtilir. Örneğin, 1,03 ABD doları 1030000 olarak gösterilir. AdMob kullanıcı arayüzündeki eBGBM'ye eşdeğerdir. Uyarı: Metrik, AD_TYPE boyutuyla uyumlu değil. |
MATCHED_REQUESTS |
İsteğe yanıt olarak reklamların döndürülme sayısıdır. Değer bir tam sayıdır. |
MATCH_RATE |
Eşleşen reklam isteklerinin toplam reklam isteklerine oranıdır. Değer, çift duyarlıklı (yaklaşık) bir ondalık değerdir. Uyarı: Metrik, AD_TYPE boyutuyla uyumlu değil. |
SHOW_RATE |
Gösterilen reklamların döndürülen reklamlara oranıdır. Gösterim sayısı / eşleşen istek sayısı olarak tanımlanır. Değer, çift duyarlıklı (yaklaşık) bir ondalık değerdir. |
DimensionFilter
Boyut değerlerine göre hangi rapor satırlarının eşleştirileceğini açıklar.
| JSON gösterimi |
|---|
{ "dimension": enum ( |
| Alanlar | |
|---|---|
dimension |
Filtre ölçütünü belirtilen boyuta uygular. |
operator birleşik alanı. Uygulanacak filtre operatörü. operator aşağıdakilerden yalnızca biri olabilir: |
|
matchesAny |
Belirtilen boyut için değeri bu koşulda belirtilen değerlerden biriyse satırla eşleşir. |
SortCondition
Bir boyuta veya metriğe uygulanacak sıralama yönü.
| JSON gösterimi |
|---|
{ "order": enum ( |
| Alanlar | |
|---|---|
order |
Boyutun veya metriğin sıralama düzeni. |
sort_on birleşik alanı. Hangi değerlere göre sıralama yapılacağını tanımlar. sort_on aşağıdakilerden yalnızca biri olabilir: |
|
dimension |
Belirtilen boyuta göre sıralayın. |
metric |
Belirtilen metriğe göre sıralayın. |