Method: accounts.mediationReport.generate

Genera un report di Mediazione AdMob basato sulla specifica del report fornita. Restituisce il risultato di una RPC in streaming lato server. Il risultato viene restituito in una sequenza di risposte.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
parent

string

Nome della risorsa dell'account per cui generare il report. Esempio: accounts/pub-9876543210987654

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "reportSpec": {
    object (MediationReportSpec)
  }
}
Campi
reportSpec

object (MediationReportSpec)

Specifica del report sulla rete.

Corpo della risposta

La risposta in modalità flusso per il report Mediazione AdMob, in cui la prima risposta contiene l'intestazione del report, poi uno stream di risposte di riga e, infine, un piè di pagina come ultimo messaggio di risposta.

Ad esempio:

[{
  "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}
}]

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione 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.
}
Campi
Campo unione payload. Ogni messaggio di risposta al flusso contiene un tipo di payload. payload può essere solo uno dei seguenti:
header

object (ReportHeader)

Impostazioni di generazione del report che descrivono i contenuti del report, ad esempio le impostazioni di localizzazione e intervallo di date del report.
row

object (ReportRow)

Dati del report effettivi.
footer

object (ReportFooter)

Informazioni aggiuntive sul report generato, ad esempio avvisi sui dati.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per ulteriori informazioni, consulta la panoramica di OAuth 2.0.

MediationReportSpec

La specifica per generare un report Mediazione AdMob. Ad esempio, la specifica per ottenere l'ECPM osservato suddiviso per origine annuncio e app per gli "Stati Uniti". e "CN" paesi possono avere il seguente esempio:

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

Per una migliore comprensione, puoi trattare la specifica precedente come il seguente codice 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;
Rappresentazione JSON 
{
  "dateRange": {
    object (DateRange)
  },
  "dimensions": [
    enum (Dimension)
  ],
  "metrics": [
    enum (Metric)
  ],
  "dimensionFilters": [
    {
      object (DimensionFilter)
    }
  ],
  "sortConditions": [
    {
      object (SortCondition)
    }
  ],
  "localizationSettings": {
    object (LocalizationSettings)
  },
  "maxReportRows": integer,
  "timeZone": string
}
Campi
dateRange

object (DateRange)

L'intervallo di date per il quale viene generato il report.
dimensions[]

enum (Dimension)

Elenco delle dimensioni del report. La combinazione di valori di queste dimensioni determina la riga del report. Se non vengono specificate dimensioni, il report restituisce una singola riga di metriche richieste per l'intero account.
metrics[]

enum (Metric)

Elenco di metriche del report. Un report deve specificare almeno una metrica.
dimensionFilters[]

object (DimensionFilter)

Descrive quali righe del report abbinare in base ai valori delle dimensioni.
sortConditions[]

object (SortCondition)

Descrive l'ordinamento delle righe del report. L'ordine della condizione nell'elenco ne definisce la precedenza; prima la condizione, maggiore è la sua precedenza. Se non vengono specificate condizioni di ordinamento, l'ordinamento delle righe non è definito.
localizationSettings

object (LocalizationSettings)

Impostazioni di localizzazione del report.
maxReportRows

integer

Numero massimo di righe di dati del report da restituire. Se il valore non è impostato, l'API restituisce il maggior numero possibile di righe, fino a 100.000. I valori accettati sono 1-100.000 inclusi. Valori superiori a 100.000 restituiscono un errore.
timeZone

string

Il fuso orario di un report. Accetta valori nome IANA TZ, ad esempio "America/Los_Angeles". Se non viene definito alcun fuso orario, viene applicata l'impostazione predefinita dell'account. Controlla il valore predefinito tramite l'azione get account.

Avviso:il campo "America/Los_Angeles" è l'unico valore supportato al momento.

Dimensione

Le dimensioni del report sulla mediazione. Le dimensioni sono attributi dei dati che consentono di suddividere o perfezionare le misurazioni quantitative (metriche) in base a determinati attributi, ad esempio il formato dell'annuncio o la piattaforma su cui è stato visualizzato un annuncio.

Enum
DIMENSION_UNSPECIFIED Valore predefinito per un campo non impostato. Non utilizzare.
DATE Una data nel formato AAAAMMGG (ad esempio "20210701"). Le richieste possono specificare al massimo una dimensione temporale.
MONTH Un mese nel formato AAAAMM (ad esempio "202107"). Le richieste possono specificare al massimo una dimensione temporale.
WEEK La data del primo giorno di una settimana nel formato AAAAMMGG (ad es. "20210701"). Le richieste possono specificare al massimo una dimensione temporale.
AD_SOURCE L'ID univoco dell'origine annuncio, ad esempio "5450213213286189855" e "Rete AdMob" come valore etichetta.
AD_SOURCE_INSTANCE L'ID univoco dell'istanza dell'origine annuncio, ad esempio "ca-app-pub-1234:asi:5678" e "AdMob (predefinito)" come valore dell'etichetta.
AD_UNIT L'ID univoco dell'unità pubblicitaria, ad esempio "ca-app-pub-1234/8790". Se viene specificata la dimensione AD_UNIT, APP viene inclusa automaticamente.
APP L'ID univoco dell'applicazione mobile (ad esempio, "ca-app-pub-1234~1234").
MEDIATION_GROUP L'ID univoco del gruppo di mediazione, ad esempio "ca-app-pub-1234:mg:1234" e "AdMob (predefinito)" come valore dell'etichetta.
COUNTRY Il codice paese CLDR del luogo in cui si verificano le visualizzazioni/clic sull'annuncio (ad es. "US" o "FR"). Questa è una dimensione geografica.
FORMAT Formato dell'unità pubblicitaria (ad esempio "banner", "nativo"), una dimensione di pubblicazione dell'annuncio.
PLATFORM La piattaforma del sistema operativo mobile dell'app (ad es. "Android" o "iOS").
MOBILE_OS_VERSION Versione del sistema operativo mobile, ad es. "iOS 13.5.1".
GMA_SDK_VERSION Versione dell'SDK GMA, ad esempio "iOS 7.62.0".
APP_VERSION_NAME Per Android, il nome della versione dell'app si trova in versionName nella sezione PackageInfo. Per iOS, il nome della versione dell'app si trova in CFBundleShortVersionString.
SERVING_RESTRICTION Modalità di limitazione per la pubblicazione di annunci (ad es. "Annunci non personalizzati").

Metrica

Le metriche del report sulla mediazione. Le metriche sono misurazioni quantitative che indicano il rendimento dell'attività del publisher. Vengono aggregati a partire dai singoli eventi annuncio e raggruppati in base alle dimensioni del report. Il valore della metrica è un numero intero o decimale (senza arrotondamento).

Enum
METRIC_UNSPECIFIED Valore predefinito per un campo non impostato. Non utilizzare.
AD_REQUESTS Il numero di richieste. Il valore è un numero intero.
CLICKS Il numero di volte in cui un utente fa clic su un annuncio. Il valore è un numero intero.
ESTIMATED_EARNINGS

Gli utili stimati del publisher AdMob. L'unità di valuta (USD, EUR o altro) delle metriche relative alle entrate dipende dall'impostazione di localizzazione per la valuta. L'importo è in micro. Ad esempio, 6,50 $ viene rappresentato come 6500000.

Gli utili stimati per gruppo di mediazione e per livello di istanza di origine annuncio sono supportati a partire dal 20 ottobre 2019. Gli utili stimati di terze parti mostreranno 0 per le date precedenti al 20 ottobre 2019.
IMPRESSIONS Il numero totale di annunci mostrati agli utenti. Il valore è un numero intero.
IMPRESSION_CTR Il rapporto tra clic e impressioni. Il valore è un valore decimale a precisione doppia (approssimato).
MATCHED_REQUESTS Il numero di volte in cui gli annunci vengono restituiti in risposta a una richiesta. Il valore è un numero intero.
MATCH_RATE Il rapporto tra le richieste di annunci con corrispondenza e le richieste di annunci totali. Il valore è un valore decimale a precisione doppia (approssimato).
OBSERVED_ECPM

L'eCPM medio stimato della rete pubblicitaria di terze parti. L'unità di valuta (USD, EUR o altro) delle metriche relative alle entrate dipende dall'impostazione di localizzazione per la valuta. L'importo è in micro. Ad esempio, 2,30 $ viene rappresentato come 2300000.

L'eCPM medio stimato per gruppo di mediazione e per livello di istanza di origine annuncio è supportato a partire dal 20 ottobre 2019. L'eCPM medio stimato di terze parti mostrerà 0 per le date precedenti al 20 ottobre 2019.

DimensionFilter

Descrive quali righe del report abbinare in base ai valori delle dimensioni.

Rappresentazione 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.
}
Campi
dimension

enum (Dimension)

Applica il criterio di filtro alla dimensione specificata.
Campo unione operator. Operatore di filtro da applicare. operator può essere solo uno dei seguenti:
matchesAny

object (StringList)

Corrisponde a una riga se il suo valore per la dimensione specificata è in uno dei valori specificati in questa condizione.

SortCondition

Direzione di ordinamento da applicare a una dimensione o a una metrica.

Rappresentazione 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.
}
Campi
order

enum (SortOrder)

Ordine di ordinamento della dimensione o della metrica.
Campo unione sort_on. Identifica i valori in base ai quali ordinare. sort_on può essere solo uno dei seguenti:
dimension

enum (Dimension)

Ordina in base alla dimensione specificata.
metric

enum (Metric)

Ordina in base alla metrica specificata.