Partager via


Opération de service GetAccountMonthlySpend - Facturation client

Obtient le montant dépensé par le compte dans le mois spécifié.

Éléments de demande

L’objet GetAccountMonthlySpendRequest 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
AccountId Identificateur du compte qui contient les informations de dépense à obtenir.

Le compte doit utiliser le mode de paiement par facture ; les comptes carte de crédit ne sont pas pris en charge.

Si l’identificateur de compte appartient à un agrégateur, l’opération additionne le solde du compte pour tous les comptes de tous les clients que l’agrégateur gère. Si l’agrégateur a dix clients et que chaque client a dix comptes, l’opération retourne la somme des dépenses mensuelles des 100 comptes. Pour obtenir les dépenses mensuelles d’un seul compte d’un client que l’agrégateur gère, définissez l’élément AccountId sur l’identificateur de compte spécifié. Pour obtenir les dépenses mensuelles de tous les comptes d’un client que l’agrégateur gère, appelez cette opération pour chaque compte, puis additionnez les montants des dépenses mensuelles.
long
MonthYear Mois et année pour lesquels vous souhaitez obtenir les informations sur les dépenses mensuelles (l’opération ignore les valeurs de jour et d’heure).

Le service utilise les composants month et year correspondant au dateTime spécifié. Par exemple, 2020-05-15T00:00:00 et 2020-05 sont tous deux valides et retournent les mêmes résultats.

Si vous spécifiez le mois en cours, l’opération retourne le montant des dépenses mensuelles à ce jour. Par exemple, si la date actuelle est le 15 mai 2020 et que vous définissez MonthYear sur mai 2020, l’opération retourne le montant des dépenses du 1er mai au 15 mai inclus.

Vous ne pouvez pas spécifier un mois et une année futurs. Si vous spécifiez un mois précédent pour lequel il n’y a pas de données, l’appel retourne 0 (zéro).

Le montant des dépenses peut s’étendre sur plusieurs ordres d’insertion (E/S). Si les crédits sont supérieurs aux dépenses réelles, le montant des dépenses mensuelles retournées est une valeur négative.
dateTime

É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
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 GetAccountMonthlySpendResponse 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
Montant Montant dépensé par le compte au cours de la période spécifiée.

Le compte doit être géré par Yahoo !.

Si le compte n’est pas géré par Yahoo !, la valeur de retour est 0.
double

É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/Billing/v13">
    <Action mustUnderstand="1">GetAccountMonthlySpend</Action>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
  </s:Header>
  <s:Body>
    <GetAccountMonthlySpendRequest xmlns="https://bingads.microsoft.com/Billing/v13">
      <AccountId>ValueHere</AccountId>
      <MonthYear>ValueHere</MonthYear>
    </GetAccountMonthlySpendRequest>
  </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/Billing/v13">
    <TrackingId d3p1:nil="false" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</TrackingId>
  </s:Header>
  <s:Body>
    <GetAccountMonthlySpendResponse xmlns="https://bingads.microsoft.com/Billing/v13">
      <Amount>ValueHere</Amount>
    </GetAccountMonthlySpendResponse>
  </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<GetAccountMonthlySpendResponse> GetAccountMonthlySpendAsync(
	long accountId,
	DateTime monthYear)
{
	var request = new GetAccountMonthlySpendRequest
	{
		AccountId = accountId,
		MonthYear = monthYear
	};

	return (await CustomerBillingService.CallAsync((s, r) => s.GetAccountMonthlySpendAsync(r), request));
}
static GetAccountMonthlySpendResponse getAccountMonthlySpend(
	java.lang.Long accountId,
	Calendar monthYear) throws RemoteException, Exception
{
	GetAccountMonthlySpendRequest request = new GetAccountMonthlySpendRequest();

	request.setAccountId(accountId);
	request.setMonthYear(monthYear);

	return CustomerBillingService.getService().getAccountMonthlySpend(request);
}
static function GetAccountMonthlySpend(
	$accountId,
	$monthYear)
{

	$GLOBALS['Proxy'] = $GLOBALS['CustomerBillingProxy'];

	$request = new GetAccountMonthlySpendRequest();

	$request->AccountId = $accountId;
	$request->MonthYear = $monthYear;

	return $GLOBALS['CustomerBillingProxy']->GetService()->GetAccountMonthlySpend($request);
}
response=customerbilling_service.GetAccountMonthlySpend(
	AccountId=AccountId,
	MonthYear=MonthYear)

Configuration requise

Service : CustomerBillingService.svc v13
Namespace: https://bingads.microsoft.com/Billing/v13

URL de la demande

https://clientcenter.api.bingads.microsoft.com/CustomerBilling/v13/AccountMonthlySpend/Query

Éléments de demande

L’objet GetAccountMonthlySpendRequest 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
AccountId Identificateur du compte qui contient les informations de dépense à obtenir.

Le compte doit utiliser le mode de paiement par facture ; les comptes carte de crédit ne sont pas pris en charge.

Si l’identificateur de compte appartient à un agrégateur, l’opération additionne le solde du compte pour tous les comptes de tous les clients que l’agrégateur gère. Si l’agrégateur a dix clients et que chaque client a dix comptes, l’opération retourne la somme des dépenses mensuelles des 100 comptes. Pour obtenir les dépenses mensuelles d’un seul compte d’un client que l’agrégateur gère, définissez l’élément AccountId sur l’identificateur de compte spécifié. Pour obtenir les dépenses mensuelles de tous les comptes d’un client que l’agrégateur gère, appelez cette opération pour chaque compte, puis additionnez les montants des dépenses mensuelles.
long
MonthYear Mois et année pour lesquels vous souhaitez obtenir les informations sur les dépenses mensuelles (l’opération ignore les valeurs de jour et d’heure).

Le service utilise les composants month et year correspondant au dateTime spécifié. Par exemple, 2020-05-15T00:00:00 et 2020-05 sont tous deux valides et retournent les mêmes résultats.

Si vous spécifiez le mois en cours, l’opération retourne le montant des dépenses mensuelles à ce jour. Par exemple, si la date actuelle est le 15 mai 2020 et que vous définissez MonthYear sur mai 2020, l’opération retourne le montant des dépenses du 1er mai au 15 mai inclus.

Vous ne pouvez pas spécifier un mois et une année futurs. Si vous spécifiez un mois précédent pour lequel il n’y a pas de données, l’appel retourne 0 (zéro).

Le montant des dépenses peut s’étendre sur plusieurs ordres d’insertion (E/S). Si les crédits sont supérieurs aux dépenses réelles, le montant des dépenses mensuelles retournées est une valeur négative.
dateTime

É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
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 GetAccountMonthlySpendResponse 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
Montant Montant dépensé par le compte au cours de la période spécifiée.

Le compte doit être géré par Yahoo !.

Si le compte n’est pas géré par Yahoo !, la valeur de retour est 0.
double

É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.

{
  "AccountId": "LongValueHere",
  "MonthYear": "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.

{
  "Amount": DoubleValueHere
}

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<GetAccountMonthlySpendResponse> GetAccountMonthlySpendAsync(
	long accountId,
	DateTime monthYear)
{
	var request = new GetAccountMonthlySpendRequest
	{
		AccountId = accountId,
		MonthYear = monthYear
	};

	return (await CustomerBillingService.CallAsync((s, r) => s.GetAccountMonthlySpendAsync(r), request));
}
static GetAccountMonthlySpendResponse getAccountMonthlySpend(
	java.lang.Long accountId,
	Calendar monthYear) throws RemoteException, Exception
{
	GetAccountMonthlySpendRequest request = new GetAccountMonthlySpendRequest();

	request.setAccountId(accountId);
	request.setMonthYear(monthYear);

	return CustomerBillingService.getService().getAccountMonthlySpend(request);
}
static function GetAccountMonthlySpend(
	$accountId,
	$monthYear)
{

	$GLOBALS['Proxy'] = $GLOBALS['CustomerBillingProxy'];

	$request = new GetAccountMonthlySpendRequest();

	$request->AccountId = $accountId;
	$request->MonthYear = $monthYear;

	return $GLOBALS['CustomerBillingProxy']->GetService()->GetAccountMonthlySpend($request);
}
response=customerbilling_service.GetAccountMonthlySpend(
	AccountId=AccountId,
	MonthYear=MonthYear)