GetAccountMonthlySpend サービス操作 - 顧客の課金
指定した月にアカウントによって費やされた金額を取得します。
Request 要素
GetAccountMonthlySpendRequest オブジェクトは、サービス操作要求の本文とヘッダー要素を定義します。 要素は、 要求 SOAP に示されている順序と同じ順序である必要があります。
注:
以下に特に記載がない限り、すべての要求要素が必要です。
要求本文要素
要求ヘッダー要素
| 要素 | 説明 | データ型 |
|---|---|---|
| AuthenticationToken | Microsoft Advertising アカウントへのアクセス許可を持つユーザーの資格情報を表す OAuth アクセス トークン。 詳細については、「 OAuth による認証」を参照してください。 |
string |
| DeveloperToken | Bing Ads API へのアクセスに使用される開発者トークン。 詳細については、「 開発者トークンを取得する」を参照してください。 |
string |
| Password | この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。 ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。 | string |
| UserName | この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。 ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。 | string |
Response 要素
GetAccountMonthlySpendResponse オブジェクトは、サービス操作応答の本文とヘッダー要素を定義します。 要素は、 応答 SOAP に示されている順序と同じ順序で返されます。
応答本文の要素
| 要素 | 説明 | データ型 |
|---|---|---|
| Amount | 指定した期間内にアカウントによって費やされた金額。 アカウントは Yahoo!マネージドである必要があります。 アカウントが Yahoo!マネージドでない場合、戻り値は 0 です。 |
複 |
応答ヘッダー要素
| 要素 | 説明 | データ型 |
|---|---|---|
| TrackingId | API 呼び出しの詳細を含むログ エントリの識別子。 | string |
SOAP を要求する
このテンプレートは、SOAP 要求の本文要素とヘッダー要素の順序を示すツールによって生成されました。 このサービス操作で使用できるサポートされる型については、上記の 要求本文要素 のリファレンスを参照してください。
<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
このテンプレートは、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>
コード構文
構文の例は、 Bing広告 SDK で使用できます。 その他 の例については、「Bing広告 API コードの例 」を参照してください。
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)
要件
サービス: CustomerBillingService.svc v13
Namespace: https://bingads.microsoft.com/Billing/v13
要求 URL
https://clientcenter.api.bingads.microsoft.com/CustomerBilling/v13/AccountMonthlySpend/Query
Request 要素
GetAccountMonthlySpendRequest オブジェクトは、サービス操作要求の本文とヘッダー要素を定義します。
注:
以下に特に記載がない限り、すべての要求要素が必要です。
要求本文要素
要求ヘッダー要素
| 要素 | 説明 | データ型 |
|---|---|---|
| Authorization | Microsoft Advertising アカウントへのアクセス許可を持つユーザーの資格情報を表す OAuth アクセス トークン。 トークンのプレフィックスに "Bearer" があることを確認してください。これは、適切な認証に必要です。 詳細については、「 OAuth による認証」を参照してください。 |
string |
| DeveloperToken | Bing Ads API へのアクセスに使用される開発者トークン。 詳細については、「 開発者トークンを取得する」を参照してください。 |
string |
| Password | この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。 ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。 | string |
| UserName | この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。 ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。 | string |
Response 要素
GetAccountMonthlySpendResponse オブジェクトは、サービス操作応答の本文とヘッダー要素を定義します。 要素は、 Response JSON に示されている順序と同じ順序で返されます。
応答本文の要素
| 要素 | 説明 | データ型 |
|---|---|---|
| Amount | 指定した期間内にアカウントによって費やされた金額。 アカウントは Yahoo!マネージドである必要があります。 アカウントが Yahoo!マネージドでない場合、戻り値は 0 です。 |
複 |
応答ヘッダー要素
| 要素 | 説明 | データ型 |
|---|---|---|
| TrackingId | API 呼び出しの詳細を含むログ エントリの識別子。 | string |
JSON を要求する
このテンプレートは、JSON 要求の 本文 と ヘッダー 要素を表示するツールによって生成されました。 このサービス操作で使用できるサポートされる型については、上記の 要求本文要素 のリファレンスを参照してください。
{
"AccountId": "LongValueHere",
"MonthYear": "ValueHere"
}
応答 JSON
このテンプレートは、JSON 応答の 本文 と ヘッダー 要素を表示するツールによって生成されました。
{
"Amount": DoubleValueHere
}
コード構文
SDK を使用して REST API を呼び出すには、SDK を特定のバージョンにアップグレードし、システム パラメーターを構成する必要があります。構文の例は、 Bing広告 SDK で使用できます。 その他 の例については、「Bing広告 API コードの例 」を参照してください。
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)