Method: accounts.mediationReport.generate

Generuje raport zapośredniczenia AdMob na podstawie podanej specyfikacji raportu. Zwraca wynik RPC po stronie serwera. Wynik jest zwracany w sekwencji odpowiedzi.

Żądanie HTTP

POST https://admob.googleapis.com/v1/{parent=accounts/*}/mediationReport:generate

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
parent

string

Nazwa zasobu konta, dla którego ma zostać wygenerowany raport. Przykład: accounts/pub-9876543210987654

Treść żądania

Treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "reportSpec": {
    object (MediationReportSpec)
  }
}
Pola
reportSpec

object (MediationReportSpec)

Specyfikacja raportu sieci.

Treść odpowiedzi

Odpowiedź strumieniowa na raport zapośredniczenia AdMob. Pierwsza odpowiedź zawiera nagłówek raportu, potem strumień odpowiedzi w wierszach, a na koniec stopkę jako ostatnią odpowiedź.

Na przykład:

[{
  "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": {"decimal_value": "1324746"}
    }
  }
},
{
  "footer": {"matchingRowCount": 1}
}]

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis 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.
}
Pola
Pole sumy payload. Każda wiadomość z odpowiedzią w strumieniu zawiera 1 typ ładunku. payload może być tylko jedną z tych wartości:
header

object (ReportHeader)

Ustawienia generowania raportu opisujące jego treść, takie jak zakres dat i ustawienia lokalizacji.
row

object (ReportRow)

Rzeczywiste dane raportu.
footer

object (ReportFooter)

dodatkowe informacje o wygenerowanym raporcie, np. ostrzeżenia dotyczące danych;

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w omówieniu protokołu OAuth 2.0.

MediationReportSpec

Specyfikacja generowania raportu zapośredniczenia AdMob. Na przykład specyfikacja określająca obserwowany eCPM z podziałem na źródła reklam i aplikację w przypadku krajów „Stany Zjednoczone” i „CN” może wyglądać tak:

{
  "dateRange": {
    "startDate": {"year": 2021, "month": 9, "day": 1},
    "endDate": {"year": 2021, "month": 9, "day": 30}
  },
  "dimensions": ["AD_SOURCE", "APP", "COUNTRY"],
  "metrics": ["OBSERVED_ECPM"],
  "dimensionFilters": [
    {
      "dimension": "COUNTRY",
      "matchesAny": {"values": [{"value": "US", "value": "CN"}]}
    }
  ],
  "sortConditions": [
    {"dimension":"APP", order: "ASCENDING"}
  ],
  "localizationSettings": {
    "currencyCode": "USD",
    "languageCode": "en-US"
  }
}

Aby lepiej zrozumieć, możesz potraktować poprzednią specyfikację jak poniżej pseudo SQL:

SELECT AD_SOURCE, APP, COUNTRY, OBSERVED_ECPM
FROM MEDIATION_REPORT
WHERE DATE >= '2021-09-01' AND DATE <= '2021-09-30'
    AND COUNTRY IN ('US', 'CN')
GROUP BY AD_SOURCE, APP, COUNTRY
ORDER BY APP ASC;
Zapis JSON 
{
  "dateRange": {
    object (DateRange)
  },
  "dimensions": [
    enum (Dimension)
  ],
  "metrics": [
    enum (Metric)
  ],
  "dimensionFilters": [
    {
      object (DimensionFilter)
    }
  ],
  "sortConditions": [
    {
      object (SortCondition)
    }
  ],
  "localizationSettings": {
    object (LocalizationSettings)
  },
  "maxReportRows": integer,
  "timeZone": string
}
Pola
dateRange

object (DateRange)

Zakres dat, dla którego generowany jest raport.
dimensions[]

enum (Dimension)

Lista wymiarów w raporcie. Kombinacja wartości tych wymiarów określa wiersz raportu. Jeśli nie określisz żadnych wymiarów, raport zwróci jeden wiersz z żądanymi danymi dla całego konta.
metrics[]

enum (Metric)

Lista danych w raporcie. Raport musi zawierać co najmniej jeden rodzaj danych.
dimensionFilters[]

object (DimensionFilter)

Wskazuje wiersze raportu, które mają zostać dopasowane na podstawie ich wartości wymiarów.
sortConditions[]

object (SortCondition)

Opisuje sortowanie wierszy raportu. Kolejność warunku na liście określa jego kolejność – im wcześniejszy warunek, tym większa jego kolejność. Jeśli nie określisz warunków sortowania, kolejność wierszy będzie nieokreślona.
localizationSettings

object (LocalizationSettings)

Ustawienia lokalizacji raportu.
maxReportRows

integer

Maksymalna liczba wierszy danych raportu do zwrócenia. Jeśli wartość nie jest ustawiona, interfejs API zwróci maksymalną możliwą liczbę wierszy, maksymalnie 100 000. Akceptowane wartości to od 1 do 100 000 włącznie. Wartości większe niż 100 000 zwracają błąd.
timeZone

string

Strefa czasowa raportu. Akceptuje wartości nazwy IANA TZ, takie jak „Ameryka/Los_Angeles”. Jeśli nie zdefiniowano strefy czasowej, zostanie zastosowana domyślna strefa czasowa konta. Sprawdź wartość domyślną, używając działania „Pobierz konto”.

Ostrzeżenie: obecnie jedyna obsługiwana wartość to „Ameryka/Los_Angeles”.

Wymiar

Wymiary raportu zapośredniczenia. Wymiary to atrybuty danych służące do podziału lub precyzowania pomiarów ilościowych (danych) według określonych atrybutów, takich jak format reklamy lub platforma, na której obejrzano reklamę.

Wartości w polu enum
DIMENSION_UNSPECIFIED Wartość domyślna nieskonfigurowanego pola. Nie używać.
DATE Data w formacie RRRRMMDD (np. „20210701”). W żądaniach można określić tylko 1 wymiar.
MONTH Miesiąc w formacie RRRRMM (np. „202107”). W żądaniach można określić tylko 1 wymiar.
WEEK Data pierwszego dnia tygodnia w formacie RRRRMMDD (np. „20210701”). W żądaniach można określić tylko 1 wymiar.
AD_SOURCE Unikalny identyfikator źródła reklam (np. „5450213213286189855” i „Sieć AdMob” jako wartość etykiety).
AD_SOURCE_INSTANCE Niepowtarzalny identyfikator wystąpienia źródła reklam (np. „ca-app-pub-1234:asi:5678” i „AdMob (domyślna)” jako wartość etykiety).
AD_UNIT Unikalny identyfikator jednostki reklamowej (np. „ca-app-pub-1234/8790”). Jeśli podasz wymiar AD_UNIT, aplikacja zostanie uwzględniona automatycznie.
APP Unikalny identyfikator aplikacji mobilnej (np. „ca-app-pub-1234~1234”).
MEDIATION_GROUP Niepowtarzalny identyfikator grupy zapośredniczenia (np. „ca-app-pub-1234:mg:1234” i „AdMob (domyślna)” jako wartość etykiety).
COUNTRY Kod kraju CLDR miejsca, w którym następuje wyświetlenie lub kliknięcie reklamy (np. „PL” lub „FR”). To jest wymiar geograficzny.
FORMAT Format jednostki reklamowej (np. „baner”, „natywna”) i wymiar wyświetlania reklam.
PLATFORM Mobilna platforma systemu operacyjnego aplikacji (np. „Android” lub „iOS”).
MOBILE_OS_VERSION Wersja systemu operacyjnego na urządzeniu mobilnym, np. „iOS 13.5.1”.
GMA_SDK_VERSION Wersja pakietu GMA SDK, np. „iOS 7.62.0”.
APP_VERSION_NAME W przypadku Androida nazwę wersji aplikacji można znaleźć w polu versionName w PackageInfo. W przypadku iOS nazwę wersji aplikacji można znaleźć w CFBundleShortVersionString.
SERVING_RESTRICTION Tryb ograniczenia wyświetlania reklam (np. „Reklamy niespersonalizowane”).

Wskaźnik

Dane z raportu zapośredniczenia. Dane to ilościowe pomiary pokazujące, w jaki sposób radzi sobie wydawca. Są one agregowane na podstawie poszczególnych zdarzeń reklamowych i grupowane według wymiarów raportu. Dane mogą być liczbą całkowitą lub dziesiętną (bez zaokrąglania).

Wartości w polu enum
METRIC_UNSPECIFIED Wartość domyślna nieskonfigurowanego pola. Nie używać.
AD_REQUESTS Liczba żądań. Wartość jest liczbą całkowitą.
CLICKS Liczba kliknięć reklamy przez użytkownika. Wartość jest liczbą całkowitą.
ESTIMATED_EARNINGS

Szacunkowe zarobki wydawcy AdMob. Jednostka waluty (USD, EUR lub inna) w danych o zarobkach jest określana na podstawie ustawienia lokalizacji waluty. Kwota jest wyrażona w mikro. Na przykład 6, 50 USD zostanie przedstawione jako 6500000.

Obsługiwane są szacunkowe zarobki w grupie zapośredniczenia i na poziomie wystąpienia źródła reklam od 20 października 2019 r. W przypadku okresów sprzed 20 października 2019 r. szacunkowe zarobki innych firm będą miały wartość 0.
IMPRESSIONS Łączna liczba reklam wyświetlonych użytkownikom. Wartość jest liczbą całkowitą.
IMPRESSION_CTR Stosunek liczby kliknięć do liczby wyświetleń. Podana wartość musi być podwójną (przybliżoną) wartością dziesiętną.
MATCHED_REQUESTS Liczba przypadków zwrócenia reklam w odpowiedzi na żądanie. Wartość jest liczbą całkowitą.
MATCH_RATE Stosunek dopasowanych żądań reklamy do łącznej liczby żądań reklamy. Podana wartość musi być podwójną (przybliżoną) wartością dziesiętną.
OBSERVED_ECPM

Szacunkowy średni eCPM zewnętrznej sieci reklamowej. Jednostka waluty (USD, EUR lub inna) w danych o zarobkach jest określana na podstawie ustawienia lokalizacji waluty. Kwota jest wyrażona w mikro. Na przykład 2, 30 USD zostanie przedstawione jako 2300000.

Obsługiwany jest szacowany średni eCPM na grupę zapośredniczenia i na poziomie wystąpienia źródła reklam od 20 października 2019 r. W przypadku okresów sprzed 20 października 2019 r. szacowany średni eCPM innej firmy będzie wskazywać 0.

DimensionFilter

Wskazuje wiersze raportu, które mają zostać dopasowane na podstawie ich wartości wymiarów.

Zapis 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.
}
Pola
dimension

enum (Dimension)

Stosuje kryterium filtra do określonego wymiaru.
Pole sumy operator. Operator filtra, który ma zostać zastosowany. operator może być tylko jedną z tych wartości:
matchesAny

object (StringList)

Dopasowuje wiersz, jeśli jego wartość dla określonego wymiaru jest w jednej z wartości określonych w tym warunku.

SortCondition

Kierunek sortowania, który zostanie zastosowany do wymiaru lub danych.

Zapis 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.
}
Pola
order

enum (SortOrder)

Kolejność sortowania wymiarów lub danych.
Pole sumy sort_on. Określa wartości, według których należy sortować. sort_on może być tylko jedną z tych wartości:
dimension

enum (Dimension)

Sortuj według określonego wymiaru.
metric

enum (Metric)

Sortuj według określonych danych.