- HTTP isteği
- Yol parametreleri
- İstek metni
- Yanıt metni
- Yetkilendirme kapsamları
- NetworkReportSpec
- Boyut
- Metrik
- DimensionFilter
- SortCondition
- Örnekler
- Deneyin.
Sağlanan rapor spesifikasyonuna göre bir AdMob Ağı raporu oluşturur. Sunucu tarafı 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/v1beta/{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 içeriği
İstek gövdesi, aşağıdaki yapıyla birlikte veriler içerir:
JSON gösterimi |
---|
{
"reportSpec": {
object ( |
Alanlar | |
---|---|
reportSpec |
Ağ raporu özellikleri. |
Yanıt gövdesi
AdMob Ağı raporu için ilk yanıtın rapor başlığını, ardından satır yanıtları akışını ve son yanıt mesajı olarak altbilgiyi içeren 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 alanı. Her akış yanıt mesajı bir yük türü içerir. payload şunlardan yalnızca biri olabilir: |
|
header |
Rapor tarih aralığı ve yerelleştirme ayarları gibi rapor içeriklerini açıklayan rapor oluşturma ayarları. |
row |
Gerçek rapor verileri. |
footer |
Oluşturulan raporla ilgili ek bilgiler (ör. verilerle ilgili uyarılar). |
Yetkilendirme kapsamları
Aşağıdaki OAuth kapsamlarından birini gerektirir:
https://www.googleapis.com/auth/admob.readonly
https://www.googleapis.com/auth/admob.report
Daha fazla bilgi için OAuth 2.0'a Genel Bakış başlıklı makaleye bakın.
NetworkReportSpec
AdMob Ağı raporu oluşturmaya ilişkin spesifikasyon. Örneğin, yalnızca "US" ve "CN" ülkeleri için tıklama ve tahmini kazanç almaya ilişkin spesifikasyon aşağıdaki örnekteki 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 sözde SQL gibi ele alabilirsiniz:
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[] |
Rapor boyutlarının listesi. Bu boyutların değer kombinasyonu, rapor satırını belirler. Hiçbir boyut belirtilmezse rapor, hesabın tamamı için istenen metriklerin tek bir satırını döndürür. |
metrics[] |
Rapor metriklerinin listesi. Bir raporda en az bir metrik belirtilmelidir. |
dimensionFilters[] |
Boyut değerlerine göre hangi rapor satırlarının eşleneceğini açıklar. |
sortConditions[] |
Rapor satırlarının sıralamasını açıklar. Koşulun listedeki sırası, önceliğini tanımlar. Koşul ne kadar erken olursa, önceliği o kadar yüksek olur. Herhangi bir sıralama koşulu belirtilmezse satır sıralaması tanımsız olur. |
localizationSettings |
Raporun yerelleştirme ayarları. |
maxReportRows |
Döndürülecek maksimum rapor verisi satırı sayısı. Değer ayarlanmazsa API, en fazla 100.000 satır olacak şekilde mümkün olduğunca çok satır döndürür. Kabul edilebilir değerler 1-100.000 (100.000 dahil) arasındadır. 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. Herhangi bir saat dilimi tanımlanmazsa hesap varsayılanı geçerli olur. "Hesap alma" işlemiyle varsayılan değeri kontrol edin. Uyarı: Şu anda desteklenen tek değer "America/Los_Angeles"tir. |
Boyut
Ağ raporunun boyutları. Boyutlar, nicel ölçümleri (metrikleri) reklam biçimi veya reklamın görüntülendiği platform gibi belirli özelliklere göre ayırmaya veya hassaslaştırmaya yarayan veri özellikleridir.
Sıralamalar | |
---|---|
DIMENSION_UNSPECIFIED |
Ayarlanmamış bir alan için varsayılan değer. Kullanmayın. |
DATE |
YYYYAAGG biçimindeki tarih (ör. "20210701"). İstekler en fazla bir defalık boyut belirtebilir. |
MONTH |
YYYYAA biçiminde bir ay (örneğin, "202107"). İstekler en fazla bir defalık boyut belirtebilir. |
WEEK |
Haftanın ilk gününün YYYYAAGG biçimindeki tarihi (örneğin, "20210701"). İstekler en fazla bir defalık boyut belirtebilir. |
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 (örneğin, "ca-app-pub-1234~1234"). |
AD_TYPE |
Reklamın türü (ör. "metin" veya "resim"). Bir reklam yayını boyutudur. Uyarı: Boyut AD_REQUESTS, MATCH_RATE ve IMPRESSION_RPM metrikleriyle uyumlu değil. |
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ğrafi boyuttur. |
FORMAT |
Reklam biriminin biçimi (örneğin, "banner", "yerel"), bir reklam yayını boyutu. |
PLATFORM |
Uygulamanın mobil işletim sistemi platformu (ör. "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 için uygulama sürüm adı, PackageInfo'daki versionName bölümünde bulunabilir. iOS için uygulama sürümü adını CFBundleShortVersionString öğesinde bulabilirsiniz. |
SERVING_RESTRICTION |
Reklam yayını için kısıtlama modu (ör. "Kişiselleştirilmemiş reklamlar"). |
Metrik
Ağ raporunun metrikleri. Metrikler, yayıncının işletmesinin nasıl performans gösterdiğini gösteren nicel ölçümlerdir. Bunlar tek tek reklam etkinliklerinden toplanır ve rapor boyutlarına göre gruplandırılır. Metrik değeri tamsayıdır veya ondalıktır (yuvarlama olmadan).
Sıralamalar | |
---|---|
METRIC_UNSPECIFIED |
Ayarlanmamış bir alan için varsayılan değer. Kullanmayın. |
AD_REQUESTS |
Reklam isteklerinin sayısıdır. Değer, bir tam sayıdır. Uyarı: Metrik AD_TYPE boyutuyla uyumlu değil. |
CLICKS |
Kullanıcının bir reklamı tıklama sayısı. Değer, bir tam sayıdır. |
ESTIMATED_EARNINGS |
AdMob yayıncısının tahmini kazançları. Kazanç metriklerinin para birimi (USD, EUR veya diğer), para biriminin yerelleştirme ayarına göre belirlenir. Tutar, mikrosaniye cinsindendir. Örneğin, 6,50 ABD doları 6500000 olarak temsil edilir. |
IMPRESSIONS |
Kullanıcılara gösterilen toplam reklam sayısı. Değer, bir tam sayıdır. |
IMPRESSION_CTR |
Tıklamaların gösterimlere oranı. Değer, çift duyarlıklı (yaklaşık) ondalık değerdir. |
IMPRESSION_RPM |
Bin reklam gösterimi başına tahmini kazançlar. Değer mikro ölçektedir. Örneğin, 1,03 ABD doları, 1030000 olarak temsil edilir. AdMob kullanıcı arayüzündeki eBGBM'ye eşdeğerdir. Uyarı: Metrik AD_TYPE boyutuyla uyumlu değil. |
MATCHED_REQUESTS |
Bir isteğe yanıt olarak reklamların döndürülme sayısı. Değer, bir tam sayıdır. |
MATCH_RATE |
Eşleşen reklam isteklerinin toplam reklam isteklerine oranı. Değer, çift duyarlıklı (yaklaşık) ondalık değerdir. Uyarı: Metrik AD_TYPE boyutuyla uyumlu değil. |
SHOW_RATE |
Döndürülen reklamlar üzerinden görüntülenen reklamların oranı. Gösterim / eşleşen istek olarak tanımlanır. Değer, çift duyarlıklı (yaklaşık) ondalık değerdir. |
DimensionFilter
Boyut değerlerine göre hangi rapor satırlarının eşleneceğini açıklar.
JSON gösterimi |
---|
{ "dimension": enum ( |
Alanlar | |
---|---|
dimension |
Filtre ölçütünü belirtilen boyuta uygular. |
operator alanı. Uygulanacak filtre operatörü. operator şunlardan yalnızca biri olabilir: |
|
matchesAny |
Belirtilen boyut için değeri bu koşulda belirtilen değerlerden birindeyse bir satırla eşleşir. |
SortCondition
Bir boyuta veya metriğe uygulanacak sıralama yönü.
JSON gösterimi |
---|
{ "order": enum ( |
Alanlar | |
---|---|
order |
Boyut veya metriğin sıralama düzeni. |
sort_on alanı. Hangi değerlere göre sıralama yapılacağını tanımlar. sort_on şunlardan yalnızca biri olabilir: |
|
dimension |
Belirtilen boyuta göre sıralayın. |
metric |
Belirtilen metriğe göre sıralayın. |