Compartir a través de

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

Obtiene información sobre los cupones asociados a un identificador de cliente.

Elementos Request

El objeto GetCouponInfoRequest 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
CustomerId El identificador de cliente. largo

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 GetCouponInfoResponse 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
CouponInfoData Lista de objetos de datos de información de cupones. CouponInfoData (matriz)

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">GetCouponInfo</Action>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
  </s:Header>
  <s:Body>
    <GetCouponInfoRequest xmlns="https://bingads.microsoft.com/Billing/v13">
      <CustomerId>ValueHere</CustomerId>
    </GetCouponInfoRequest>
  </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>
    <GetCouponInfoResponse xmlns="https://bingads.microsoft.com/Billing/v13">
      <CouponInfoData xmlns:e19="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e19:CouponInfoData>
          <e19:AccountId>ValueHere</e19:AccountId>
          <e19:CouponId d4p1:nil="false">ValueHere</e19:CouponId>
          <e19:ClaimDate d4p1:nil="false">ValueHere</e19:ClaimDate>
          <e19:Status d4p1:nil="false">ValueHere</e19:Status>
          <e19:RedemptionDate d4p1:nil="false">ValueHere</e19:RedemptionDate>
          <e19:ExpirationDate d4p1:nil="false">ValueHere</e19:ExpirationDate>
          <e19:PercentOff d4p1:nil="false">ValueHere</e19:PercentOff>
          <e19:CouponValue d4p1:nil="false">ValueHere</e19:CouponValue>
          <e19:UpfrontSpending d4p1:nil="false">ValueHere</e19:UpfrontSpending>
          <e19:ActiveDuration d4p1:nil="false">ValueHere</e19:ActiveDuration>
          <e19:SpendToThreshold d4p1:nil="false">ValueHere</e19:SpendToThreshold>
          <e19:StartDate d4p1:nil="false">ValueHere</e19:StartDate>
          <e19:EndDate d4p1:nil="false">ValueHere</e19:EndDate>
          <e19:Balance d4p1:nil="false">ValueHere</e19:Balance>
          <e19:CurrencyCode d4p1:nil="false">ValueHere</e19:CurrencyCode>
          <e19:FeatureId d4p1:nil="false">ValueHere</e19:FeatureId>
          <e19:CouponType d4p1:nil="false">ValueHere</e19:CouponType>
        </e19:CouponInfoData>
      </CouponInfoData>
    </GetCouponInfoResponse>
  </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<GetCouponInfoResponse> GetCouponInfoAsync(
	long customerId)
{
	var request = new GetCouponInfoRequest
	{
		CustomerId = customerId
	};

	return (await CustomerBillingService.CallAsync((s, r) => s.GetCouponInfoAsync(r), request));
}

static GetCouponInfoResponse getCouponInfo(
	java.lang.Long customerId) throws RemoteException, Exception
{
	GetCouponInfoRequest request = new GetCouponInfoRequest();

	request.setCustomerId(customerId);

	return CustomerBillingService.getService().getCouponInfo(request);
}

static function GetCouponInfo(
	$customerId)
{

	$GLOBALS['Proxy'] = $GLOBALS['CustomerBillingProxy'];

	$request = new GetCouponInfoRequest();

	$request->CustomerId = $customerId;

	return $GLOBALS['CustomerBillingProxy']->GetService()->GetCouponInfo($request);
}

response=customerbilling_service.GetCouponInfo(
	CustomerId=CustomerId)

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/CouponInfo/Query

Elementos Request

El objeto GetCouponInfoRequest 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
CustomerId El identificador de cliente. largo

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 GetCouponInfoResponse 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
CouponInfoData Lista de objetos de datos de información de cupones. CouponInfoData (matriz)

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.

{
  "CustomerId": "LongValueHere"
}

JSON de respuesta

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

{
  "CouponInfoData": [
    {
      "AccountId": IntValueHere,
      "ActiveDuration": IntValueHere,
      "Balance": DecimalValueHere,
      "ClaimDate": "ValueHere",
      "CouponId": IntValueHere,
      "CouponType": "ValueHere",
      "CouponValue": DecimalValueHere,
      "CurrencyCode": "ValueHere",
      "EndDate": "ValueHere",
      "ExpirationDate": "ValueHere",
      "FeatureId": IntValueHere,
      "PercentOff": DoubleValueHere,
      "RedemptionDate": "ValueHere",
      "SpendToThreshold": DecimalValueHere,
      "StartDate": "ValueHere",
      "Status": "ValueHere",
      "UpfrontSpending": DecimalValueHere
    }
  ]
}

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<GetCouponInfoResponse> GetCouponInfoAsync(
	long customerId)
{
	var request = new GetCouponInfoRequest
	{
		CustomerId = customerId
	};

	return (await CustomerBillingService.CallAsync((s, r) => s.GetCouponInfoAsync(r), request));
}

static GetCouponInfoResponse getCouponInfo(
	java.lang.Long customerId) throws RemoteException, Exception
{
	GetCouponInfoRequest request = new GetCouponInfoRequest();

	request.setCustomerId(customerId);

	return CustomerBillingService.getService().getCouponInfo(request);
}

static function GetCouponInfo(
	$customerId)
{

	$GLOBALS['Proxy'] = $GLOBALS['CustomerBillingProxy'];

	$request = new GetCouponInfoRequest();

	$request->CustomerId = $customerId;

	return $GLOBALS['CustomerBillingProxy']->GetService()->GetCouponInfo($request);
}

response=customerbilling_service.GetCouponInfo(
	CustomerId=CustomerId)