Method: accounts.networkReport.generate

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

Żądanie HTTP

POST https://admob.googleapis.com/v1/{parent=accounts/*}/networkReport: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 (NetworkReportSpec)
  }
}
Pola
reportSpec

object (NetworkReportSpec)

Specyfikacja raportu dotyczącego sieci.

Treść odpowiedzi

Odpowiedź strumieniowa raportu sieci AdMob, w której pierwsza odpowiedź zawiera nagłówek raportu, potem strumień odpowiedzi w wierszu, a w końcu stopkę jako ostatnią wiadomość.

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": {"microsValue": 6500000}
    }
  }
},
{
  "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 jeden typ ładunku. payload może mieć tylko jedną z tych wartości:
header

object (ReportHeader)

Ustawienia generowania raportu, które opisują jego zawartość, np. zakres dat 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 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.

NetworkReportSpec

Specyfikacja generowania raportu sieci AdMob. Na przykład specyfikacja umożliwiająca uzyskiwanie kliknięć i szacunkowych zarobków tylko dla krajów „Stany Zjednoczone” i „CN” może wyglądać jak poniżej:

{
  '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'
  }
}

Aby lepiej zrozumieć tę specyfikację, możesz traktować poprzednią specyfikację jak tę pseudo SQL:

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;
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 został wygenerowany raport.
dimensions[]

enum (Dimension)

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

enum (Metric)

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

object (DimensionFilter)

Określa, które wiersze raportu mają być dopasowane na podstawie wartości wymiarów.
sortConditions[]

object (SortCondition)

Opisuje sortowanie wierszy raportu. Kolejność warunku na liście określa jego pierwszeństwo – im wcześniejszy warunek, tym większy będzie jego pierwszeństwo. Jeśli nie określono 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 jak najwięcej wierszy, maksymalnie 100 000. Dopuszczalne 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 żadnej strefy czasowej, zostanie zastosowana domyślna strefa czasowa konta. Sprawdź wartość domyślną przy użyciu działania „Pobierz konto”.

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

Wymiar

Wymiary raportu dotyczącego sieci. Wymiary to atrybuty danych służące do podziału lub zawężania 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ć maksymalnie 1 wymiar.
MONTH Miesiąc w formacie RRRRMM (np. „202107”). W żądaniach można określić maksymalnie 1 wymiar.
WEEK Data pierwszego dnia tygodnia w formacie RRRRMMDD (np. „20210701”). W żądaniach można określić maksymalnie 1 wymiar.
AD_UNIT Unikalny identyfikator jednostki reklamowej (np. „ca-app-pub-1234/1234”). Jeśli określisz wymiar AD_UNIT, parametr APP zostanie uwzględniony automatycznie.
APP Unikalny identyfikator aplikacji mobilnej (np. „ca-app-pub-1234~1234”).
AD_TYPE

Typ reklamy (np. „tekst” lub „obraz”) – wymiar wyświetlania reklamy.

Ostrzeżenie: ten wymiar jest niezgodny z danymi AD_REQUESTS, MATCH_RATE i IMPRESSION_RPM.
COUNTRY Kod kraju CLDR miejsca, w którym następuje wyświetlenie lub kliknięcie reklamy (np. „PL” lub „PL”). To jest wymiar geograficzny.
FORMAT Format jednostki reklamowej (np. „baner”, „natywna”) – wymiar wyświetlania reklam.
PLATFORM Platforma systemu operacyjnego na urządzenia mobilne aplikacji (np. „Android” lub „iOS”).
MOBILE_OS_VERSION Wersja systemu operacyjnego na urządzenia mobilne, 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 elemencie versionName w PackageInfo. W przypadku iOS nazwę wersji aplikacji można znaleźć w CFBundleShortVersionString.
SERVING_RESTRICTION Tryb ograniczonego wyświetlania reklam (np. „Reklamy niespersonalizowane”).

Dane

Dane raportu dotyczącego sieci. Dane to wartości, które odzwierciedlają wyniki firmy wydawcy. Są one agregowane na podstawie poszczególnych zdarzeń reklamowych i grupowane według wymiarów raportu. Wartością danych może być liczba całkowita lub ułamek dziesiętny (bez zaokrąglania).

Wartości w polu enum
METRIC_UNSPECIFIED Wartość domyślna nieskonfigurowanego pola. Nie używać.
AD_REQUESTS

Liczba żądań reklamy. Podana wartość jest liczbą całkowitą.

Ostrzeżenie: dane są niezgodne z wymiarem AD_TYPE.
CLICKS Liczba kliknięć reklamy przez użytkownika. Podana wartość jest liczbą całkowitą.
ESTIMATED_EARNINGS Szacunkowe zarobki wydawcy AdMob. Jednostka waluty (USD, EUR lub inna) w danych o zarobkach jest określana przez ustawienie lokalizacji dla waluty. Kwota jest wyrażona w mikro. Na przykład 6, 50 USD zostanie zapisane jako 6500000.
IMPRESSIONS Łączna liczba reklam wyświetlonych użytkownikom. Podana 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ą.
IMPRESSION_RPM

Szacunkowe zarobki z tysiąca wyświetleń reklamy. Wartość jest wyrażona w mikro. Na przykład 1, 03 USD zostanie przedstawiony jako 1030000. Odpowiednik eCPM w interfejsie AdMob.

Ostrzeżenie: dane są niezgodne z wymiarem AD_TYPE.
MATCHED_REQUESTS Liczba przypadków zwrócenia reklam w odpowiedzi na żądanie. Podana wartość jest liczbą całkowitą.
MATCH_RATE

Stosunek liczby dopasowanych żądań reklamy do łącznej liczby żądań reklamy. Podana wartość musi być podwójną (przybliżoną) wartością dziesiętną.

Ostrzeżenie: dane są niezgodne z wymiarem AD_TYPE.
SHOW_RATE Stosunek reklam wyświetlonych nad zwracanymi reklamami, zdefiniowany jako liczba wyświetleń / dopasowane żądania. Podana wartość musi być podwójną (przybliżoną) wartością dziesiętną.

DimensionFilter

Określa, które wiersze raportu mają być dopasowane na podstawie 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 do zastosowania. operator może mieć 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 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)

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

enum (Dimension)

Sortuj według określonego wymiaru.
metric

enum (Metric)

Posortuj dane według określonych danych.