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

Article
11/13/2024

Définit une demande de rapport de synthèse budgétaire. Utilisez ce rapport pour découvrir les performances du budget de votre campagne pour le mois. Par exemple, le rapport indique votre budget mensuel, le montant que vous avez dépensé à ce jour et si vous avez l’objectif de dépenser votre budget mensuel.

Vous pouvez demander votre budget mensuel, le montant que vous avez dépensé à ce jour et si vous avez l’objectif de dépenser votre budget mensuel.

Pour demander un rapport de ce type, transmettez cet objet à l’opération SubmitGenerateReport .

<xs:complexType name="BudgetSummaryReportRequest" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexContent mixed="false">
    <xs:extension base="tns:ReportRequest">
      <xs:sequence>
        <xs:element name="Columns" nillable="true" type="tns:ArrayOfBudgetSummaryReportColumn" />
        <xs:element name="Scope" nillable="true" type="tns:AccountThroughCampaignReportScope" />
        <xs:element name="Time" nillable="true" type="tns:ReportTime" />
      </xs:sequence>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>

{
  "ExcludeColumnHeaders": "ValueHere",
  "ExcludeReportFooter": "ValueHere",
  "ExcludeReportHeader": "ValueHere",
  "Format": "ValueHere",
  "FormatVersion": "ValueHere",
  "ReportName": "ValueHere",
  "ReturnOnlyCompleteData": "ValueHere",
  "Type": "BudgetSummaryReportRequest",
  "Columns": [
    "ValueHere"
  ],
  "Scope": {
    "AccountIds": [
      "LongValueHere"
    ],
    "Campaigns": [
      {
        "AccountId": "LongValueHere",
        "CampaignId": "LongValueHere"
      }
    ]
  },
  "Time": {
    "CustomDateRangeEnd": {
      "Day": IntValueHere,
      "Month": IntValueHere,
      "Year": IntValueHere
    },
    "CustomDateRangeStart": {
      "Day": IntValueHere,
      "Month": IntValueHere,
      "Year": IntValueHere
    },
    "PredefinedTime": "ValueHere",
    "ReportTimeZone": "ValueHere"
  }
}

Éléments

L’objet BudgetSummaryReportRequest a les éléments suivants : Columns, Scope, Time.

Élément	Description	Type de données
Columns	Liste des attributs et des statistiques de performances à inclure dans le rapport. Le rapport inclut les colonnes dans l’ordre dans lequel vous les spécifiez.	Tableau BudgetSummaryReportColumn
Portée	Étendue de l’entité du rapport. Utilisez cet élément pour limiter les données du rapport à des comptes ou des campagnes spécifiques.	AccountThroughCampaignReportScope
Heure	Période à utiliser pour le rapport. Vous pouvez spécifier une plage de dates personnalisée ou sélectionner une plage de dates prédéfinie, par exemple Aujourd’hui ou Ce Mois. Le rapport de synthèse du budget est toujours agrégé par jour. Vous pouvez définir le fuseau horaire dans l’objet ReportTime , ce qui vous permet d’étendre avec précision les données pour la période demandée. Si vous ne choisissez pas de fuseau horaire, le service de création de rapports utilise PacificTimeUSCanadaTijuana par défaut.	ReportTime

L’objet BudgetSummaryReportRequest a des éléments hérités.

Éléments hérités

Éléments hérités de ReportRequest

L’objet BudgetSummaryReportRequest dérive de l’objet ReportRequest et hérite des éléments suivants : ExcludeColumnHeaders, ExcludeReportFooter, ExcludeReportHeader, Format, FormatVersion, ReportName, ReturnOnlyCompleteData. Les descriptions ci-dessous sont spécifiques à BudgetSummaryReportRequest et peuvent ne pas s’appliquer à d’autres objets qui héritent des mêmes éléments de l’objet ReportRequest .

É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’é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 truesi la période (qu’elle soit 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
Namespace: https://bingads.microsoft.com/Reporting/v13

Partager via