Compartir a través de


Operación de servicio GetAccountMonthlySpend: facturación del cliente

Obtiene el importe invertido por la cuenta en el mes especificado.

Elementos Request

El objeto GetAccountMonthlySpendRequest define los elementos body y header de la solicitud de operación de servicio. Los elementos deben estar en el mismo orden que se muestra en la solicitud SOAP.

Nota:

A menos que se indique lo contrario a continuación, se requieren todos los elementos de solicitud.

Elementos del cuerpo de la solicitud

Elemento Descripción Tipo de datos
AccountId Identificador de la cuenta que contiene la información de gasto que se va a obtener.

La cuenta debe usar el método de pago de la factura; no se admiten cuentas de tarjeta de crédito.

Si el identificador de cuenta pertenece a un agregador, la operación suma los saldos de cuenta de todas las cuentas de todos los clientes que administra el agregador. Si el agregador tiene diez clientes y cada cliente tiene diez cuentas, la operación devuelve la suma del gasto mensual de las 100 cuentas. Para obtener el gasto mensual de una sola cuenta de un cliente que administra el agregador, establezca el elemento AccountId en el identificador de cuenta especificado. Para obtener el gasto mensual de todas las cuentas de un cliente que administra el agregador, llame a esta operación para cada cuenta y, a continuación, sume los importes de gasto mensual.
largo
MonthYear El mes y el año para los que desea obtener la información de gasto mensual (la operación omite los valores de día y hora).

El servicio usa los componentes de mes y año correspondientes a la fecha y hora especificadas. Por ejemplo, 2020-05-15T00:00:00 y 2020-05 son válidos y devolverán los mismos resultados.

Si especifica el mes actual, la operación devuelve el importe de gasto de mes a fecha. Por ejemplo, si la fecha actual es el 15 de mayo de 2020 y establece MonthYear en mayo de 2020, la operación devuelve el importe de gasto del 1 de mayo al 15 de mayo, inclusive.

No se puede especificar un mes y un año futuros. Si especifica un mes anterior para el que no hay datos, la llamada devuelve 0 (cero).

El importe de gasto puede abarcar varios pedidos de inserción (IO). Si los créditos son mayores que el gasto real, el importe de gasto mensual devuelto es un valor negativo.
dateTime

Elementos de encabezado de solicitud

Elemento Descripción Tipo de datos
AuthenticationToken Token de acceso de OAuth que representa las credenciales de un usuario que tiene permisos para cuentas de Microsoft Advertising.

Para obtener más información, consulte Autenticación con OAuth.
string
DeveloperToken Token de desarrollador que se usa para acceder a Bing Ads API.

Para obtener más información, consulte Obtención de un token de desarrollador.
string
Password Este elemento está reservado para uso interno y se quitará de una versión futura de la API. Debe usar el elemento AuthenticationToken para establecer las credenciales de usuario. string
UserName Este elemento está reservado para uso interno y se quitará de una versión futura de la API. Debe usar el elemento AuthenticationToken para establecer las credenciales de usuario. string

Elementos de respuesta

El objeto GetAccountMonthlySpendResponse define los elementos body y header de la respuesta de la operación de servicio. Los elementos se devuelven en el mismo orden que se muestra en soap de respuesta.

Elementos del cuerpo de la respuesta

Elemento Descripción Tipo de datos
Amount Importe invertido por la cuenta en el período especificado.

La cuenta debe ser administrada por Yahoo!.

Si la cuenta no está administrada por Yahoo!, el valor devuelto es 0.
doble

Elementos de encabezado de respuesta

Elemento Descripción Tipo de datos
Seguimiento del Id. Identificador de la entrada de registro que contiene los detalles de la llamada API. string

Solicitud de SOAP

Esta plantilla se generó mediante una herramienta para mostrar el orden del cuerpo y los elementos de encabezado de la solicitud SOAP. Para ver los tipos admitidos que puede usar con esta operación de servicio, consulte la referencia de elementos de cuerpo de solicitud anterior.

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

Esta plantilla se generó mediante una herramienta para mostrar el orden de los elementos body y header para la respuesta 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>

Sintaxis de código

La sintaxis de ejemplo se puede usar con los SDK de Bing Ads. Consulte Ejemplos de código de API de Bing Ads para obtener más ejemplos.

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

Servicio: CustomerBillingService.svc v13
Namespace: https://bingads.microsoft.com/Billing/v13

Dirección URL de solicitud

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

Elementos Request

El objeto GetAccountMonthlySpendRequest define los elementos body y header de la solicitud de operación de servicio.

Nota:

A menos que se indique lo contrario a continuación, se requieren todos los elementos de solicitud.

Elementos del cuerpo de la solicitud

Elemento Descripción Tipo de datos
AccountId Identificador de la cuenta que contiene la información de gasto que se va a obtener.

La cuenta debe usar el método de pago de la factura; no se admiten cuentas de tarjeta de crédito.

Si el identificador de cuenta pertenece a un agregador, la operación suma los saldos de cuenta de todas las cuentas de todos los clientes que administra el agregador. Si el agregador tiene diez clientes y cada cliente tiene diez cuentas, la operación devuelve la suma del gasto mensual de las 100 cuentas. Para obtener el gasto mensual de una sola cuenta de un cliente que administra el agregador, establezca el elemento AccountId en el identificador de cuenta especificado. Para obtener el gasto mensual de todas las cuentas de un cliente que administra el agregador, llame a esta operación para cada cuenta y, a continuación, sume los importes de gasto mensual.
largo
MonthYear El mes y el año para los que desea obtener la información de gasto mensual (la operación omite los valores de día y hora).

El servicio usa los componentes de mes y año correspondientes a la fecha y hora especificadas. Por ejemplo, 2020-05-15T00:00:00 y 2020-05 son válidos y devolverán los mismos resultados.

Si especifica el mes actual, la operación devuelve el importe de gasto de mes a fecha. Por ejemplo, si la fecha actual es el 15 de mayo de 2020 y establece MonthYear en mayo de 2020, la operación devuelve el importe de gasto del 1 de mayo al 15 de mayo, inclusive.

No se puede especificar un mes y un año futuros. Si especifica un mes anterior para el que no hay datos, la llamada devuelve 0 (cero).

El importe de gasto puede abarcar varios pedidos de inserción (IO). Si los créditos son mayores que el gasto real, el importe de gasto mensual devuelto es un valor negativo.
dateTime

Elementos de encabezado de solicitud

Elemento Descripción Tipo de datos
Autorización Token de acceso de OAuth que representa las credenciales de un usuario que tiene permisos para cuentas de Microsoft Advertising. Asegúrese de que el token tiene el prefijo "Portador", esto es necesario para la autenticación adecuada.

Para obtener más información, consulte Autenticación con OAuth.
string
DeveloperToken Token de desarrollador que se usa para acceder a Bing Ads API.

Para obtener más información, consulte Obtención de un token de desarrollador.
string
Password Este elemento está reservado para uso interno y se quitará de una versión futura de la API. Debe usar el elemento AuthenticationToken para establecer las credenciales de usuario. string
UserName Este elemento está reservado para uso interno y se quitará de una versión futura de la API. Debe usar el elemento AuthenticationToken para establecer las credenciales de usuario. string

Elementos de respuesta

El objeto GetAccountMonthlySpendResponse define los elementos body y header de la respuesta de la operación de servicio. Los elementos se devuelven en el mismo orden que se muestra en el JSON de respuesta.

Elementos del cuerpo de la respuesta

Elemento Descripción Tipo de datos
Amount Importe invertido por la cuenta en el período especificado.

La cuenta debe ser administrada por Yahoo!.

Si la cuenta no está administrada por Yahoo!, el valor devuelto es 0.
doble

Elementos de encabezado de respuesta

Elemento Descripción Tipo de datos
Seguimiento del Id. Identificador de la entrada de registro que contiene los detalles de la llamada API. string

Solicitud de JSON

Esta plantilla se generó mediante una herramienta para mostrar los elementos body y header de la solicitud JSON. Para ver los tipos admitidos que puede usar con esta operación de servicio, consulte la referencia de elementos de cuerpo de solicitud anterior.

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

JSON de respuesta

Esta plantilla se generó mediante una herramienta para mostrar los elementos body y header de la respuesta JSON.

{
  "Amount": DoubleValueHere
}

Sintaxis de código

Para llamar a la API REST a través de SDK, debe actualizar el SDK a una versión determinada y configurar los parámetros del sistema. La sintaxis de ejemplo se puede usar con los SDK de Bing Ads. Consulte Ejemplos de código de API de Bing Ads para obtener más ejemplos.

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)