Reports: request

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

Risorse richieste:

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 saperne di più, 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. La derivazione completa degli ID dal livello più basso nell'ambito desiderato è obbligatoria tramite l'agenzia.
reportScope.agencyId long ID agenzia DS.
reportScope.advertiserId long ID inserzionista DS.
reportScope.engineAccountId long ID account motore di DS.
reportScope.campaignId long ID campagna DS.
reportScope.adGroupId long ID gruppo di annunci DS.
reportScope.keywordId long ID parola chiave DS.
reportScope.adId long ID annuncio DS.
reportType string Determina il tipo di righe che vengono restituite nel report. Ad esempio, se specifichi reportType: keyword, ogni riga del report conterrà dati su una parola chiave. Consulta il riferimento Tipi di report per le colonne disponibili per ciascun tipo.
columns[] list Le colonne da includere nel report. Sono incluse le colonne di DoubleClick Search e le colonne salvate. Per le colonne di DoubleClick Search è richiesto solo il parametro columnName. Per le colonne salvate è richiesto solo il parametro savedColumnName. columnName e savedColumnName non possono essere impostati nella stessa intestazione.

Il numero massimo di colonne per richiesta è 300.

columns[].columnName string Nome di una colonna DoubleClick Search da includere nel report.
columns[].savedColumnName string Nome di una colonna salvata da includere nel report. Il report deve avere come ambito l'inserzionista o un segmento inferiore e questa colonna salvata deve essere già stata creata nell'interfaccia utente di DoubleClick Search.
columns[].headerText string Testo utilizzato per identificare questa colonna nell'output del report. Il valore predefinito è columnName o savedColumnName, se non specificato. Questa opzione può essere utilizzata per 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 viene specificato, viene sostituito l'intervallo di tempo complessivo del report solo per questa colonna. Deve essere fornito insieme a endDate.
columns[].endDate string Giorno inclusivo nel formato AAAA-MM-GG. Se viene specificato, viene sostituito l'intervallo di tempo complessivo del report solo per questa colonna. Deve essere fornito insieme a startDate.
columns[].groupByColumn boolean Solo report sincrono. Imposta su true per raggruppare in base a questa colonna. Il valore predefinito è false.
timeRange object Se in un report sono 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 modificati.
timeRange.changedAttributesSinceTimestamp datetime Timestamp UTC inclusivo in formato RFC, ad esempio 2013-07-16T10:16:23.555Z Consulta la documentazione aggiuntiva per informazioni 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 su cui eseguire il filtro. Può essere una colonna di DoubleClick Search o una colonna salvata.
filters[].column.columnName string Nome di una colonna DoubleClick Search da includere nel report.
filters[].column.savedColumnName string Nome di una colonna salvata da includere nel report. Il report deve avere come ambito l'inserzionista o un segmento inferiore e questa colonna salvata deve essere già stata creata nell'interfaccia utente di DoubleClick Search.
filters[].operator string Operatore da utilizzare nel filtro. Per un elenco degli operatori disponibili, consulta il riferimento ai filtri.
filters[].values[] list Un elenco di valori in base a cui filtrare il valore della colonna.

Il numero massimo di valori del filtro per richiesta è 300.

orderBy[] list Solo report sincrono. Un elenco di colonne e indicazioni che definiscono l'ordinamento da eseguire nelle 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 DoubleClick Search da includere nel report.
orderBy[].column.savedColumnName string Nome di una colonna salvata da includere nel report. Il report deve avere come ambito l'inserzionista o un segmento inferiore e questa colonna salvata deve essere già stata creata nell'interfaccia utente di DoubleClick Search.
orderBy[].sortOrder string La direzione di ordinamento, che può essere ascending o descending.
includeDeletedEntities boolean Determina se le entità rimosse devono essere incluse nel report. Il valore predefinito è false. Deprecato, utilizza invece 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 restituire il report. Al momento sono supportati csv o tsv.
statisticsCurrency string Specifica la valuta in cui verrà restituito il denaro. I valori possibili sono: usd, agency (valido se il report ha come ambito o inferiore), advertiser (valido se il report è limitato a * inserzionista o minore) o account (valido se il report è limitato a un account motore o inferiore).
startRow integer Solo report sincrono. Indice in base zero della prima riga da restituire. I valori accettabili sono compresi tra 0 e 50000 compresi. Il valore predefinito è 0.
rowCount integer Solo report sincrono. Il numero massimo di righe da restituire; le righe aggiuntive vengono eliminate. I valori accettabili sono compresi tra 0 e 10000 compresi. Il valore predefinito è 10000.
maxRowsPerFile integer Solo report asincrono. Il numero massimo di righe per file di report. Un report di grandi dimensioni è suddiviso in molti file basati su questo campo. I valori accettabili sono compresi tra 1000000 e 100000000 compresi.
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 avere come ambito un inserzionista o un inserzionista di livello inferiore e la dimensione personalizzata deve essere già impostata in DoubleClick Search. Il nome della dimensione personalizzata, che viene 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 dati per la dimensione personalizzata. I valori accettabili sono "lightlight".
filters[].column.customDimensionName string Segmenta un report in base a una dimensione personalizzata. Il report deve avere come ambito un inserzionista o un inserzionista di livello inferiore e la dimensione personalizzata deve essere già impostata in DoubleClick Search. Il nome della dimensione personalizzata, che viene 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. Il valore predefinito è columnName o savedColumnName, se non specificato. Questa opzione può essere utilizzata per 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 viene specificato, viene sostituito l'intervallo di tempo complessivo del report solo per questa colonna. Deve essere fornito insieme a endDate.
filters[].column.endDate string Giorno inclusivo nel formato AAAA-MM-GG. Se viene specificato, viene sostituito l'intervallo di tempo complessivo del report solo per questa colonna. Deve essere fornito insieme a startDate.
filters[].column.groupByColumn boolean Solo report sincrono. Imposta su true per raggruppare in base a questa colonna. Il valore predefinito è false.
filters[].column.platformSource string La piattaforma utilizzata per fornire dati per la dimensione personalizzata. I valori accettabili sono "lightlight".
orderBy[].column.customDimensionName string Segmenta un report in base a una dimensione personalizzata. Il report deve avere come ambito un inserzionista o un inserzionista di livello inferiore e la dimensione personalizzata deve essere già impostata in DoubleClick Search. Il nome della dimensione personalizzata, che viene 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. Il valore predefinito è columnName o savedColumnName, se non specificato. Questa opzione può essere utilizzata per 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 viene specificato, viene sostituito l'intervallo di tempo complessivo del report solo per questa colonna. Deve essere fornito insieme a endDate.
orderBy[].column.endDate string Giorno inclusivo nel formato AAAA-MM-GG. Se viene specificato, viene sostituito l'intervallo di tempo complessivo del report solo per questa colonna. Deve essere fornito insieme a startDate.
orderBy[].column.groupByColumn boolean Solo report sincrono. Imposta su true per raggruppare in base a questa colonna. Il valore predefinito è false.
orderBy[].column.platformSource string La piattaforma utilizzata per fornire dati per la dimensione personalizzata. I valori accettabili sono "lightlight".
columns[].customMetricName string Il nome di una metrica personalizzata da includere nel report. Il report deve avere come ambito un inserzionista o un livello inferiore e la metrica personalizzata deve essere già impostata in DoubleClick Search. Il nome della metrica personalizzata, che viene visualizzato in DoubleClick Search, è sensibile alle maiuscole.
filters[].column.customMetricName string Il nome di una metrica personalizzata da includere nel report. Il report deve avere come ambito un inserzionista o un livello inferiore e la metrica personalizzata deve essere già impostata in DoubleClick Search. Il nome della metrica personalizzata, che viene visualizzato in DoubleClick Search, è sensibile alle maiuscole.
orderBy[].column.customMetricName string Il nome di una metrica personalizzata da includere nel report. Il report deve avere come ambito un inserzionista o un livello inferiore e la metrica personalizzata deve essere già impostata in DoubleClick Search. Il nome della metrica personalizzata, che viene visualizzato 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 essere stati venduti o meno
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 essere stati venduti o meno
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 essere stati venduti o meno

Risposta

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

Prova.

Utilizza l'Explorer API di seguito per richiamare questo metodo sui dati in tempo reale e visualizzare la risposta. In alternativa, prova l'Explorer automatico.