Method: accounts.networkReport.generate

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

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
parent

string

Nome 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 (NetworkReportSpec)
  }
}
Campi
reportSpec

object (NetworkReportSpec)

Specifica del report sulla rete.

Corpo della risposta

La risposta in streaming per il report Rete AdMob in cui la prima risposta contiene l'intestazione del report, poi un flusso 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": {"microsValue": 6500000}
    }
  }
},
{
  "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 dello stream contiene un tipo di payload. payload può essere solo uno dei seguenti tipi:
header

object (ReportHeader)

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

object (ReportRow)

Dati effettivi del report.
footer

object (ReportFooter)

Informazioni aggiuntive sul report generato, ad esempio avvisi relativi ai 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 saperne di più, consulta la OAuth 2.0 Overview.

NetworkReportSpec

La specifica per la generazione di un report sulla rete AdMob. Ad esempio, la specifica per ottenere clic e utili stimati solo per i paesi "US" e "CN" può essere simile al seguente esempio:

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

Per una migliore comprensione, puoi trattare la specifica precedente come il seguente 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;
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 cui 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 delle metriche del report. Un report deve specificare almeno una metrica.
dimensionFilters[]

object (DimensionFilter)

Descrive le righe del report da 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 viene visualizzata 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

Il 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 accettabili sono compresi tra 1 e 100.000, inclusi. I valori superiori a 100.000 restituiscono un errore.
timeZone

string

Un fuso orario del report. Accetta valori di nome IANA TZ, ad esempio "America/Los_Angeles". Se non è definito alcun fuso orario, viene applicato il valore predefinito dell'account. Controlla il valore predefinito tramite l'azione Get account.

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

Dimensione

Le dimensioni del report sulla rete. Le dimensioni sono attributi dei dati per 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 esempio "20210701"). Le richieste possono specificare al massimo una dimensione temporale.
AD_UNIT L'ID univoco dell'unità pubblicitaria (ad esempio "ca-app-pub-1234/1234"). 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").
AD_TYPE

Tipo di annuncio (ad esempio "testo" o "immagine"), una dimensione di pubblicazione degli annunci.

Avviso:la dimensione non è compatibile con le metriche AD_REQUESTS, MATCH_RATE e IMPRESSION_RPM.
COUNTRY Codice paese CLDR del luogo in cui si verificano le visualizzazioni/i clic dell'annuncio (ad esempio "US" o "FR"). Si tratta di una dimensione geografica.
FORMAT Formato dell'unità pubblicitaria (ad esempio "banner", "native"), una dimensione di pubblicazione degli annunci.
PLATFORM Piattaforma del sistema operativo mobile dell'app (ad esempio "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 es. "iOS 7.62.0".
APP_VERSION_NAME Per Android, il nome della versione dell'app è disponibile in versionName in PackageInfo. Per iOS, il nome della versione dell'app si trova in CFBundleShortVersionString.
SERVING_RESTRICTION Modalità di limitazione per la pubblicazione degli annunci (ad es. "Annunci non personalizzati").

Metrica

Le metriche del report di rete. Le metriche sono misurazioni quantitative che indicano il rendimento dell'attività dell'editore. Vengono aggregati dai singoli eventi pubblicitari 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 di annunci. Il valore è un numero intero.

Avviso:la metrica non è compatibile con la dimensione AD_TYPE.
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 sugli utili è determinata dall'impostazione di localizzazione per la valuta. L'importo è in micro. Ad esempio, 6,50 $ sarebbero rappresentati come 6500000.
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 numero decimale a doppia precisione (approssimativo).
IMPRESSION_RPM

Gli utili stimati per mille impressioni dell'annuncio. Il valore è in micro. Ad esempio, 1,03 $ verrà rappresentato come 1030000. Equivalente all'eCPM nell'interfaccia utente AdMob.

Avviso:la metrica non è compatibile con la dimensione AD_TYPE.
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 numero decimale a doppia precisione (approssimativo).

Avviso:la metrica non è compatibile con la dimensione AD_TYPE.
SHOW_RATE Il rapporto tra gli annunci visualizzati e quelli restituiti, definito come impressioni / richieste con corrispondenza. Il valore è un numero decimale a doppia precisione (approssimativo).

DimensionFilter

Descrive le righe del report da 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 tipi:
matchesAny

object (StringList)

Trova la corrispondenza con una riga se il valore della dimensione specificata è 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 eseguire l'ordinamento. sort_on può essere solo uno dei seguenti tipi:
dimension

enum (Dimension)

Ordina in base alla dimensione specificata.
metric

enum (Metric)

Ordina in base alla metrica specificata.