Opération PollGenerateReport Service - Création de rapports
Obtient la status d’une demande de rapport.
La création de rapports est un processus asynchrone. Voici le flux général pour demander un rapport.
- Créez une requête avec les paramètres de rapport. N’utilisez pas l’objet ReportRequest . Au lieu de cela, vous devez utiliser l’un des objets de demande de rapport dérivés, par exemple CampaignPerformanceReportRequest. Pour obtenir la liste des rapports, consultez le guide Types de rapports.
- Envoyez une demande au service de création de rapports, c’est-à-dire via SubmitGenerateReport.
- Le service met la demande en file d’attente jusqu’à ce qu’il soit en mesure de la traiter
- Interroger régulièrement le service pour obtenir la status du travail de rapport, c’est-à-dire via PollGenerateReport
- Lorsque le status d’interrogation est Réussite, utilisez l’URL que le service fournit pour télécharger le rapport.
Pour plus d’informations, consultez le guide Demander et télécharger un rapport .
Remarque
Vous devez utiliser les mêmes informations d’identification utilisateur pour SubmitGenerateReport et PollGenerateReport.
Éléments de demande
L’objet PollGenerateReportRequest définit les éléments body et header de la demande d’opération de service. Les éléments doivent être dans le même ordre que celui indiqué dans la requête SOAP.
Remarque
Sauf indication contraire ci-dessous, tous les éléments de requête sont requis.
Éléments du corps de la requête
| Élément | Description | Type de données |
|---|---|---|
| ReportRequestId | Identificateur de la demande de rapport.
L’opération SubmitGenerateReport retourne l’identificateur. L’identificateur est valide pendant un maximum d’un jour. Si vous n’avez pas correctement téléchargé le fichier pendant cette période, il est supprimé du site de téléchargement et vous devrez obtenir un nouvel identificateur de demande de rapport. La chaîne a une longueur allant jusqu’à 40 et peut contenir n’importe quel caractère. |
chaîne |
Éléments d’en-tête de requête
| Élément | Description | Type de données |
|---|---|---|
| AuthenticationToken | Jeton d’accès OAuth qui représente les informations d’identification d’un utilisateur disposant d’autorisations sur les comptes Microsoft Advertising. Pour plus d’informations, consultez Authentification avec OAuth. |
chaîne |
| CustomerAccountId | Identificateur du compte publicitaire qui possède ou est associé aux entités dans la demande. Cet élément d’en-tête doit avoir la même valeur que l’élément de corps AccountId lorsque les deux sont nécessaires. Cet élément est requis pour la plupart des opérations de service et, à titre de bonne pratique, vous devez toujours le définir. Pour plus d’informations, consultez Obtenir votre compte et ID de client. |
chaîne |
| CustomerId | Identificateur du compte de responsable (client) auquel l’utilisateur accède ou à partir duquel il opère. Un utilisateur peut avoir accès à plusieurs comptes de gestionnaire. Cet élément est requis pour la plupart des opérations de service et, à titre de bonne pratique, vous devez toujours le définir. Pour plus d’informations, consultez Obtenir votre compte et ID de client. |
chaîne |
| DeveloperToken | Jeton de développeur utilisé pour accéder à l’API Bing Ads. Pour plus d’informations, consultez Obtenir un jeton de développeur. |
chaîne |
| Mot de passe | Cet élément est réservé à un usage interne et sera supprimé d’une version ultérieure de l’API. Vous devez utiliser l’élément AuthenticationToken pour définir les informations d’identification de l’utilisateur. | chaîne |
| UserName | Cet élément est réservé à un usage interne et sera supprimé d’une version ultérieure de l’API. Vous devez utiliser l’élément AuthenticationToken pour définir les informations d’identification de l’utilisateur. | chaîne |
Éléments Response
L’objet PollGenerateReportResponse définit les éléments body et header de la réponse de l’opération de service. Les éléments sont retournés dans le même ordre que celui indiqué dans la réponse SOAP.
Response Body, éléments
| Élément | Description | Type de données |
|---|---|---|
| ReportRequestStatus | Contient les status de la demande de rapport et l’URL de téléchargement. | ReportRequestStatus |
Éléments d’en-tête de réponse
| Élément | Description | Type de données |
|---|---|---|
| TrackingId | Identificateur de l’entrée de journal qui contient les détails de l’appel d’API. | chaîne |
Requête SOAP
Ce modèle a été généré par un outil pour afficher l’ordre des éléments body et header pour la requête SOAP. Pour connaître les types pris en charge que vous pouvez utiliser avec cette opération de service, consultez la référence Éléments du corps de la demande ci-dessus.
<s:Envelope xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header xmlns="https://bingads.microsoft.com/Reporting/v13">
<Action mustUnderstand="1">PollGenerateReport</Action>
<AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
<CustomerAccountId i:nil="false">ValueHere</CustomerAccountId>
<CustomerId i:nil="false">ValueHere</CustomerId>
<DeveloperToken i:nil="false">ValueHere</DeveloperToken>
</s:Header>
<s:Body>
<PollGenerateReportRequest xmlns="https://bingads.microsoft.com/Reporting/v13">
<ReportRequestId i:nil="false">ValueHere</ReportRequestId>
</PollGenerateReportRequest>
</s:Body>
</s:Envelope>
Soap de réponse
Ce modèle a été généré par un outil pour afficher l’ordre des éléments de corps et d’en-tête pour la réponse SOAP.
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header xmlns="https://bingads.microsoft.com/Reporting/v13">
<TrackingId d3p1:nil="false" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</TrackingId>
</s:Header>
<s:Body>
<PollGenerateReportResponse xmlns="https://bingads.microsoft.com/Reporting/v13">
<ReportRequestStatus d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<ReportDownloadUrl d4p1:nil="false">ValueHere</ReportDownloadUrl>
<Status>ValueHere</Status>
</ReportRequestStatus>
</PollGenerateReportResponse>
</s:Body>
</s:Envelope>
Syntaxe du code
L’exemple de syntaxe peut être utilisé avec les Kits de développement logiciel (SDK) Bing Ads. Pour plus d’exemples, consultez Exemples de code de l’API Bing Ads .
public async Task<PollGenerateReportResponse> PollGenerateReportAsync(
string reportRequestId)
{
var request = new PollGenerateReportRequest
{
ReportRequestId = reportRequestId
};
return (await ReportingService.CallAsync((s, r) => s.PollGenerateReportAsync(r), request));
}
static PollGenerateReportResponse pollGenerateReport(
java.lang.String reportRequestId) throws RemoteException, Exception
{
PollGenerateReportRequest request = new PollGenerateReportRequest();
request.setReportRequestId(reportRequestId);
return ReportingService.getService().pollGenerateReport(request);
}
static function PollGenerateReport(
$reportRequestId)
{
$GLOBALS['Proxy'] = $GLOBALS['ReportingProxy'];
$request = new PollGenerateReportRequest();
$request->ReportRequestId = $reportRequestId;
return $GLOBALS['ReportingProxy']->GetService()->PollGenerateReport($request);
}
response=reporting_service.PollGenerateReport(
ReportRequestId=ReportRequestId)
Configuration requise
Service : ReportingService.svc v13
Namespace: https://bingads.microsoft.com/Reporting/v13
URL de la demande
https://reporting.api.bingads.microsoft.com/Reporting/v13/GenerateReport/Poll
Éléments de demande
L’objet PollGenerateReportRequest définit les éléments body et header de la demande d’opération de service.
Remarque
Sauf indication contraire ci-dessous, tous les éléments de requête sont requis.
Éléments du corps de la requête
| Élément | Description | Type de données |
|---|---|---|
| ReportRequestId | Identificateur de la demande de rapport.
L’opération SubmitGenerateReport retourne l’identificateur. L’identificateur est valide pendant un maximum d’un jour. Si vous n’avez pas correctement téléchargé le fichier pendant cette période, il est supprimé du site de téléchargement et vous devrez obtenir un nouvel identificateur de demande de rapport. La chaîne a une longueur allant jusqu’à 40 et peut contenir n’importe quel caractère. |
chaîne |
Éléments d’en-tête de requête
| Élément | Description | Type de données |
|---|---|---|
| Autorisation | Jeton d’accès OAuth qui représente les informations d’identification d’un utilisateur disposant d’autorisations sur les comptes Microsoft Advertising. Vérifiez que le jeton est précédé de « Porteur », ce qui est nécessaire pour une authentification appropriée. Pour plus d’informations, consultez Authentification avec OAuth. |
chaîne |
| CustomerAccountId | Identificateur du compte publicitaire qui possède ou est associé aux entités dans la demande. Cet élément d’en-tête doit avoir la même valeur que l’élément de corps AccountId lorsque les deux sont nécessaires. Cet élément est requis pour la plupart des opérations de service et, à titre de bonne pratique, vous devez toujours le définir. Pour plus d’informations, consultez Obtenir votre compte et ID de client. |
chaîne |
| CustomerId | Identificateur du compte de responsable (client) auquel l’utilisateur accède ou à partir duquel il opère. Un utilisateur peut avoir accès à plusieurs comptes de gestionnaire. Cet élément est requis pour la plupart des opérations de service et, à titre de bonne pratique, vous devez toujours le définir. Pour plus d’informations, consultez Obtenir votre compte et ID de client. |
chaîne |
| DeveloperToken | Jeton de développeur utilisé pour accéder à l’API Bing Ads. Pour plus d’informations, consultez Obtenir un jeton de développeur. |
chaîne |
| Mot de passe | Cet élément est réservé à un usage interne et sera supprimé d’une version ultérieure de l’API. Vous devez utiliser l’élément AuthenticationToken pour définir les informations d’identification de l’utilisateur. | chaîne |
| UserName | Cet élément est réservé à un usage interne et sera supprimé d’une version ultérieure de l’API. Vous devez utiliser l’élément AuthenticationToken pour définir les informations d’identification de l’utilisateur. | chaîne |
Éléments Response
L’objet PollGenerateReportResponse définit les éléments body et header de la réponse de l’opération de service. Les éléments sont retournés dans le même ordre que celui indiqué dans le json de réponse.
Response Body, éléments
| Élément | Description | Type de données |
|---|---|---|
| ReportRequestStatus | Contient les status de la demande de rapport et l’URL de téléchargement. | ReportRequestStatus |
Éléments d’en-tête de réponse
| Élément | Description | Type de données |
|---|---|---|
| TrackingId | Identificateur de l’entrée de journal qui contient les détails de l’appel d’API. | chaîne |
Requête JSON
Ce modèle a été généré par un outil pour afficher le corps et les éléments d’en-tête de la requête JSON. Pour connaître les types pris en charge que vous pouvez utiliser avec cette opération de service, consultez la référence Éléments du corps de la demande ci-dessus.
{
"ReportRequestId": "ValueHere"
}
JSON de réponse
Ce modèle a été généré par un outil pour afficher le corps et les éléments d’en-tête de la réponse JSON.
{
"ReportRequestStatus": {
"ReportDownloadUrl": "ValueHere",
"Status": "ValueHere"
}
}
Syntaxe du code
Pour appeler l’API REST via des kits SDK, vous devez mettre à niveau le KIT de développement logiciel (SDK) vers une certaine version et configurer les paramètres système. L’exemple de syntaxe peut être utilisé avec les Kits de développement logiciel (SDK) Bing Ads. Pour plus d’exemples, consultez Exemples de code de l’API Bing Ads .
public async Task<PollGenerateReportResponse> PollGenerateReportAsync(
string reportRequestId)
{
var request = new PollGenerateReportRequest
{
ReportRequestId = reportRequestId
};
return (await ReportingService.CallAsync((s, r) => s.PollGenerateReportAsync(r), request));
}
static PollGenerateReportResponse pollGenerateReport(
java.lang.String reportRequestId) throws RemoteException, Exception
{
PollGenerateReportRequest request = new PollGenerateReportRequest();
request.setReportRequestId(reportRequestId);
return ReportingService.getService().pollGenerateReport(request);
}
static function PollGenerateReport(
$reportRequestId)
{
$GLOBALS['Proxy'] = $GLOBALS['ReportingProxy'];
$request = new PollGenerateReportRequest();
$request->ReportRequestId = $reportRequestId;
return $GLOBALS['ReportingProxy']->GetService()->PollGenerateReport($request);
}
response=reporting_service.PollGenerateReport(
ReportRequestId=ReportRequestId)