Compartilhar via


GetAccountMonthlySpend – Faturação do Cliente

Obtém o montante gasto pela conta no mês especificado.

Elementos do Pedido

O objeto GetAccountMonthlySpendRequest define os elementos do corpo e do cabeçalho do pedido de operação do serviço. Os elementos têm de estar na mesma ordem mostrada no Pedido SOAP.

Nota

Salvo indicação em contrário abaixo, todos os elementos do pedido são necessários.

Elementos do Corpo do Pedido

Elemento Descrição Tipo de Dados
AccountId O identificador da conta que contém as informações de gastos a obter.

A conta tem de utilizar o método de pagamento por fatura; as contas de cartão de crédito não são suportadas.

Se o identificador de conta pertencer a um agregador, a operação soma os saldos da conta para todas as contas de todos os clientes que o agregador gere. Se o agregador tiver dez clientes e cada cliente tiver dez contas, a operação devolve a soma dos gastos mensais de todas as 100 contas. Para obter os gastos mensais de uma única conta de um cliente que o agregador gere, defina o elemento AccountId para o identificador de conta especificado. Para obter os gastos mensais de todas as contas de um cliente que o agregador gere, chame esta operação para cada conta e, em seguida, soma os montantes de gastos mensais.
long
MonthYear O mês e o ano para os quais pretende obter as informações de gastos mensais (a operação ignora os valores de dia e hora).

O serviço utiliza os componentes de mês e ano correspondentes à dateTime especificada. Por exemplo, 2020-05-15T00:00:00 e 2020-05 são ambos válidos e devolverão os mesmos resultados.

Se especificar o mês atual, a operação devolve o montante de gastos do mês até à data. Por exemplo, se a data atual for 15 de maio de 2020 e definir MonthYear como Maio de 2020, a operação devolve o montante de gastos de 1 de maio a 15 de maio, inclusive.

Não pode especificar um mês e um ano futuros. Se especificar um mês anterior para o qual não existem dados, a chamada devolve 0 (zero).

O montante de gastos pode abranger várias encomendas de inserção (E/S). Se os créditos forem superiores aos gastos reais, o montante de gastos mensais devolvido é um valor negativo.
dateTime

Elementos do Cabeçalho do Pedido

Elemento Descrição Tipo de Dados
AuthenticationToken O token de acesso OAuth que representa as credenciais de um utilizador que tem permissões para contas do Microsoft Advertising.

Para obter mais informações, veja Authentication with OAuth (Autenticação com OAuth).
cadeia
DeveloperToken O token de programador utilizado para aceder à API de Anúncios do Bing.

Para obter mais informações, veja Obter um Token de Programador.
cadeia
Palavra-passe Este elemento está reservado para utilização interna e será removido de uma versão futura da API. Tem de utilizar o elemento AuthenticationToken para definir credenciais de utilizador. cadeia
Nome de Utilizador Este elemento está reservado para utilização interna e será removido de uma versão futura da API. Tem de utilizar o elemento AuthenticationToken para definir credenciais de utilizador. cadeia

Elementos de Resposta

O objeto GetAccountMonthlySpendResponse define os elementos do corpo e do cabeçalho da resposta da operação do serviço. Os elementos são devolvidos pela mesma ordem mostrada no SOAP de Resposta.

Elementos do Corpo da Resposta

Elemento Descrição Tipo de Dados
Montante O montante gasto pela conta no período especificado.

A conta tem de ser gerida pelo Yahoo!

Se a conta não for gerida pelo Yahoo!, o valor devolvido é 0.
duplo

Elementos do Cabeçalho de Resposta

Elemento Descrição Tipo de Dados
TrackingId O identificador da entrada de registo que contém os detalhes da chamada à API. cadeia

Pedir SOAP

Este modelo foi gerado por uma ferramenta para mostrar a ordem dos elementos do corpo e do cabeçalho do pedido SOAP. Para tipos suportados que pode utilizar com esta operação de serviço, veja a referência Request Body Elements (Elementos do Corpo do Pedido ) acima.

<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 Resposta

Este modelo foi gerado por uma ferramenta para mostrar a ordem dos elementos do corpo e do cabeçalho para a resposta 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>

Sintaxe de Código

A sintaxe de exemplo pode ser utilizada com os SDKs de Anúncios do Bing. Veja Exemplos de Código da API de Anúncios do Bing para obter mais exemplos.

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)

Requisitos

Serviço: CustomerBillingService.svc v13
Espaço de nomes: https://bingads.microsoft.com/Billing/v13