Method: accounts.networkReport.generate

Generuje raport sieci AdMob na podstawie podanej specyfikacji raportu. Zwraca wynik strumieniowego wywołania RPC 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 w przypadku raportu sieci AdMob, w której pierwsza odpowiedź zawiera nagłówek raportu, a następnie strumień odpowiedzi wierszowych i w końcu stopkę jako ostatnią wiadomość odpowiedzi.

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 zbiorcze payload. Każda wiadomość odpowiedzi strumienia 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 raportu 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 sekcji OAuth 2.0 Overview.

NetworkReportSpec

Specyfikacja generowania raportu sieci AdMob. Specyfikacja, która pozwala uzyskać kliknięcia i szacunkowe zarobki tylko w przypadku krajów „US” i „CN”, może wyglądać tak:

{
  '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ć powyższą specyfikację, możesz potraktować ją jako pseudokod 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 generowany jest 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 jeden wiersz z żądanymi wartościami dla całego konta.
metrics[]

enum (Metric)

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

object (DimensionFilter)

Określa, które wiersze raportu mają być dopasowywane 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 wyższe 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 wartość nie jest ustawiona, interfejs API zwraca jak najwięcej 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 nazw stref czasowych IANA, np. „America/Los_Angeles”. Jeśli nie zdefiniujesz strefy czasowej, będzie obowiązywać domyślna strefa czasowa konta. Sprawdź wartość domyślną za pomocą działania pobierania konta.

Ostrzeżenie: obecnie obsługiwana jest tylko wartość „America/Los_Angeles”.

Wymiar

Wymiary raportu sieci. Wymiary to atrybuty danych, które umożliwiają podział lub doprecyzowanie 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, które nie zostało skonfigurowane. Nie używać.
DATE Data w formacie RRRRMMDD (np. „20210701”). Żądania mogą określać maksymalnie 1 wymiar czasu.
MONTH Miesiąc w formacie RRRRMM (np. „202107”). Żądania mogą określać maksymalnie 1 wymiar czasu.
WEEK Data pierwszego dnia tygodnia w formacie RRRRMMDD (np. „20210701”). Żądania mogą określać maksymalnie 1 wymiar czasu.
AD_UNIT Unikalny identyfikator jednostki reklamowej (np. „ca-app-pub-1234/1234”). Jeśli podany jest wymiar AD_UNIT, wymiar APP jest uwzględniany automatycznie.
APP Unikalny identyfikator aplikacji mobilnej (np. „ca-app-pub-1234~1234”).
AD_TYPE

Typ reklamy (np. „tekstowa” lub „graficzna”), 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 występują wyświetlenia lub kliknięcia reklamy (np. „US” lub „FR”). Jest to wymiar geograficzny.
FORMAT Format jednostki reklamowej (np. „baner”, „reklama natywna”), wymiar wyświetlania reklam.
PLATFORM Platforma systemu operacyjnego urządzenia mobilnego, na którym działa aplikacja (np. „Android” lub „iOS”).
MOBILE_OS_VERSION wersję mobilnego systemu operacyjnego, 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 parametrze versionName w pliku PackageInfo. W przypadku iOS nazwa wersji aplikacji znajduje się w parametrze CFBundleShortVersionString.
SERVING_RESTRICTION Tryb ograniczeń wyświetlania reklam (np. „Reklamy niespersonalizowane”).

Dane

Dane raportu sieci. Dane to ilościowe wyniki pomiarów, które wskazują skuteczność działalności wydawcy. Są one agregowane na podstawie poszczególnych zdarzeń związanych z reklamami i grupowane według wymiarów raportu. Wartość danych jest liczbą całkowitą lub dziesiętną (bez zaokrąglania).

Wartości w polu enum
METRIC_UNSPECIFIED Wartość domyślna pola, które nie zostało skonfigurowane. Nie używać.
AD_REQUESTS

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

Ostrzeżenie: dane są niezgodne z wymiarem AD_TYPE.
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 przypadku danych o zarobkach jest określana przez ustawienie lokalizacji waluty. Kwota jest podana w mikro. Na przykład 6, 50 zł będzie przedstawione jako 6500000.
IMPRESSIONS Łączna liczba reklam wyświetlonych użytkownikom. Wartość jest liczbą całkowitą.
IMPRESSION_CTR Stosunek liczby kliknięć do liczby wyświetleń. Wartość jest liczbą dziesiętną o podwójnej precyzji (przybliżoną).
IMPRESSION_RPM

Szacunkowe zarobki z tysiąca wyświetleń reklamy. Wartość jest podana w milionowych częściach jednostki. Na przykład 1, 03 PLN będzie przedstawione jako 1030000. Odpowiednik eCPM w interfejsie AdMob.

Ostrzeżenie: dane są niezgodne z wymiarem AD_TYPE.
MATCHED_REQUESTS Liczba przypadków, w których reklamy są zwracane w odpowiedzi na żądanie. Wartość jest liczbą całkowitą.
MATCH_RATE

Stosunek dopasowanych żądań reklamy do wszystkich żądań reklamy. Wartość jest liczbą dziesiętną o podwójnej precyzji (przybliżoną).

Ostrzeżenie: dane są niezgodne z wymiarem AD_TYPE.
SHOW_RATE Stosunek wyświetlonych reklam do reklam zwróconych, czyli wyświetlenia / dopasowane żądania. Wartość jest liczbą dziesiętną o podwójnej precyzji (przybliżoną).

DimensionFilter

Określa, które wiersze raportu mają być dopasowywane 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 zbiorcze operator. Operator filtra do zastosowania. operator może mieć tylko jedną z tych wartości:
matchesAny

object (StringList)

Dopasowuje wiersz, jeśli wartość określonego wymiaru jest jedną z wartości podanych w tym warunku.

SortCondition

Kierunek sortowania, który ma być stosowany 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 zbiorcze sort_on. Określa wartości, według których ma być przeprowadzane sortowanie. 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.