GetAccountMonthlySpend Service Operation - Customer Billing
Gets the amount spent by the account in the specified month.
Request Elements
The GetAccountMonthlySpendRequest object defines the body and header elements of the service operation request. The elements must be in the same order as shown in the Request SOAP.
Note
Unless otherwise noted below, all request elements are required.
Request Body Elements
Request Header Elements
| Element | Description | Data Type |
|---|---|---|
| AuthenticationToken | The OAuth access token that represents the credentials of a user who has permissions to Microsoft Advertising accounts. For more information see Authentication with OAuth. |
string |
| DeveloperToken | The developer token used to access the Bing Ads API. For more information see Get a Developer Token. |
string |
| Password | This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. | string |
| UserName | This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. | string |
Response Elements
The GetAccountMonthlySpendResponse object defines the body and header elements of the service operation response. The elements are returned in the same order as shown in the Response SOAP.
Response Body Elements
| Element | Description | Data Type |
|---|---|---|
| Amount | The amount spent by the account in the specified period. The account must be Yahoo!-managed. If the account is not Yahoo!-managed, the return value is 0. |
double |
Response Header Elements
| Element | Description | Data Type |
|---|---|---|
| TrackingId | The identifier of the log entry that contains the details of the API call. | string |
Request SOAP
This template was generated by a tool to show the order of the body and header elements for the SOAP request. For supported types that you can use with this service operation, see the Request Body Elements reference above.
<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>
Response SOAP
This template was generated by a tool to show the order of the body and header elements for the SOAP response.
<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>
Code Syntax
The example syntax can be used with Bing Ads SDKs. See Bing Ads API Code Examples for more examples.
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)
Requirements
Service: CustomerBillingService.svc v13
Namespace: https://bingads.microsoft.com/Billing/v13
Request Url
https://clientcenter.api.bingads.microsoft.com/CustomerBilling/v13/AccountMonthlySpend/Query
Request Elements
The GetAccountMonthlySpendRequest object defines the body and header elements of the service operation request.
Note
Unless otherwise noted below, all request elements are required.
Request Body Elements
Request Header Elements
| Element | Description | Data Type |
|---|---|---|
| Authorization | The OAuth access token that represents the credentials of a user who has permissions to Microsoft Advertising accounts. Please ensure that the token is prefixed with "Bearer ", this is necessary for proper authentication. For more information see Authentication with OAuth. |
string |
| DeveloperToken | The developer token used to access the Bing Ads API. For more information see Get a Developer Token. |
string |
| Password | This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. | string |
| UserName | This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. | string |
Response Elements
The GetAccountMonthlySpendResponse object defines the body and header elements of the service operation response. The elements are returned in the same order as shown in the Response JSON.
Response Body Elements
| Element | Description | Data Type |
|---|---|---|
| Amount | The amount spent by the account in the specified period. The account must be Yahoo!-managed. If the account is not Yahoo!-managed, the return value is 0. |
double |
Response Header Elements
| Element | Description | Data Type |
|---|---|---|
| TrackingId | The identifier of the log entry that contains the details of the API call. | string |
Request JSON
This template was generated by a tool to show the body and header elements for the JSON request. For supported types that you can use with this service operation, see the Request Body Elements reference above.
{
"AccountId": "LongValueHere",
"MonthYear": "ValueHere"
}
Response JSON
This template was generated by a tool to show the body and header elements for the JSON response.
{
"Amount": DoubleValueHere
}
Code Syntax
To call REST API through SDKs, you need to upgrade SDK to a certain version and configure the system parameters.The example syntax can be used with Bing Ads SDKs. See Bing Ads API Code Examples for more examples.
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)