Consulta l'elenco dei metodi per questa risorsa alla fine di questa pagina.
Rappresentazioni delle risorse
Un report di DoubleClick Search. Questo oggetto contiene la richiesta di report, alcuni metadati di report, come il codice valuta, e le righe o i file di report generati
{ "kind": "doubleclicksearch#report", "id": string, "isReportReady": boolean, "request": { "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 }, "statisticsCurrencyCode": string, "statisticsTimeZone": string, "rowCount": integer, "files": [ { "url": string, "byteCount": long } ], "rows": [ { (key): (value) } ] }
Nome proprietà | Valore | Descrizione | Note |
---|---|---|---|
files[] |
list |
Solo report asincrono. Contiene un elenco dei file generati quando il report è stato completato correttamente. | |
files[].byteCount |
long |
Le dimensioni di questo file di report in byte. | |
files[].url |
string |
Utilizza questo URL per scaricare il file del report. | |
id |
string |
Solo report asincrono. ID del report. | |
isReportReady |
boolean |
Solo report asincrono. True se e solo se il report è stato completato correttamente e i file del report sono pronti per essere scaricati. | |
kind |
string |
Identifica questa risorsa come risorsa report. Valore: la stringa fissa doubleclicksearch#report . |
|
request |
nested object |
La richiesta che ha creato il report. I campi facoltativi non specificati nella richiesta originale sono compilati con valori predefiniti. | |
request.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. |
|
request.columns[].columnName |
string |
Nome di una colonna DoubleClick Search da includere nel report. | |
request.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. |
|
request.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. | |
request.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 . |
|
request.columns[].groupByColumn |
boolean |
Solo report sincrono. Imposta su true per raggruppare in base a questa colonna. Il valore predefinito è false . |
|
request.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. |
|
request.columns[].platformSource |
string |
La piattaforma utilizzata per fornire dati per la dimensione personalizzata. I valori accettabili sono "lightlight". | |
request.columns[].productReportPerspective |
string |
Restituisce le metriche solo per un tipo specifico di attività del prodotto. I valori accettati sono:
|
|
request.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. | |
request.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 . |
|
request.downloadFormat |
string |
Formato in cui restituire il report. Al momento sono supportati csv o tsv . |
|
request.filters[] |
list |
Un elenco di filtri da applicare al report. Il numero massimo di filtri per richiesta è 300. |
|
request.filters[].column |
nested object |
Colonna su cui eseguire il filtro. Può essere una colonna di DoubleClick Search o una colonna salvata. | |
request.filters[].column.columnName |
string |
Nome di una colonna DoubleClick Search da includere nel report. | |
request.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. |
|
request.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. | |
request.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 . |
|
request.filters[].column.groupByColumn |
boolean |
Solo report sincrono. Imposta su true per raggruppare in base a questa colonna. Il valore predefinito è false . |
|
request.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. |
|
request.filters[].column.platformSource |
string |
La piattaforma utilizzata per fornire dati per la dimensione personalizzata. I valori accettabili sono "lightlight". | |
request.filters[].column.productReportPerspective |
string |
Restituisce le metriche solo per un tipo specifico di attività del prodotto. I valori accettati sono:
|
|
request.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. | |
request.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 . |
|
request.filters[].operator |
string |
Operatore da utilizzare nel filtro. Per un elenco degli operatori disponibili, consulta il riferimento ai filtri. | |
request.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. |
|
request.includeDeletedEntities |
boolean |
Determina se le entità rimosse devono essere incluse nel report. Il valore predefinito è false . Deprecato, utilizza invece includeRemovedEntities . |
|
request.includeRemovedEntities |
boolean |
Determina se le entità rimosse devono essere incluse nel report. Il valore predefinito è false . |
|
request.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. |
|
request.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. |
|
request.orderBy[].column |
nested object |
Colonna su cui eseguire l'ordinamento. Può essere una colonna definita da DoubleClick Search o una colonna salvata. | |
request.orderBy[].column.columnName |
string |
Nome di una colonna DoubleClick Search da includere nel report. | |
request.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. |
|
request.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. | |
request.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 . |
|
request.orderBy[].column.groupByColumn |
boolean |
Solo report sincrono. Imposta su true per raggruppare in base a questa colonna. Il valore predefinito è false . |
|
request.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. |
|
request.orderBy[].column.platformSource |
string |
La piattaforma utilizzata per fornire dati per la dimensione personalizzata. I valori accettabili sono "lightlight". | |
request.orderBy[].column.productReportPerspective |
string |
Restituisce le metriche solo per un tipo specifico di attività del prodotto. I valori accettati sono:
|
|
request.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. | |
request.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 . |
|
request.orderBy[].sortOrder |
string |
La direzione di ordinamento, che può essere ascending o descending . |
|
request.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. | |
request.reportScope.adGroupId |
long |
ID gruppo di annunci DS. | |
request.reportScope.adId |
long |
ID annuncio DS. | |
request.reportScope.advertiserId |
long |
ID inserzionista DS. | |
request.reportScope.agencyId |
long |
ID agenzia DS. | |
request.reportScope.campaignId |
long |
ID campagna DS. | |
request.reportScope.engineAccountId |
long |
ID account motore di DS. | |
request.reportScope.keywordId |
long |
ID parola chiave DS. | |
request.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. |
|
request.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 . |
|
request.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 . |
|
request.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). |
|
request.timeRange |
object |
Se in un report sono richieste metriche, questo argomento verrà utilizzato per limitare le metriche a un intervallo di tempo specifico. | |
request.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. |
|
request.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. |
|
request.timeRange.endDate |
string |
Data inclusiva nel formato AAAA-MM-GG. | |
request.timeRange.startDate |
string |
Data inclusiva nel formato AAAA-MM-GG. | |
request.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 . |
|
rowCount |
integer |
Il numero di righe del report generate dal report, escluse le intestazioni. | |
rows[] |
list |
Solo report sincrono. Generazione di righe di report. | |
rows[].(key) |
any value |
Indica le colonne rappresentate in questa riga. Ciò significa che ogni chiave corrisponde a una colonna con una cella non vuota in questa riga. | |
statisticsCurrencyCode |
string |
Il codice valuta di tutti i valori monetari generati nel report, inclusi i valori impostati dagli utenti (ad es. le impostazioni dell'offerta per parola chiave) e le metriche (ad es. costo ed entrate). Il codice valuta di un report è determinato dal campo statisticsCurrency della richiesta di report. |
|
statisticsTimeZone |
string |
Se tutte le statistiche del report provengono dallo stesso fuso orario, questo sarebbe. In caso contrario, il campo non viene impostato. |
Metodi
- genera
- Genera e restituisce immediatamente un report.
- ricevi
- Sondaggi per lo stato di una richiesta di segnalazione.
- getFile
- Scarica un file di report codificato in UTF-8.
- File IDMapping
- Scarica un file CSV (codificato in UTF-8) che contiene le mappature degli ID tra il precedente Search Ads 360 e il nuovo Search Ads 360. Per l'inserzionista richiesto, il file include tutte le entità secondarie (ad es. account motore, campagne, gruppi di annunci e così via) esistenti sia nella precedente esperienza Search Ads 360 sia nella nuova.
- richiesta
- Inserisce una richiesta di report nel sistema di reporting.