- HTTP isteği
- Yol parametreleri
- İstek gövdesi
- 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 halinde 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ıya sahip verileri içerir:
JSON gösterimi |
---|
{
"reportSpec": {
object ( |
Alanlar | |
---|---|
reportSpec |
Ağ raporu spesifikasyonu. |
Yanıt gövdesi
AdMob Ağı raporu için ilk yanıtın rapor üstbilgisini, ardından bir satır yanıtı akışını ve son yanıt mesajı olarak bir altbilgiyi içerdiği akışlı 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 | |
---|---|
Birleştirme alanı payload . 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çeriğini 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.readonly
https://www.googleapis.com/auth/admob.report
Daha fazla bilgi için OAuth 2.0 Overview (OAuth 2.0'a Genel Bakış) sayfasına göz atın.
NetworkReportSpec
AdMob Ağı raporu oluşturma spesifikasyonu. Örneğin, yalnızca 'ABD' için tıklamaları ve tahmini kazançları almaya yönelik spesifikasyon ve 'CN' aşağıdaki örnekteki gibi görünür:
{
'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 kullanabilirsiniz:
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. 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ıralamasını açıklar. Listedeki koşulun sırası, koşulunun önceliğini tanımlar; koşul ne kadar erken olursa önceliği o kadar yüksektir. 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 mümkün olduğunca çok sayıda satır döndürür (en fazla 100.000). 1-100.000 dahil olmak üzere kabul edilebilir değerlerdir. 100.000'den büyük değerler hata döndürür. |
timeZone |
Rapor saat dilimi. "Amerika/Los_Angeles" gibi IANA TZ ad değerlerini kabul eder. Herhangi bir saat dilimi tanımlanmamışsa hesap varsayılanı geçerli olur. Hesap işlemi alma işlemiyle varsayılan değeri kontrol edin. Uyarı: "America/Los_Angeles" şu anda desteklenen tek değerdir. |
Boyut
Ağ raporunun boyutları. Boyutlar, niceliksel ölçümlerin (metriklerin) reklam biçimi veya reklamın görüntülendiği platform gibi belirli özelliklere göre dökümünü almak veya hassaslaştırmak için kullanılan veri özellikleridir.
Sıralamalar | |
---|---|
DIMENSION_UNSPECIFIED |
Ayarlanmamış bir alan için varsayılan değerdir. Kullanmayın. |
DATE |
YYYYAAGG biçiminde bir tarih (ör. "20210701"). İstekler en fazla bir zaman boyutu belirtebilir. |
MONTH |
YYYYAA biçiminde bir ay (ör. "202107"). İstekler en fazla bir zaman boyutu belirtebilir. |
WEEK |
Haftanın ilk gününün YYYYAAGG biçimindeki tarihi (örneğin, "20210701"). İstekler en fazla bir zaman boyutu 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ü (örneğin, "metin" veya "resim") ve bir reklam yayınlama boyutu. 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 (ör. "banner", "yerel"), bir reklam yayınlama boyutudur. |
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 içinde bulunabilir. iOS için uygulama sürümü adı, CFBundleShortVersionString içinde bulunabilir. |
SERVING_RESTRICTION |
Reklam yayını 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 gösteren niceliksel ölçümlerdir. Bu veriler 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 için varsayılan değerdir. Kullanmayın. |
AD_REQUESTS |
Reklam isteklerinin sayısıdır. Değer tam sayı olmalıdır. Uyarı: Metrik, AD_TYPE boyutuyla uyumlu değil. |
CLICKS |
Bir kullanıcının bir reklamı tıklama sayısı. Değer tam sayı olmalı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, mikro cinsindendir. Örneğin, 6,50 ABD doları 6500000 olarak temsil edilir. |
IMPRESSIONS |
Kullanıcılara gösterilen toplam reklam sayısı. Değer tam sayı olmalıdır. |
IMPRESSION_CTR |
Tıklama sayısının gösterimlere oranı. Bu değer, çift duyarlıklı (yaklaşık) ondalık bir değerdir. |
IMPRESSION_RPM |
Bin reklam gösterimi başına tahmini kazançlar. Değer, mikro cinsindendir. Örneğin, 1,03 TL 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 tam sayı olmalıdır. |
MATCH_RATE |
Eşleşen reklam isteklerinin toplam reklam isteklerine oranı. Bu değer, çift duyarlıklı (yaklaşık) ondalık bir 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ı. Bu oran, gösterim sayısı / eşleşen istek olarak tanımlanır. Bu değer, çift duyarlıklı (yaklaşık) ondalık bir 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. |
Birleştirme alanı operator . 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 ölçütü. |
Birleştirme alanı sort_on . 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ırala. |