Method: accounts.campaignReport.generate

Generuje raport kampanii na podstawie podanych specyfikacji.

Żądanie HTTP

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

object (CampaignReportSpec)

Specyfikacja raportu kampanii.

Treść odpowiedzi

Odpowiedź interfejsu Campaign Report API.

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

Zapis JSON 
{
  "rows": [
    {
      object (ReportRow)
    }
  ]
}
Pola
rows[]

object (ReportRow)

Raport obejmuje dane o kampanii od określonego wydawcy. Interfejs API zwróci maksymalnie 100 000 wierszy.

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.

CampaignReportSpec

Specyfikacja generowania raportu kampanii. Na przykład specyfikacja umożliwiająca podział danych WYŚWIETLEŃ i KLIKNIĘCIA według identyfikatora CAMPAIGN_ID może wyglądać tak:

{
  "dateRange": {
    "startDate": {"year": 2021, "month": 12, "day": 1},
    "endDate": {"year": 2021, "month": 12, "day": 30}
  },
  "dimensions": ["CAMPAIGN_ID"],
  "metrics": ["IMPRESSIONS", "CLICKS"],
}
Zapis JSON 
{
  "dateRange": {
    object (DateRange)
  },
  "dimensions": [
    enum (Dimension)
  ],
  "metrics": [
    enum (Metric)
  ],
  "languageCode": string
}
Pola
dateRange

object (DateRange)

Zakres dat, dla którego generowany jest raport. Maksymalny zakres to 30 dni.
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.
languageCode

string

Język używany w dowolnym zlokalizowanym tekście, np. określone odpowiednie wartości wymiarów. Tag języka jest zdefiniowany w dokumencie IETF BCP47. Domyślna wartość to „en-US” jeśli nie określono lub jest nieprawidłowe.

Wymiar

Wymiary raportu kampanii.

Wartości w polu enum
DIMENSION_UNSPECIFIED Wartość domyślna nieokreślonego wymiaru. Nie używać.
DATE Data w formacie RRRRMMDD (np. „20210701”).
CAMPAIGN_ID Unikalny identyfikator kampanii, np. „123456789”, który jest zgodny z identyfikatorem kampanii z interfejsu API listy kampanii.
CAMPAIGN_NAME Nazwa kampanii
AD_ID Unikalny identyfikator reklamy, np. „123456789”.
AD_NAME Nazwa reklamy, która nie może być unikalna.
PLACEMENT_ID Unikalny identyfikator aplikacji, w której umieszczona jest reklama. Na przykład com.goog.bar w przypadku aplikacji na Androida i 123456789 w przypadku aplikacji na iOS.
PLACEMENT_NAME Nazwa aplikacji, w której umieszczona jest reklama.
PLACEMENT_PLATFORM Platforma aplikacji, na której umieszczona jest reklama.
COUNTRY Nazwa kraju docelowego.
FORMAT Format jednostki reklamowej (np. „baner” lub „natywna”) – wymiar wyświetlania reklam.

Dane

Dane raportu kampanii.

Wartości w polu enum
METRIC_UNSPECIFIED Wartość domyślna pola nieskonfigurowanego. Nie używać.
IMPRESSIONS Liczba wyświetleń reklamy użytkownikowi.
CLICKS Liczba kliknięć reklamy przez użytkownika.
CLICK_THROUGH_RATE Liczba kliknięć reklamy podzielona przez liczbę jej wyświetleń.
INSTALLS Liczba pobrań aplikacji na urządzenia.
ESTIMATED_COST Szacowany koszt wyświetlania reklamy z kampanii zamiast reklamy, która generuje przychody. Jest to waluta raportów kampanii.
AVERAGE_CPI Średni koszt instalacji. Jest to średnia kwota wydana na pozyskanie nowego użytkownika. Jest to waluta raportów kampanii.
INTERACTIONS Liczba interakcji użytkownika z reklamą. Są to kliknięcia i interakcje.