Interfejs API raportu działań związanych z reklamami (alfa)

Uwaga: dziękujemy za udział w testach wersji alfa raportu działań związanych z reklamami. Raport działań związanych z reklamami nie planuje zakończenia wersji alfa i nie jest już obsługiwany. Użyj interfejsu Mediation Report API. . Więcej informacji o ograniczeniach stabilności wersji alfa kanał.

Ważne: nowe role i uprawnienia użytkowników będą miały wpływ na dane. zwracane przez interfejs AdMob API. Więcej informacji

Raport działań związanych z reklamami to scentralizowany wgląd w skuteczność reklam. Łączy dane, z interfejsu API do raportowania sieciowego i interfejsu API do raportowania zapośredniczenia, dane dotyczące określania stawek w jednym ujednoliconym raporcie.

Interfejs Ads Activity Report API zawiera dodatkowe ulepszenia w porównaniu z zapośredniczeniem Interfejs Report API i Network Report API z tabeli poniżej:

	Interfejs Network Report API	Interfejs API Mediation Report API	Interfejs Ads Activity Report API
Wydajność sieci	✅	✅	✅
Skuteczność w kaskadzie		✅	✅
Skuteczność określania stawek			✅
Skuteczność eksperymentu A/B z zapośredniczeniem			✅
Raportowanie godzinowe			✅
Rozmiar raportu	100 tys.	100 tys.	500 tys.

Dane, wymiary i filtry wymiarów

Te dane zostały dodane do interfejsu Ads Activity Report API w z wieloma danymi dostępnymi w interfejsie Network Report API oraz Mediation Report API.

Dane	Opis
BID_REQUEST	Liczba żądań wysłanych do źródła reklam z ustalaniem stawek.
BIDS_IN_AUCTION	Liczba stawek przesłanych przez źródło reklam, które uczestniczyły w aukcjach z określaniem stawek.
WINNING_BIDS	Liczba stawek, które wygrały aukcję z określaniem stawek.

W interfejsie Ads Activity Report API są uwzględniane podane niżej nowe wymiary.

Wymiar	Opis
TYDZIEŃ	Data pierwszego dnia tygodnia (zgodnie z językiem wymienionego w ustawieniach lokalizacji) w formacie RRRRMMDD (dla np. „20210701”). W żądaniach można określić tylko jedną z tych opcji: DATE, WEEK lub MONTH czasu.
GODZINA	Godzina w formacie GG w czasie PST. Na przykład „05” na 5:00 czasu PST, „13” na 13:00 PST. W żądaniu musisz też określić wymiar DATE. O jeśli określono wymiar GODZINA, zwracane są dane z maksymalnie 28 dni. daty rozpoczęcia zakresu dat, które przypadają ponad 28 dni przed bieżącą datą. zwróci błąd.
MEDIATION_AB_TEST (nazwa eksperymentu)	Wyświetlanie skuteczności według testu A/B zapośredniczenia. Jest to wymagane jeśli określono wymiar VARIANT.
MEDIATION_AB_TEST_VARIANT (wariant A, wariant B)	Wyświetlanie skuteczności według wariantu testu A/B zapośredniczenia.

Uwaga: wszystkie wymiary w raporcie działań związanych z reklamami są obsługiwane jako wymiary filtry. W przypadku wartości z sufiksami _NAME i _ID sufiks _ID to obsługiwanej wartości filtra. Aby np. odfiltrować jednostki reklamowe, użyj kolumny AD_UNIT_ID jako filtr wymiarów.

Nazwa wymiaru w interfejsie Mediation Report API	Nazwa wymiaru w interfejsie Ads Activity Report API	Opis
JEDNOSTKA AD_UNIT^1	AD_UNIT_ID	Unikalny identyfikator jednostki reklamowej (np. „123456789”).
	AD_UNIT_NAME	Nazwa jednostki reklamowej.
APLIKACJA^1	APP_ID	Unikalny identyfikator aplikacji mobilnej (np. „1234567890”).
	APP_NAME	Nazwa aplikacji.
ŹRÓDŁO REKLAM^1	AD_SOURCE_ID	Unikalny identyfikator źródła reklam (np. „1234567890123456789”.
	AD_SOURCE_NAME	Nazwa źródła reklam (np. „Sieć AdMob”).
AD_SOURCE_INSTANCE^1	AD_SOURCE_INSTANCE_ID	Unikalny identyfikator wystąpienia źródła reklam (np. „123456789012”).
	AD_SOURCE_INSTANCE_NAME	Nazwa wystąpienia źródła reklam (np. „AdMob (wartość domyślna)”).
MEDIATION_GROUP^1	MEDIATION_GROUP_ID	Unikalny identyfikator grupy zapośredniczenia (np. „1234567890”).
	MEDIATION_GROUP_NAME	Unikalny identyfikator grupy zapośredniczenia (np. „AdMob (domyślny)”).

¹. Więcej informacji znajdziesz w sekcji Scalars.

Zmieniono format poniższych wymiarów.

Nazwa wymiaru w interfejsie Mediation Report API	Opis w interfejsie Mediation Report API	Opis w interfejsie Ads Activity Report API
ESTIMATED_EARNINGS	Szacunkowe zarobki wydawcy AdMob. Jednostka waluty (USD, w EUR lub innej) wskaźników zarobków zależą od lokalizacji. ustawienia waluty. Ilość jest wyrażona w mikro. Na przykład 6, 50 USD to jest to 6 500 000. Szacunkowe zarobki na grupę zapośredniczenia i na poziomie wystąpienia źródła reklam: obsługiwane od 20 października 2019 r. Szacunkowe zarobki z innych firm pokazuje wartość 0 w przypadku dat sprzed 20 października 2019 r.	Szacunkowe zarobki wydawcy AdMob. Jednostka waluty (USD, w EUR lub innej) wskaźników zarobków zależą od lokalizacji. ustawienia waluty.
OBSERVED_ECPM	Szacowany średni eCPM zewnętrznej sieci reklamowej. Jednostka waluty. (USD, EUR lub inne) danych o zarobkach zależą od lokalizacji. ustawienia waluty. Ilość jest wyrażona w mikro. Na przykład 2, 30 zł to w postaci 2 300 000. Szacunkowy średni eCPM na grupę zapośredniczenia i na poziomie wystąpienia źródła reklam jest obsługiwana od 20 października 2019 r. Szacowana średnia z innych witryn W przypadku dat sprzed 20 października 2019 r. eCPM będzie wskazywać 0.	Średni eCPM dla wszystkich reklam. Jednostka waluty (USD, EUR lub inna) dane o zarobkach zależą od ustawienia lokalizacji waluty. Średni eCPM na grupę zapośredniczenia i na poziomie wystąpienia źródła reklam wynosi obsługiwane od 20 października 2019 r. W przypadku dat wartość OBSERVED_ECPM będzie wskazywać 0 przed 20 października 2019 r.

Scalars

Poniższe wymiary zostały zaktualizowane w interfejsie Ads Activity Report API. wartości skalarnych zamiast obiektów. Uprości to reagowanie i ograniczy i jego złożoność.

Wymiary, na które ma wpływ interfejs Mediation Report API i Network Report API:

• AD_UNIT
• APP
• AD_SOURCE
• AD_SOURCE_INSTANCE
• MEDIATION_GROUP

Dane odpowiedzi w przykładowym raporcie
Format wymiarów zapośredniczenia / interfejsu Network API	"AD_UNIT": { "value":"ca-app-pub-XXXXXXXXXXXXXXXXX/YYYYYYYYYY", "displayLabel": "Test ad unit name" }
Format wymiarów interfejsu AAR API	"AD_UNIT_NAME": "Test ad unit name", "AD_UNIT_ID": "ca-app-pub-XXXXXXXXXXXXXXXXX/YYYYYYYYYY"

Raportowanie godzinowe

W interfejsie AdMob API możesz teraz sprawdzać skuteczność reklam według godzin. Obecne raportowanie godzinowe dostępne przez maksymalnie 28 dni.

W żądaniu pobrania danych co godzinę należy też podać wymiar DATA. i skalowalnych danych. Jeśli wymiar GODZINA zostanie zwróconych danych z maksymalnie 28 dni, określone dane. daty rozpoczęcia zakresu dat, które przypadają ponad 28 dni przed datą bieżąca data zwraca błąd.

Ważne: dane z ostatnich 2 godzin mogą być niepełne.

Większy rozmiar raportu

Interfejs Ads Activity Report API pozwala pobrać łącznie 500 000 wierszy. Dla: dodatkowe informacje znajdziesz w przewodniku po limitach.

Poproś

Aby wysłać prośbę, wykonaj te czynności.

curl (wiersz poleceń)

Żądania używające curl

1. Wczytaj plik z tajnymi kluczami klienta i wygeneruj dane uwierzytelniające.

   Gdy wykonasz ten krok po raz pierwszy, poprosimy Cię o zaakceptowanie komunikat autoryzacyjny w przeglądarce. Zanim zaakceptujesz zaproszenie, są zalogowane za pomocą konta Google z dostępem do interfejsu AdMob API. Twoje aplikacja będzie mieć uprawnienia dostępu do danych w imieniu Użytkownik jest obecnie zalogowany na koncie.

   Do uwierzytelniania i autoryzacji zalecamy użycie oauth2l – proste narzędzie wiersza poleceń korzysta z protokołu Google OAuth 2.0. Zainstaluj oauth2l i uruchom polecenie poniżej, zastępując path_to_credentials_json ścieżką do pliku credentials.json, który można pobrać przy rejestracji aplikacji internetowej. Przy pierwszym uruchomieniu polecenie przeprowadzi Cię przez Proces autoryzacji OAuth 2.0. Kolejne uruchomienia odświeżają token automatycznie.

   ~/go/bin/oauth2l header --json path_to_credentials_json \
           https://www.googleapis.com/auth/admob.readonly
   

2. Wygeneruj raport działań związanych z reklamami.

   curl -X POST https://admob.googleapis.com/v1alpha/accounts/pub-XXXXXXXXXXXXXXXX/adsActivityReport:generate \
        -H "Content-Type: application/json" \
        -H "$(~/go/bin/oauth2l header --json path_to_credentials_json https://www.googleapis.com/auth/admob.readonly)"  --data @- << EOF
         {
           "report_spec": {
           "date_range": {
             "start_date": {"year": 2023, "month": 1, "day": 1},
             "end_date": {"year": 2023, "month": 1, "day": 2}
           },
           "dimensions": ["DATE", "HOUR", "MEDIATION_AB_TEST", "VARIANT", "AD_SOURCE_ID", "AD_SOURCE_NAME"],
           "metrics": ["CLICKS", "BID_REQUEST","WINNING_BIDS", "IMPRESSIONS", "ESTIMATED_EARNINGS" ],
           "dimension_filters": [{"dimension": "COUNTRY", "matches_any": {"values": ["US"]}}],
           "sort_conditions": [{"metric":"CLICKS", "order": "DESCENDING"}],
           "localization_settings": {"currency_code": "USD", "language_code": "en-US"}
           }
         }
   EOF
   

   Przykładowa odpowiedź:

   {
   "rows": [
     {
       "dimensionValues": {
         "DATE": {
           "value": "20221102"
         },
         "HOUR": {
           "value": "23"
         },
         "MEDIATION_AB_TEST": {
           "value": "Mediation AB Test"
         },
         "VARIANT": {
           "value": "Variant A"
         },
         "AD_SOURCE_ID": {
           "value": "5450213213286189855"
         },
         "AD_SOURCE_NAME": {
           "value": "AdMob Network"
         }
       },
       "metricValues": {
         "CLICKS": {
           "doubleValue": 0
         },
         "BID_REQUEST": {
           "integerValue": "27"
         },
         "WINNING_BIDS": {
           "doubleValue": 0.1111111111111111
         },
         "IMPRESSIONS": {
           "integerValue": "2"
         },
         "ESTIMATED_EARNINGS": {
           "doubleValue": 0
         }
       }
     },
   {
       "dimensionValues": {
         "DATE": {
           "value": "20221102"
         },
         "HOUR": {
           "value": "23"
         },
         "MEDIATION_AB_TEST": {
           "value": "Mediation AB Test"
         },
         "VARIANT": {
           "value": "Variant B"
         },
         "AD_SOURCE_ID": {
           "value": "5450213213286189855"
         },
         "AD_SOURCE_NAME": {
           "value": "AdMob Network"
         }
       },
       "metricValues": {
         "CLICKS": {
           "doubleValue": 1
         },
         "BID_REQUEST": {
           "integerValue": "6"
         },
         "WINNING_BIDS": {
           "doubleValue": 1
         },
         "IMPRESSIONS": {
           "integerValue": "3"
         },
         "ESTIMATED_EARNINGS": {
           "doubleValue": 0.000427519
         }
       }
     }
   ]}