Reports: request

Inserisce una richiesta di report nel sistema di segnalazione. Prova subito.

Richiesta

Richiesta HTTP

POST https://www.googleapis.com/doubleclicksearch/v2/reports

Autorizzazione

Questa richiesta richiede l'autorizzazione con il seguente ambito:

Ambito
https://www.googleapis.com/auth/doubleclicksearch

Per ulteriori informazioni, consulta la pagina Autenticazione e autorizzazione.

Corpo della richiesta

Nel corpo della richiesta, fornisci i dati con la seguente struttura:

{
  "reportScope": {
    "agencyId": long,
    "advertiserId": long,
    "engineAccountId": long,
    "campaignId": long,
    "adGroupId": long,
    "keywordId": long,
    "adId": long
  },
  "reportType": string,
  "columns": [
    {
      "columnName": string,
      "savedColumnName": string,
      "customDimensionName": string,
      "customMetricName": string,
      "headerText": string,
      "startDate": string,
      "endDate": string,
      "groupByColumn": boolean,
      "platformSource": string,
      "productReportPerspective": string
    }
  ],
  "timeRange": {
    "startDate": string,
    "endDate": string,
    "changedMetricsSinceTimestamp": datetime,
    "changedAttributesSinceTimestamp": datetime
  },
  "filters": [
    {
      "column": {
        "columnName": string,
        "savedColumnName": string,
        "customDimensionName": string,
        "customMetricName": string,
        "headerText": string,
        "startDate": string,
        "endDate": string,
        "groupByColumn": boolean,
        "platformSource": string,
        "productReportPerspective": string
      },
      "operator": string,
      "values": [
        (value)
      ]
    }
  ],
  "orderBy": [
    {
      "column": {
        "columnName": string,
        "savedColumnName": string,
        "customDimensionName": string,
        "customMetricName": string,
        "headerText": string,
        "startDate": string,
        "endDate": string,
        "groupByColumn": boolean,
        "platformSource": string,
        "productReportPerspective": string
      },
      "sortOrder": string
    }
  ],
  "includeDeletedEntities": boolean,
  "includeRemovedEntities": boolean,
  "verifySingleTimeZone": boolean,
  "downloadFormat": string,
  "statisticsCurrency": string,
  "startRow": integer,
  "rowCount": integer,
  "maxRowsPerFile": integer
}
Nome proprietà Valore Descrizione Note
reportScope object reportScope è un insieme di ID utilizzati per determinare quale sottoinsieme di entità verrà restituito nel report. È richiesta la derivazione completa degli ID dal livello con ambito più basso desiderato fino all'agenzia.
reportScope.agencyId long ID agenzia DS.
reportScope.advertiserId long ID inserzionista DS.
reportScope.engineAccountId long ID account motore DS.
reportScope.campaignId long ID campagna DS.
reportScope.adGroupId long ID gruppo di annunci DS.
reportScope.keywordId long ID parola chiave di DS.
reportScope.adId long ID annuncio DS.
reportType string Determina il tipo di righe restituite nel report. Ad esempio, se specifichi reportType: keyword, ogni riga del report conterrà dati relativi a una parola chiave. Consulta la sezione Tipi di report per conoscere le colonne disponibili per ciascun tipo.
columns[] list Le colonne da includere nel report. Sono incluse sia le colonne di DoubleClick Search sia le colonne salvate. Per le colonne di DoubleClick Search, è richiesto solo il parametro columnName. Per le colonne salvate è richiesto solo il parametro savedColumnName. Impossibile impostare columnName e savedColumnName nella stessa stanza.

Il numero massimo di colonne per richiesta è 300.
columns[].columnName string Nome di una colonna di DoubleClick Search da includere nel report.
columns[].savedColumnName string Nome di una colonna salvata da includere nel report. Il report deve limitare l'ambito all'inserzionista o a un livello inferiore e questa colonna salvata deve essere già creata nell'interfaccia utente di DoubleClick Search.
columns[].headerText string Testo utilizzato per identificare questa colonna nell'output del report; se non specificato, il valore predefinito è columnName o savedColumnName. In questo modo puoi evitare conflitti tra le colonne di DoubleClick Search e le colonne salvate con lo stesso nome.
columns[].startDate string Data inclusiva nel formato AAAA-MM-GG. Se specificato, sostituisce l'intervallo di tempo complessivo del report solo per questa colonna. Devono essere forniti insieme a endDate.
columns[].endDate string Giorno inclusivo nel formato AAAA-MM-GG. Se specificato, sostituisce l'intervallo di tempo complessivo del report solo per questa colonna. Devono essere forniti insieme a startDate.
columns[].groupByColumn boolean Solo report sincrono. Imposta true per raggruppare in base a questa colonna. Il valore predefinito è false.
timeRange object Se in un report vengono richieste metriche, questo argomento verrà utilizzato per limitare le metriche a un intervallo di tempo specifico.
timeRange.startDate string Data inclusiva nel formato AAAA-MM-GG.
timeRange.endDate string Data inclusiva nel formato AAAA-MM-GG.
timeRange.changedMetricsSinceTimestamp datetime Timestamp UTC inclusivo in formato RFC, ad esempio 2013-07-16T10:16:23.555Z. Consulta ulteriori riferimenti sul funzionamento dei report sulle metriche modificate.
timeRange.changedAttributesSinceTimestamp datetime Timestamp UTC inclusivo in formato RFC, ad esempio 2013-07-16T10:16:23.555Z. Consulta ulteriori riferimenti sul funzionamento dei report sugli attributi modificati.
filters[] list Un elenco di filtri da applicare al report.

Il numero massimo di filtri per richiesta è 300.
filters[].column nested object Colonna in base alla quale eseguire il filtro. Può essere una colonna di DoubleClick Search o una colonna salvata.
filters[].column.columnName string Nome di una colonna di DoubleClick Search da includere nel report.
filters[].column.savedColumnName string Nome di una colonna salvata da includere nel report. Il report deve limitare l'ambito all'inserzionista o a un livello inferiore e questa colonna salvata deve essere già creata nell'interfaccia utente di DoubleClick Search.
filters[].operator string Operatore da utilizzare nel filtro. Consulta il riferimento ai filtri per un elenco degli operatori disponibili.
filters[].values[] list Un elenco di valori in base ai quali filtrare il valore della colonna.

Il numero massimo di valori di filtro per richiesta è 300.
orderBy[] list Solo report sincrono. Un elenco di colonne e direzioni che definiscono l'ordinamento da eseguire sulle righe del report.

Il numero massimo di ordini per richiesta è 300.
orderBy[].column nested object Colonna su cui eseguire l'ordinamento. Può essere una colonna definita da DoubleClick Search o una colonna salvata.
orderBy[].column.columnName string Nome di una colonna di DoubleClick Search da includere nel report.
orderBy[].column.savedColumnName string Nome di una colonna salvata da includere nel report. Il report deve limitare l'ambito all'inserzionista o a un livello inferiore e questa colonna salvata deve essere già creata nell'interfaccia utente di DoubleClick Search.
orderBy[].sortOrder string La direzione di ordinamento, ovvero ascending o descending.
includeDeletedEntities boolean Determina se le entità rimosse devono essere incluse nel report. Il valore predefinito è false. Deprecato, usa includeRemovedEntities.
verifySingleTimeZone boolean Se true, il report viene creato solo se tutti i dati statistici richiesti provengono da un unico fuso orario. Il valore predefinito è false.
downloadFormat string Formato in cui deve essere restituito il report. Attualmente sono supportati i criteri csv o tsv.
statisticsCurrency string Specifica la valuta in cui verrà restituito il valore monetario. I valori possibili sono: usd, agency (valido se l'ambito del report è un'agenzia o un livello inferiore), advertiser (valido se l'ambito del report è * inserzionista o un livello inferiore) o account (valido se l'ambito del report è un account motore o un livello inferiore).
startRow integer Solo report sincrono. Indice in base zero della prima riga da restituire. I valori accettati sono compresi tra 0 e 50000 (inclusi). Il valore predefinito è 0.
rowCount integer Solo report sincrono. Il numero massimo di righe da restituire. vengono eliminate altre righe. I valori accettati sono compresi tra 0 e 10000 (inclusi). Il valore predefinito è 10000.
maxRowsPerFile integer Solo report asincrono. Il numero massimo di righe per file di report. Un report di grandi dimensioni viene suddiviso in più file in base a questo campo. I valori accettati sono compresi tra 1000000 e 100000000 (inclusi).
includeRemovedEntities boolean Determina se le entità rimosse devono essere incluse nel report. Il valore predefinito è false.
columns[].customDimensionName string Segmenta un report in base a una dimensione personalizzata. Il report deve limitare l'ambito a un inserzionista o a un livello inferiore e la dimensione personalizzata deve essere già impostata in DoubleClick Search. Il nome della dimensione personalizzata visualizzato in DoubleClick Search è sensibile alle maiuscole.

Se utilizzato in un report sulle conversioni, restituisce il valore della dimensione personalizzata specificata per la conversione specificata, se impostato. Questa colonna non segmenta il report sulle conversioni.
columns[].platformSource string La piattaforma utilizzata per fornire i dati per la dimensione personalizzata. I valori accettati sono "floodlight".
filters[].column.customDimensionName string Segmenta un report in base a una dimensione personalizzata. Il report deve limitare l'ambito a un inserzionista o a un livello inferiore e la dimensione personalizzata deve essere già impostata in DoubleClick Search. Il nome della dimensione personalizzata visualizzato in DoubleClick Search è sensibile alle maiuscole.

Se utilizzato in un report sulle conversioni, restituisce il valore della dimensione personalizzata specificata per la conversione specificata, se impostato. Questa colonna non segmenta il report sulle conversioni.
filters[].column.headerText string Testo utilizzato per identificare questa colonna nell'output del report; se non specificato, il valore predefinito è columnName o savedColumnName. In questo modo puoi evitare conflitti tra le colonne di DoubleClick Search e le colonne salvate con lo stesso nome.
filters[].column.startDate string Data inclusiva nel formato AAAA-MM-GG. Se specificato, sostituisce l'intervallo di tempo complessivo del report solo per questa colonna. Devono essere forniti insieme a endDate.
filters[].column.endDate string Giorno inclusivo nel formato AAAA-MM-GG. Se specificato, sostituisce l'intervallo di tempo complessivo del report solo per questa colonna. Devono essere forniti insieme a startDate.
filters[].column.groupByColumn boolean Solo report sincrono. Imposta true per raggruppare in base a questa colonna. Il valore predefinito è false.
filters[].column.platformSource string La piattaforma utilizzata per fornire i dati per la dimensione personalizzata. I valori accettati sono "floodlight".
orderBy[].column.customDimensionName string Segmenta un report in base a una dimensione personalizzata. Il report deve limitare l'ambito a un inserzionista o a un livello inferiore e la dimensione personalizzata deve essere già impostata in DoubleClick Search. Il nome della dimensione personalizzata visualizzato in DoubleClick Search è sensibile alle maiuscole.

Se utilizzato in un report sulle conversioni, restituisce il valore della dimensione personalizzata specificata per la conversione specificata, se impostato. Questa colonna non segmenta il report sulle conversioni.
orderBy[].column.headerText string Testo utilizzato per identificare questa colonna nell'output del report; se non specificato, il valore predefinito è columnName o savedColumnName. In questo modo puoi evitare conflitti tra le colonne di DoubleClick Search e le colonne salvate con lo stesso nome.
orderBy[].column.startDate string Data inclusiva nel formato AAAA-MM-GG. Se specificato, sostituisce l'intervallo di tempo complessivo del report solo per questa colonna. Devono essere forniti insieme a endDate.
orderBy[].column.endDate string Giorno inclusivo nel formato AAAA-MM-GG. Se specificato, sostituisce l'intervallo di tempo complessivo del report solo per questa colonna. Devono essere forniti insieme a startDate.
orderBy[].column.groupByColumn boolean Solo report sincrono. Imposta true per raggruppare in base a questa colonna. Il valore predefinito è false.
orderBy[].column.platformSource string La piattaforma utilizzata per fornire i dati per la dimensione personalizzata. I valori accettati sono "floodlight".
columns[].customMetricName string Nome di una metrica personalizzata da includere nel report. Il report deve limitare l'ambito a un inserzionista o a un livello inferiore e la metrica personalizzata deve essere già impostata in DoubleClick Search. Il nome della metrica personalizzata che compare in DoubleClick Search è sensibile alle maiuscole.
filters[].column.customMetricName string Nome di una metrica personalizzata da includere nel report. Il report deve limitare l'ambito a un inserzionista o a un livello inferiore e la metrica personalizzata deve essere già impostata in DoubleClick Search. Il nome della metrica personalizzata che compare in DoubleClick Search è sensibile alle maiuscole.
orderBy[].column.customMetricName string Nome di una metrica personalizzata da includere nel report. Il report deve limitare l'ambito a un inserzionista o a un livello inferiore e la metrica personalizzata deve essere già impostata in DoubleClick Search. Il nome della metrica personalizzata che compare in DoubleClick Search è sensibile alle maiuscole.
columns[].productReportPerspective string Restituisce le metriche solo per un tipo specifico di attività del prodotto. I valori accettati sono:
  • "sold": restituisce le metriche solo per i prodotti venduti
  • "advertised": restituisce le metriche solo per i prodotti pubblicizzati in una campagna Shopping che potrebbero o meno essere stati venduti
filters[].column.productReportPerspective string Restituisce le metriche solo per un tipo specifico di attività del prodotto. I valori accettati sono:
  • "sold": restituisce le metriche solo per i prodotti venduti
  • "advertised": restituisce le metriche solo per i prodotti pubblicizzati in una campagna Shopping che potrebbero o meno essere stati venduti
orderBy[].column.productReportPerspective string Restituisce le metriche solo per un tipo specifico di attività del prodotto. I valori accettati sono:
  • "sold": restituisce le metriche solo per i prodotti venduti
  • "advertised": restituisce le metriche solo per i prodotti pubblicizzati in una campagna Shopping che potrebbero o meno essere stati venduti

Risposta

In caso di esito positivo, questo metodo restituisce una risorsa di report nel corpo della risposta.

Prova

Usa Explorer API in basso per chiamare questo metodo sui dati in tempo reale e visualizzare la risposta. In alternativa, prova la autonomo Spazio di esplorazione.