共用方式為


GetAccountMonthlySpend 服務作業 - 客戶計費

取得帳戶在指定月份所花費的金額。

要求專案

GetAccountMonthlySpendRequest 物件會定義服務作業要求的主體標頭元素。 元素的順序必須與 要求SOAP中所示的順序相同。

注意事項

除非下面另有說明,否則所有要求專案都是必要的。

要求本文專案

元素 描述 資料類型
AccountId 帳戶的標識碼,其中包含要取得的支出資訊。

帳戶必須使用發票付款方式;不支援信用卡帳戶。

如果帳戶標識碼屬於匯總工具,此作業會加總匯總工具所管理之所有客戶之所有帳戶的帳戶餘額。 如果匯總工具有十個客戶,且每位客戶都有十個帳戶,則此作業會傳回所有 100 個帳戶的每月支出總和。 若要取得匯總工具所管理之客戶的單一帳戶每月支出,請將 AccountId 元素設定為指定的帳戶標識碼。 若要取得匯總工具管理之客戶所有帳戶的每月支出,請針對每個帳戶呼叫此作業,然後加總每月支出金額。
MonthYear 您想要取得每月費用資訊的月份和年份 (作業會忽略) 的日期和時間值。

服務會使用對應至指定 dateTime 的月份和年份元件。 例如,2020-05-15T00:00:00 和 2020-05 都有效,而且會傳回相同的結果。

如果您指定目前的月份,作業會傳回當月至今的支出金額。 例如,如果目前的日期是 2020 年 5 月 15 日,而且您將 MonthYear 設定為 2020 年 5 月,則作業會傳回 5 月 1 日到 5 月 15 日的支出金額,包括在內。

您無法指定未來的月份和年份。 如果您指定沒有數據的上個月,則呼叫會傳回 0 (零) 。

花費金額可以跨越多個插入訂單 (IO) 。 如果點數大於實際支出,則傳回的每月支出金額為負值。
dateTime

要求標頭元素

元素 描述 資料類型
AuthenticationToken OAuth 存取令牌,代表有權Microsoft Advertising 帳戶之用戶的認證。

如需詳細資訊,請 參閱使用 OAuth 進行驗證
string
DeveloperToken 用來存取 Bing 廣告 API 的開發人員令牌。

如需詳細資訊 ,請參閱取得開發人員令牌
string
密碼 此元素會保留供內部使用,並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定用戶認證。 string
UserName 此元素會保留供內部使用,並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定用戶認證。 string

Response 元素

GetAccountMonthlySpendResponse 物件會定義服務作業響應的主體標頭元素。 這些元素的傳回順序與 回應SOAP中所示的順序相同。

回應本文專案

元素 描述 資料類型
金額 帳戶在指定期間內所花費的金額。

帳戶必須是 Yahoo!managed。

如果帳戶不是 Yahoo!Managed,則傳回值為 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
命名空間: https://bingads.microsoft.com/Billing/v13

要求 URL

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

要求專案

GetAccountMonthlySpendRequest 物件會定義服務作業要求的主體標頭元素。

注意事項

除非下面另有說明,否則所有要求專案都是必要的。

要求本文專案

元素 描述 資料類型
AccountId 帳戶的標識碼,其中包含要取得的支出資訊。

帳戶必須使用發票付款方式;不支援信用卡帳戶。

如果帳戶標識碼屬於匯總工具,此作業會加總匯總工具所管理之所有客戶之所有帳戶的帳戶餘額。 如果匯總工具有十個客戶,且每位客戶都有十個帳戶,則此作業會傳回所有 100 個帳戶的每月支出總和。 若要取得匯總工具所管理之客戶的單一帳戶每月支出,請將 AccountId 元素設定為指定的帳戶標識碼。 若要取得匯總工具管理之客戶所有帳戶的每月支出,請針對每個帳戶呼叫此作業,然後加總每月支出金額。
MonthYear 您想要取得每月費用資訊的月份和年份 (作業會忽略) 的日期和時間值。

服務會使用對應至指定 dateTime 的月份和年份元件。 例如,2020-05-15T00:00:00 和 2020-05 都有效,而且會傳回相同的結果。

如果您指定目前的月份,作業會傳回當月至今的支出金額。 例如,如果目前的日期是 2020 年 5 月 15 日,而且您將 MonthYear 設定為 2020 年 5 月,則作業會傳回 5 月 1 日到 5 月 15 日的支出金額,包括在內。

您無法指定未來的月份和年份。 如果您指定沒有數據的上個月,則呼叫會傳回 0 (零) 。

花費金額可以跨越多個插入訂單 (IO) 。 如果點數大於實際支出,則傳回的每月支出金額為負值。
dateTime

要求標頭元素

元素 描述 資料類型
授權 OAuth 存取令牌,代表有權Microsoft Advertising 帳戶之用戶的認證。 請確定令牌前面加上 「Bearer」 ,這是正確驗證的必要專案。

如需詳細資訊,請 參閱使用 OAuth 進行驗證
string
DeveloperToken 用來存取 Bing 廣告 API 的開發人員令牌。

如需詳細資訊 ,請參閱取得開發人員令牌
string
密碼 此元素會保留供內部使用,並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定用戶認證。 string
UserName 此元素會保留供內部使用,並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定用戶認證。 string

Response 元素

GetAccountMonthlySpendResponse 物件會定義服務作業響應的主體標頭元素。 這些元素的傳回順序與 回應 JSON 中所示的順序相同。

回應本文專案

元素 描述 資料類型
金額 帳戶在指定期間內所花費的金額。

帳戶必須是 Yahoo!managed。

如果帳戶不是 Yahoo!Managed,則傳回值為 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)