Condividi tramite


Oggetto dati KeywordPerformanceReportRequest - Creazione di report

Definisce una richiesta di report sulle prestazioni di una parola chiave. Usare questo report per scoprire quali parole chiave hanno buone prestazioni e quali no.

È possibile richiedere impressioni, clic, spesa e costo medio per clic per le pagine di destinazione. Una volta scaricati, questi dati possono essere ordinati per parola chiave, account, campagna e gruppo di annunci.

Per richiedere un report di questo tipo, passare questo oggetto all'operazione SubmitGenerateReport .

Nota

Non è consigliabile usare questo report per ottenere i dati sulle prestazioni per Microsoft Shopping Campaigns. È applicabile solo ad altri tipi di campagna.

Sintassi

<xs:complexType name="KeywordPerformanceReportRequest" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexContent mixed="false">
    <xs:extension base="tns:ReportRequest">
      <xs:sequence>
        <xs:element name="Aggregation" type="tns:ReportAggregation" />
        <xs:element name="Columns" nillable="true" type="tns:ArrayOfKeywordPerformanceReportColumn" />
        <xs:element minOccurs="0" name="Filter" nillable="true" type="tns:KeywordPerformanceReportFilter" />
        <xs:element minOccurs="0" name="MaxRows" type="xs:int" />
        <xs:element name="Scope" nillable="true" type="tns:AccountThroughAdGroupReportScope" />
        <xs:element minOccurs="0" name="Sort" nillable="true" type="tns:ArrayOfKeywordPerformanceReportSort" />
        <xs:element name="Time" nillable="true" type="tns:ReportTime" />
      </xs:sequence>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>

Elementi

L'oggetto KeywordPerformanceReportRequest include gli elementi seguenti: Aggregazione, Colonne, Filtro, MaxRows, Ambito, Ordinamento, Ora.

Elemento Descrizione Tipo di dati
Aggregazione Tipo di aggregazione da utilizzare per aggregare i dati del report. Ad esempio, è possibile aggregare i dati del report per giorno o settimana o richiedere un report di riepilogo.

L'aggregazione predefinita è Riepilogo. È importante notare che se non si include TimePeriod nell'elenco delle colonne, l'aggregazione scelta verrà ignorata e l'aggregazione di riepilogo verrà usata indipendentemente.
ReportAggregation
Colonne Elenco di attributi e statistiche sulle prestazioni da includere nel report. Il report includerà le colonne nell'ordine in cui vengono specificate. Matrice KeywordPerformanceReportColumn
Filtro Informazioni di filtro da utilizzare per filtrare i dati del report. KeywordPerformanceReportFilter
MaxRows Numero superiore di righe di dati da restituire nel report. int
Ambito Ambito dell'entità del report.

Usa questo elemento per limitare i dati del report a account, gruppi di annunci o campagne specifici.
AccountThroughAdGroupReportScope
Sorta Elenco delle colonne da ordinare e dell'ordinamento corrispondente. Matrice KeywordPerformanceReportSort
Ora Periodo di tempo da utilizzare per il report. È possibile specificare un intervallo di date personalizzato o selezionare un intervallo di date predefinito, ad esempio Today o ThisWeek.

Per un elenco dei periodi di tempo che è possibile specificare per ogni tipo di aggregazione, vedere Aggregazione e ora.

È possibile impostare il fuso orario all'interno dell'oggetto ReportTime , che consente di definire con precisione l'ambito dei dati per il periodo di tempo richiesto.

Se non si sceglie un fuso orario, il servizio di report usa PacificTimeUSCanadaTijuana per impostazione predefinita.
ReportTime

L'oggetto KeywordPerformanceReportRequest include elementi ereditati.

Elementi ereditati

Elementi ereditati da ReportRequest

L'oggetto KeywordPerformanceReportRequest deriva dall'oggetto ReportRequest ed eredita gli elementi seguenti: ExcludeColumnHeaders, ExcludeReportFooter, ExcludeReportHeader, Format, FormatVersion, ReportName, ReturnOnlyCompleteData. Le descrizioni seguenti sono specifiche di KeywordPerformanceReportRequest e potrebbero non essere applicabili ad altri oggetti che ereditano gli stessi elementi dall'oggetto ReportRequest .

Elemento Descrizione Tipo di dati
ExcludeColumnHeaders Determina se il report scaricato deve contenere o meno descrizioni di intestazione per ogni colonna. L'intestazione di colonna del report corrisponde al nome di colonna richiesto, ad esempio Impressions e Clicks.

Impostare questa proprietà su true se si desidera escludere le intestazioni di colonna del report dal report scaricato. Il valore predefinito è false.
Boolean
ExcludeReportFooter Determina se il report scaricato deve contenere o meno metadati del piè di pagina, ad esempio il copyright Microsoft (@2020 Microsoft Corporation. Tutti i diritti riservati.).

Impostare questa proprietà su true se si desidera escludere i metadati del piè di pagina del report dal report scaricato. Il valore predefinito è false.
Boolean
ExcludeReportHeader Determina se il report scaricato deve contenere o meno metadati di intestazione, ad esempio nome del report, intervallo di date e aggregazione.

Impostare questa proprietà su true se si desidera escludere i metadati dell'intestazione del report dal report scaricato. Il valore predefinito è false.
Boolean
Formato Formato dei dati del report. Ad esempio, è possibile richiedere i dati in formato csv (valori delimitati da virgole) o valori separati da tabulazioni (Tsv).

Il valore predefinito è Csv.

Tutti i file scaricati vengono compressi con zip.
Formato report
FormatVersion Determina il formato per determinati campi nel file di report scaricato.

Il formato dei dati per determinati campi può essere aggiornato all'interno della versione dell'API corrente senza interrompere le applicazioni client esistenti. È possibile ottenere il formato dati più recente impostando questo campo di richiesta facoltativo su 2.0. Se questo campo non viene impostato, per impostazione predefinita il servizio viene impostato sulla versione 1.0.

Per informazioni dettagliate sulle modifiche tra le versioni di formato, vedere Versione del formato del report.
Stringa
Reportname Nome del report. Il nome è incluso nell'intestazione del report. Se non si specifica un nome di report, il sistema genera un nome nel formato ReportType-ReportDateTime.

La lunghezza massima del nome del report è 200.
Stringa
ReturnOnlyCompleteData Determina se il servizio deve assicurarsi che tutti i dati siano stati elaborati e siano disponibili.

Se impostato su true e se il sistema non ha completato l'elaborazione di tutti i dati in base all'aggregazione, all'ambito e all'ora richiesti, il servizio restituisce il codice di errore NoCompleteDataAvaliable (2004). In caso contrario, per impostazione predefinita la richiesta può avere esito positivo, non esiste alcuna indicazione sul completamento dei dati e il report conterrà solo i dati che il sistema ha completato l'elaborazione al momento della richiesta.

Si noti che poiché la data odierna è ancora in corso e i dati non sono stati completati, non è possibile impostare questo elemento su true se il periodo di tempo (data personalizzata o predefinita) include la data odierna. Per altre informazioni, vedere Fusi orari nella creazione di report.
Boolean

Requisiti

Servizio: ReportingService.svc v13
Namespace: https://bingads.microsoft.com/Reporting/v13