Objet de données ReportRequest - Création de rapports

  • Article

Définit l’objet de base pour toutes les demandes de rapport.

N’instanciez pas cet objet. Au lieu de cela, vous pouvez instancier l’un des objets de demande de rapport qui dérive de cet objet, par exemple CampaignPerformanceReportRequest. Pour obtenir la liste des rapports, consultez le guide Types de rapports.

Syntaxe

<xs:complexType name="ReportRequest" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:sequence>
    <xs:element minOccurs="0" name="ExcludeColumnHeaders" nillable="true" type="xs:boolean" />
    <xs:element minOccurs="0" name="ExcludeReportFooter" nillable="true" type="xs:boolean" />
    <xs:element minOccurs="0" name="ExcludeReportHeader" nillable="true" type="xs:boolean" />
    <xs:element minOccurs="0" name="Format" nillable="true" type="tns:ReportFormat" />
    <xs:element minOccurs="0" name="FormatVersion" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="ReportName" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="ReturnOnlyCompleteData" nillable="true" type="xs:boolean" />
  </xs:sequence>
</xs:complexType>

Éléments

L’objet ReportRequest contient les éléments suivants : ExcludeColumnHeaders, ExcludeReportFooter, ExcludeReportHeader, Format, FormatVersion, ReportName, ReturnOnlyCompleteData.

Élément Description Type de données
ExcludeColumnHeaders Détermine si le rapport téléchargé doit contenir ou non des descriptions d’en-tête pour chaque colonne. L’en-tête de colonne de rapport correspond au nom de colonne demandé, par exemple Impressions et Clics.

Définissez cette propriété sur true si vous souhaitez que les en-têtes de colonne de rapport soient exclus du rapport téléchargé. La valeur par défaut est false.		 boolean
ExcludeReportFooter Détermine si le rapport téléchargé doit contenir ou non des métadonnées de pied de page telles que les droits d’auteur Microsoft (@2020 Microsoft Corporation. Tous droits réservés.).

Définissez cette propriété sur true si vous souhaitez que les métadonnées du pied de page de rapport soient exclues du rapport téléchargé. La valeur par défaut est false.		 boolean
ExcludeReportHeader Détermine si le rapport téléchargé doit contenir ou non des métadonnées d’en-tête telles que le nom du rapport, la plage de dates et l’agrégation.

Définissez cette propriété true si vous souhaitez que les métadonnées d’en-tête de rapport soient exclues du rapport téléchargé. La valeur par défaut est false.		 boolean
Format Format des données du rapport. Par exemple, vous pouvez demander les données au format de valeurs séparées par des virgules (CSV) ou de valeurs séparées par des tabulations (Tsv).

La valeur par défaut est Csv.

Tous les fichiers téléchargés sont compressés zip.		 ReportFormat
FormatVersion Détermine le format de certains champs dans le fichier de rapport téléchargé.

Le format de données de certains champs peut être mis à jour dans la version actuelle de l’API sans interrompre les applications clientes existantes. Vous pouvez obtenir le format de données le plus récent en définissant ce champ de requête facultatif sur 2.0. Si vous ne définissez pas ce champ, le service est défini par défaut sur la version 1.0.

Pour plus d’informations sur les modifications entre les versions de format, consultez Version du format de rapport.		 chaîne
ReportName Nom du rapport. Le nom est inclus dans l’en-tête du rapport. Si vous ne spécifiez pas de nom de rapport, le système génère un nom au format ReportType-ReportDateTime.

La longueur maximale du nom du rapport est de 200.		 chaîne
ReturnOnlyCompleteData Détermine si le service doit s’assurer que toutes les données ont été traitées et sont disponibles.

Si la valeur est true et si le système n’a pas fini de traiter toutes les données en fonction de l’agrégation, de l’étendue et de l’heure demandées, le service retourne le code d’erreur NoCompleteDataAvaliable (2004). Sinon, par défaut, la demande peut aboutir, rien n’indique si les données sont complètes et le rapport contient uniquement les données que le système a fini de traiter au moment de la demande.

Notez que étant donné que la date d’aujourd’hui est toujours en cours et que les données ne sont pas complètes, vous ne pouvez pas définir cet élément sur true si la période (date personnalisée ou prédéfinie) inclut la date du jour. Pour plus d’informations, consultez Fuseaux horaires dans la création de rapports.		 boolean

Configuration requise

Service : ReportingService.svc v13
Noms: https://bingads.microsoft.com/Reporting/v13

Utilisé par

SubmitGenerateReport