Operación del servicio DispatchCoupons: facturación del cliente
Cupones de envío del nombre de clase de cupón especificado propiedad del cliente especificado.
Los cupones ya canjeados o enviados no se enviarán.
Elementos Request
El objeto DispatchCouponsRequest 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
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 DispatchCouponsResponse 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 |
|---|---|---|
| PartialErrors | Matriz de objetos BatchError que se corresponden con las direcciones de correo electrónico a las que no se pudo enviar el código de cupón. La lista puede estar vacía si no hay errores. |
Matriz BatchError |
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">DispatchCoupons</Action>
<AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
<DeveloperToken i:nil="false">ValueHere</DeveloperToken>
</s:Header>
<s:Body>
<DispatchCouponsRequest xmlns="https://bingads.microsoft.com/Billing/v13">
<SendToEmails i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:string>ValueHere</a1:string>
</SendToEmails>
<CustomerId>ValueHere</CustomerId>
<CouponClassName i:nil="false">ValueHere</CouponClassName>
</DispatchCouponsRequest>
</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>
<DispatchCouponsResponse xmlns="https://bingads.microsoft.com/Billing/v13">
<PartialErrors xmlns:e11="https://bingads.microsoft.com/Customer/v13/Exception" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<e11:BatchError>
<e11:Code>ValueHere</e11:Code>
<e11:Details d4p1:nil="false">ValueHere</e11:Details>
<e11:Index>ValueHere</e11:Index>
<e11:Message d4p1:nil="false">ValueHere</e11:Message>
</e11:BatchError>
</PartialErrors>
</DispatchCouponsResponse>
</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<DispatchCouponsResponse> DispatchCouponsAsync(
IList<string> sendToEmails,
long customerId,
string couponClassName)
{
var request = new DispatchCouponsRequest
{
SendToEmails = sendToEmails,
CustomerId = customerId,
CouponClassName = couponClassName
};
return (await CustomerBillingService.CallAsync((s, r) => s.DispatchCouponsAsync(r), request));
}
static DispatchCouponsResponse dispatchCoupons(
ArrayOfstring sendToEmails,
java.lang.Long customerId,
java.lang.String couponClassName) throws RemoteException, Exception
{
DispatchCouponsRequest request = new DispatchCouponsRequest();
request.setSendToEmails(sendToEmails);
request.setCustomerId(customerId);
request.setCouponClassName(couponClassName);
return CustomerBillingService.getService().dispatchCoupons(request);
}
static function DispatchCoupons(
$sendToEmails,
$customerId,
$couponClassName)
{
$GLOBALS['Proxy'] = $GLOBALS['CustomerBillingProxy'];
$request = new DispatchCouponsRequest();
$request->SendToEmails = $sendToEmails;
$request->CustomerId = $customerId;
$request->CouponClassName = $couponClassName;
return $GLOBALS['CustomerBillingProxy']->GetService()->DispatchCoupons($request);
}
response=customerbilling_service.DispatchCoupons(
SendToEmails=SendToEmails,
CustomerId=CustomerId,
CouponClassName=CouponClassName)
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/Coupons/Dispatch
Elementos Request
El objeto DispatchCouponsRequest 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
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 DispatchCouponsResponse 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 |
|---|---|---|
| PartialErrors | Matriz de objetos BatchError que se corresponden con las direcciones de correo electrónico a las que no se pudo enviar el código de cupón. La lista puede estar vacía si no hay errores. |
Matriz BatchError |
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.
{
"SendToEmails": [
"ValueHere"
],
"CustomerId": "LongValueHere",
"CouponClassName": "ValueHere"
}
JSON de respuesta
Esta plantilla se generó mediante una herramienta para mostrar los elementos body y header de la respuesta JSON.
{
"PartialErrors": [
{
"Code": IntValueHere,
"Details": "ValueHere",
"Index": IntValueHere,
"Message": "ValueHere"
}
]
}
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<DispatchCouponsResponse> DispatchCouponsAsync(
IList<string> sendToEmails,
long customerId,
string couponClassName)
{
var request = new DispatchCouponsRequest
{
SendToEmails = sendToEmails,
CustomerId = customerId,
CouponClassName = couponClassName
};
return (await CustomerBillingService.CallAsync((s, r) => s.DispatchCouponsAsync(r), request));
}
static DispatchCouponsResponse dispatchCoupons(
ArrayOfstring sendToEmails,
java.lang.Long customerId,
java.lang.String couponClassName) throws RemoteException, Exception
{
DispatchCouponsRequest request = new DispatchCouponsRequest();
request.setSendToEmails(sendToEmails);
request.setCustomerId(customerId);
request.setCouponClassName(couponClassName);
return CustomerBillingService.getService().dispatchCoupons(request);
}
static function DispatchCoupons(
$sendToEmails,
$customerId,
$couponClassName)
{
$GLOBALS['Proxy'] = $GLOBALS['CustomerBillingProxy'];
$request = new DispatchCouponsRequest();
$request->SendToEmails = $sendToEmails;
$request->CustomerId = $customerId;
$request->CouponClassName = $couponClassName;
return $GLOBALS['CustomerBillingProxy']->GetService()->DispatchCoupons($request);
}
response=customerbilling_service.DispatchCoupons(
SendToEmails=SendToEmails,
CustomerId=CustomerId,
CouponClassName=CouponClassName)