GetAccountMonthlySpend 服务操作 - 客户计费

获取帐户在指定月份所花费的金额。

请求元素

GetAccountMonthlySpendRequest 对象定义服务操作请求的正文标头元素。 元素的顺序必须与 请求 SOAP 中所示的顺序相同。

注意

除非下面另有说明,否则需要所有请求元素。

请求正文元素

元素 说明 数据类型
AccountId 包含要获取的支出信息的帐户的标识符。

帐户必须使用发票付款方式;不支持信用卡帐户。

如果帐户标识符属于聚合器,则操作将计算聚合器管理的所有客户的所有帐户的帐户余额。 如果聚合器有 10 个客户,每个客户有 10 个帐户,则操作将返回所有 100 个帐户的每月支出总和。 若要获取聚合器管理的客户的单个帐户的每月支出,请将 AccountId 元素设置为指定的帐户标识符。 若要获取聚合器管理的客户所有帐户的每月支出,请为每个帐户调用此操作,然后将每月支出金额求和。
long
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广告帐户的用户的凭据。

有关详细信息,请参阅 使用 OAuth 进行身份验证
string
DeveloperToken 用于访问必应广告 API 的开发人员令牌。

有关详细信息,请参阅 获取开发人员令牌
string
Password 此元素保留供内部使用,将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。 string
UserName 此元素保留供内部使用,将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。 string

响应元素

GetAccountMonthlySpendResponse 对象定义服务操作响应的正文标头元素。 元素的返回顺序与 响应 SOAP 中所示的顺序相同。

响应正文元素

元素 说明 数据类型
Amount 帐户在指定时间段内花费的金额。

帐户必须是 Yahoo!管理的。

如果帐户不是 Yahoo!管理的,则返回值为 0。

响应标头元素

元素 说明 数据类型
跟踪 ID 包含 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>

代码语法

示例语法可用于 必应广告 SDK。 有关更多示例,请参阅 必应广告 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 包含要获取的支出信息的帐户的标识符。

帐户必须使用发票付款方式;不支持信用卡帐户。

如果帐户标识符属于聚合器,则操作将计算聚合器管理的所有客户的所有帐户的帐户余额。 如果聚合器有 10 个客户,每个客户有 10 个帐户,则操作将返回所有 100 个帐户的每月支出总和。 若要获取聚合器管理的客户的单个帐户的每月支出,请将 AccountId 元素设置为指定的帐户标识符。 若要获取聚合器管理的客户所有帐户的每月支出,请为每个帐户调用此操作,然后将每月支出金额求和。
long
MonthYear 要在操作 (获取每月支出信息的月份和年份将忽略日期和时间值) 。

该服务使用与指定的 dateTime 对应的月份和年份组件。 例如,2020-05-15T00:00:00 和 2020-05 都有效,将返回相同的结果。

如果指定当前月份,则操作将返回本月至今的支出金额。 例如,如果当前日期为 2020 年 5 月 15 日,并将 MonthYear 设置为 2020 年 5 月,则操作将返回 5 月 1 日到 5 月 15 日(含)的支出金额。

不能指定未来的月份和年份。 如果指定没有数据的上一个月,调用将返回 0 (零) 。

支出金额可以跨多个插入订单, (IO) 。 如果额度大于实际支出,则返回的每月支出金额为负值。
dateTime

请求标头元素

元素 说明 数据类型
Authorization OAuth 访问令牌,表示有权Microsoft广告帐户的用户的凭据。 请确保令牌的前缀为“持有者”,这是正确身份验证所必需的。

有关详细信息,请参阅 使用 OAuth 进行身份验证
string
DeveloperToken 用于访问必应广告 API 的开发人员令牌。

有关详细信息,请参阅 获取开发人员令牌
string
Password 此元素保留供内部使用,将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。 string
UserName 此元素保留供内部使用,将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。 string

响应元素

GetAccountMonthlySpendResponse 对象定义服务操作响应的正文标头元素。 元素的返回顺序与 响应 JSON 中所示的顺序相同。

响应正文元素

元素 说明 数据类型
Amount 帐户在指定时间段内花费的金额。

帐户必须是 Yahoo!管理的。

如果帐户不是 Yahoo!管理的,则返回值为 0。

响应标头元素

元素 说明 数据类型
跟踪 ID 包含 API 调用详细信息的日志条目的标识符。 string

请求 JSON

此模板由显示 JSON 请求的 正文标头 元素的工具生成。 有关可用于此服务操作的支持类型,请参阅上面的 请求正文元素 参考。

{
  "AccountId": "LongValueHere",
  "MonthYear": "ValueHere"
}

响应 JSON

此模板由一个工具生成,用于显示 JSON 响应的 正文标头 元素。

{
  "Amount": DoubleValueHere
}

代码语法

若要通过 SDK 调用 REST API,需要将 SDK 升级到特定版本并配置系统参数。示例语法可用于 必应广告 SDK。 有关更多示例,请参阅 必应广告 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)