Method: accounts.mediationReport.generate

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

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
parent

string

Nazwa zasobu konta, dla którego zostanie 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 dotyczącego sieci.

Treść odpowiedzi

Odpowiedź strumieniowa w raporcie zapośredniczenia AdMob, w której pierwsza odpowiedź zawiera nagłówek raportu, potem strumień odpowiedzi na wiersze, a ostatnią wiadomość ze stopką.

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ść odpowiedzi na żądanie strumienia zawiera 1 typ ładunku. payload może mieć tylko jedną z tych wartości:
header

object (ReportHeader)

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

object (ReportRow)

Rzeczywiste dane do raportu.
footer

object (ReportFooter)

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

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu OAuth:

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

Więcej informacji znajdziesz w artykule Omówienie protokołu OAuth 2.0.

MediationReportSpec

Specyfikacja generowania raportu zapośredniczenia AdMob. Na przykład specyfikacja umożliwiająca podzielenie zaobserwowanego eCPM według źródła reklam i aplikacji w przypadku „USA” i „CN” kraje mogą wyglądać następująco:

{
  "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ę jako taką 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 raportu. Kombinacja wartości tych wymiarów określa wiersz raportu. Jeśli nie podasz żadnych wymiarów, raport zwróci jeden wiersz żądanych danych dla całego konta.
metrics[]

enum (Metric)

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

object (DimensionFilter)

Opisuje, które wiersze raportu należy dopasować na podstawie ich wartości wymiarów.
sortConditions[]

object (SortCondition)

Opisuje sposób sortowania wierszy raportu. Kolejność warunków na liście określa jego pierwszeństwo. im wcześniej warunek, tym wyższy jest jego pierwszeństwo. Jeśli nie określono warunków sortowania, kolejność wierszy jest nieokreślona.
localizationSettings

object (LocalizationSettings)

Ustawienia lokalizacji raportu.
maxReportRows

integer

Maksymalna liczba wierszy danych raportu do zwrócenia. Jeśli ta wartość nie jest ustawiona, interfejs API zwraca jak najwięcej wierszy, do 100 000. Akceptowane wartości to 1–100 000 włącznie. Wartości większe niż 100 000 zwracają błąd.
timeZone

string

Strefa czasowa raportu. Akceptuje wartości nazwy TZ IANA, takie jak „America/Los_Angeles”. Jeśli strefa czasowa nie zostanie zdefiniowana, obowiązywać będzie domyślna strefa czasowa konta. Sprawdź wartość domyślną dla działania pobierania konta.

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

Wymiar

Wymiary raportu zapośredniczenia. Wymiary to atrybuty danych służące do dzielenia lub doprecyzowywania 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 pola nieskonfigurowanego. Nie używać.
DATE Data w formacie RRRRMMDD (np. „20210701”). W żądaniach można określić maksymalnie 1 wymiar jednorazowy.
MONTH Miesiąc w formacie RRRRMM (np. „202107”). W żądaniach można określić maksymalnie 1 wymiar jednorazowy.
WEEK Data pierwszego dnia tygodnia w formacie RRRRMMDD (np. „20210701”). W żądaniach można określić maksymalnie 1 wymiar jednorazowy.
AD_SOURCE Unikalny identyfikator źródła reklam (np. „5450213213286189855” i „Sieć AdMob” jako wartość etykiety).
AD_SOURCE_INSTANCE Unikalny identyfikator wystąpienia źródła reklam (np. „ca-app-pub-1234:asi:5678” i „AdMob (domyślnie)” jako wartość etykiety).
AD_UNIT Unikalny identyfikator jednostki reklamowej (np. „ca-app-pub-1234/8790”). Jeśli jest określony wymiar AD_UNIT, wymiar APP zostanie uwzględniony automatycznie.
APP Unikalny identyfikator aplikacji mobilnej (np. „ca-app-pub-1234~1234”).
MEDIATION_GROUP Unikalny identyfikator grupy zapośredniczenia (np. „ca-app-pub-1234:mg:1234” i „AdMob (domyślny)” jako wartość etykiety).
COUNTRY Kod kraju CLDR miejsca, w którym mają miejsce wyświetlenia lub kliknięcia reklamy (np. „US” lub „FR”). To jest wymiar geograficzny.
FORMAT Format jednostki reklamowej (np. „baner” lub „natywna”) – wymiar wyświetlania reklam.
PLATFORM Platforma systemu operacyjnego urządzenia mobilnego 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 SDK do reklam mobilnych Google, 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 ograniczonego dostępu do wyświetlania reklam (np. „Reklamy niespersonalizowane”).

Dane

Dane w raporcie zapośredniczenia. Dane to ilościowe dane pomiarowe, które informują o skuteczności działalności wydawcy. Są one agregowane z poszczególnych zdarzeń reklamowych i grupowane według wymiarów raportu. Wartością danych może być liczba całkowita lub dziesiętna (bez zaokrąglania).

Wartości w polu enum
METRIC_UNSPECIFIED Wartość domyślna pola nieskonfigurowanego. 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) danych o zarobkach zależy od ustawienia lokalizacji waluty. Ilość jest wyrażona w mikro. Na przykład 6, 50 PLN zostanie przedstawione jako 6500000.

Obsługiwane są szacunkowe zarobki na grupę zapośredniczenia i na poziomie źródła reklam od 20 października 2019 r. W przypadku dat sprzed 20 października 2019 r. szacunkowe zarobki z innych witryn 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ń. Wartość to podwójna precyzja (przybliżona) wartość dziesiętna.
MATCHED_REQUESTS Liczba zwrócenia reklam w odpowiedzi na żądanie. Wartość jest liczbą całkowitą.
MATCH_RATE Stosunek dopasowanych żądań reklamy do łącznej liczby żądań reklamy. Wartość to podwójna precyzja (przybliżona) wartość dziesiętna.
OBSERVED_ECPM

Szacowany średni eCPM zewnętrznej sieci reklamowej. Jednostka waluty (USD, EUR lub inna) danych o zarobkach zależy od ustawienia lokalizacji waluty. Ilość jest wyrażona w mikro. Na przykład 2, 30 PLN zostanie przedstawione jako 2300000.

Obsługujemy szacowany średni eCPM na grupę zapośredniczenia i na poziomie źródła reklam od 20 października 2019 r. W przypadku dat sprzed 20 października 2019 r. szacowany średni eCPM z innych witryn będzie wskazywać 0.

DimensionFilter

Opisuje, które wiersze raportu należy dopasować 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 mieć tylko jedną z tych wartości:
matchesAny

object (StringList)

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

SortCondition

Kierunek sortowania, który ma zostać 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 wymiaru lub danych.
Pole sumy sort_on. Określa wartości sortowania. sort_on może mieć tylko jedną z tych wartości:
dimension

enum (Dimension)

Sortuj według określonego wymiaru.
metric

enum (Metric)

Sortuj według określonych danych.