Operación de servicio SearchCoupons: facturación del cliente
Busca cupones que coincidan con un criterio especificado.
Elementos Request
El objeto SearchCouponsRequest 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 |
|---|---|---|
| Ordenamiento | Determina el orden de los resultados por la propiedad especificada de un cupón. Solo debe especificar un elemento OrderBy en la matriz. No se admiten elementos adicionales y el servicio lo omitirá. Para esta operación de servicio, se admiten los siguientes valores en el elemento Field de un objeto OrderBy . ClassName : el orden viene determinado por el elemento ClassName del cupón devuelto. StartDate : el orden viene determinado por el elemento StartDate del cupón devuelto. |
Matriz OrderBy |
| PageInfo | Determina el índice y el tamaño de los resultados por página. | Paginación |
| Predicados | Determina las condiciones de solicitud. La respuesta de esta operación incluirá cupones que coincidan con todos los predicados especificados. Puede especificar hasta 4 predicados y uno de los campos de predicado debe ser CustomerId. Para obtener una lista de los elementos Field y Operator admitidos de un objeto Predicate para esta operación de servicio, vea Comentarios de predicado. |
Matriz de predicados |
| ReturnAdditionalFields | Si se establece en "CouponClaimInfo", devuelve CouponClaimInfo en la respuesta. | AccountAdditionalField |
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 SearchCouponsResponse 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 |
|---|---|---|
| Cupones | Lista de cupones que cumplen los criterios especificados. | Matriz de cupones |
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">SearchCoupons</Action>
<AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
<DeveloperToken i:nil="false">ValueHere</DeveloperToken>
</s:Header>
<s:Body>
<SearchCouponsRequest xmlns="https://bingads.microsoft.com/Billing/v13">
<Predicates xmlns:e19="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
<e19:Predicate>
<e19:Field i:nil="false">ValueHere</e19:Field>
<e19:Operator>ValueHere</e19:Operator>
<e19:Value i:nil="false">ValueHere</e19:Value>
</e19:Predicate>
</Predicates>
<Ordering xmlns:e20="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
<e20:OrderBy>
<e20:Field>ValueHere</e20:Field>
<e20:Order>ValueHere</e20:Order>
</e20:OrderBy>
</Ordering>
<PageInfo xmlns:e21="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
<e21:Index>ValueHere</e21:Index>
<e21:Size>ValueHere</e21:Size>
</PageInfo>
<ReturnAdditionalFields i:nil="false">ValueHere</ReturnAdditionalFields>
</SearchCouponsRequest>
</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>
<SearchCouponsResponse xmlns="https://bingads.microsoft.com/Billing/v13">
<Coupons xmlns:e22="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<e22:Coupon>
<e22:CouponCode d4p1:nil="false">ValueHere</e22:CouponCode>
<e22:ClassName d4p1:nil="false">ValueHere</e22:ClassName>
<e22:CouponType d4p1:nil="false">ValueHere</e22:CouponType>
<e22:Amount>ValueHere</e22:Amount>
<e22:SpendThreshold>ValueHere</e22:SpendThreshold>
<e22:CurrencyCode d4p1:nil="false">ValueHere</e22:CurrencyCode>
<e22:PercentOff d4p1:nil="false">ValueHere</e22:PercentOff>
<e22:ActiveDuration d4p1:nil="false">ValueHere</e22:ActiveDuration>
<e22:ExpirationDate d4p1:nil="false">ValueHere</e22:ExpirationDate>
<e22:StartDate d4p1:nil="false">ValueHere</e22:StartDate>
<e22:EndDate d4p1:nil="false">ValueHere</e22:EndDate>
<e22:SendToEmail d4p1:nil="false">ValueHere</e22:SendToEmail>
<e22:SendToDate d4p1:nil="false">ValueHere</e22:SendToDate>
<e22:IsRedeemed>ValueHere</e22:IsRedeemed>
<e22:RedemptionInfo d4p1:nil="false">
<e22:AccountId>ValueHere</e22:AccountId>
<e22:AccountNumber d4p1:nil="false">ValueHere</e22:AccountNumber>
<e22:SpendToThreshold>ValueHere</e22:SpendToThreshold>
<e22:Balance>ValueHere</e22:Balance>
<e22:CurrencyCode d4p1:nil="false">ValueHere</e22:CurrencyCode>
<e22:RedemptionDate>ValueHere</e22:RedemptionDate>
<e22:ExpirationDate>ValueHere</e22:ExpirationDate>
<e22:ActivationDate d4p1:nil="false">ValueHere</e22:ActivationDate>
</e22:RedemptionInfo>
<e22:ClaimInfo d4p1:nil="false">
<e22:AccountId>ValueHere</e22:AccountId>
<e22:AccountNumber d4p1:nil="false">ValueHere</e22:AccountNumber>
<e22:ClaimDate>ValueHere</e22:ClaimDate>
</e22:ClaimInfo>
</e22:Coupon>
</Coupons>
</SearchCouponsResponse>
</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<SearchCouponsResponse> SearchCouponsAsync(
IList<Predicate> predicates,
IList<OrderBy> ordering,
Paging pageInfo,
AccountAdditionalField? returnAdditionalFields)
{
var request = new SearchCouponsRequest
{
Predicates = predicates,
Ordering = ordering,
PageInfo = pageInfo,
ReturnAdditionalFields = returnAdditionalFields
};
return (await CustomerBillingService.CallAsync((s, r) => s.SearchCouponsAsync(r), request));
}
static SearchCouponsResponse searchCoupons(
ArrayOfPredicate predicates,
ArrayOfOrderBy ordering,
Paging pageInfo,
ArrayList<AccountAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
SearchCouponsRequest request = new SearchCouponsRequest();
request.setPredicates(predicates);
request.setOrdering(ordering);
request.setPageInfo(pageInfo);
request.setReturnAdditionalFields(returnAdditionalFields);
return CustomerBillingService.getService().searchCoupons(request);
}
static function SearchCoupons(
$predicates,
$ordering,
$pageInfo,
$returnAdditionalFields)
{
$GLOBALS['Proxy'] = $GLOBALS['CustomerBillingProxy'];
$request = new SearchCouponsRequest();
$request->Predicates = $predicates;
$request->Ordering = $ordering;
$request->PageInfo = $pageInfo;
$request->ReturnAdditionalFields = $returnAdditionalFields;
return $GLOBALS['CustomerBillingProxy']->GetService()->SearchCoupons($request);
}
response=customerbilling_service.SearchCoupons(
Predicates=Predicates,
Ordering=Ordering,
PageInfo=PageInfo,
ReturnAdditionalFields=ReturnAdditionalFields)
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/Search
Elementos Request
El objeto SearchCouponsRequest 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 |
|---|---|---|
| Ordenamiento | Determina el orden de los resultados por la propiedad especificada de un cupón. Solo debe especificar un elemento OrderBy en la matriz. No se admiten elementos adicionales y el servicio lo omitirá. Para esta operación de servicio, se admiten los siguientes valores en el elemento Field de un objeto OrderBy . ClassName : el orden viene determinado por el elemento ClassName del cupón devuelto. StartDate : el orden viene determinado por el elemento StartDate del cupón devuelto. |
Matriz OrderBy |
| PageInfo | Determina el índice y el tamaño de los resultados por página. | Paginación |
| Predicados | Determina las condiciones de solicitud. La respuesta de esta operación incluirá cupones que coincidan con todos los predicados especificados. Puede especificar hasta 4 predicados y uno de los campos de predicado debe ser CustomerId. Para obtener una lista de los elementos Field y Operator admitidos de un objeto Predicate para esta operación de servicio, vea Comentarios de predicado. |
Matriz de predicados |
| ReturnAdditionalFields | Si se establece en "CouponClaimInfo", devuelve CouponClaimInfo en la respuesta. | AccountAdditionalField |
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 SearchCouponsResponse 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 |
|---|---|---|
| Cupones | Lista de cupones que cumplen los criterios especificados. | Matriz de cupones |
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.
{
"Predicates": [
{
"Field": "ValueHere",
"Operator": "ValueHere",
"Value": "ValueHere"
}
],
"Ordering": [
{
"Field": "ValueHere",
"Order": "ValueHere"
}
],
"PageInfo": {
"Index": IntValueHere,
"Size": IntValueHere
},
"ReturnAdditionalFields": "ValueHere"
}
JSON de respuesta
Esta plantilla se generó mediante una herramienta para mostrar los elementos body y header de la respuesta JSON.
{
"Coupons": [
{
"ActiveDuration": IntValueHere,
"Amount": DoubleValueHere,
"ClaimInfo": {
"AccountId": "LongValueHere",
"AccountNumber": "ValueHere",
"ClaimDate": "ValueHere"
},
"ClassName": "ValueHere",
"CouponCode": "ValueHere",
"CouponType": "ValueHere",
"CurrencyCode": "ValueHere",
"EndDate": "ValueHere",
"ExpirationDate": "ValueHere",
"IsRedeemed": "ValueHere",
"PercentOff": DoubleValueHere,
"RedemptionInfo": {
"AccountId": "LongValueHere",
"AccountNumber": "ValueHere",
"ActivationDate": "ValueHere",
"Balance": DoubleValueHere,
"CurrencyCode": "ValueHere",
"ExpirationDate": "ValueHere",
"RedemptionDate": "ValueHere",
"SpendToThreshold": DoubleValueHere
},
"SendToDate": "ValueHere",
"SendToEmail": "ValueHere",
"SpendThreshold": DoubleValueHere,
"StartDate": "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<SearchCouponsResponse> SearchCouponsAsync(
IList<Predicate> predicates,
IList<OrderBy> ordering,
Paging pageInfo,
AccountAdditionalField? returnAdditionalFields)
{
var request = new SearchCouponsRequest
{
Predicates = predicates,
Ordering = ordering,
PageInfo = pageInfo,
ReturnAdditionalFields = returnAdditionalFields
};
return (await CustomerBillingService.CallAsync((s, r) => s.SearchCouponsAsync(r), request));
}
static SearchCouponsResponse searchCoupons(
ArrayOfPredicate predicates,
ArrayOfOrderBy ordering,
Paging pageInfo,
ArrayList<AccountAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
SearchCouponsRequest request = new SearchCouponsRequest();
request.setPredicates(predicates);
request.setOrdering(ordering);
request.setPageInfo(pageInfo);
request.setReturnAdditionalFields(returnAdditionalFields);
return CustomerBillingService.getService().searchCoupons(request);
}
static function SearchCoupons(
$predicates,
$ordering,
$pageInfo,
$returnAdditionalFields)
{
$GLOBALS['Proxy'] = $GLOBALS['CustomerBillingProxy'];
$request = new SearchCouponsRequest();
$request->Predicates = $predicates;
$request->Ordering = $ordering;
$request->PageInfo = $pageInfo;
$request->ReturnAdditionalFields = $returnAdditionalFields;
return $GLOBALS['CustomerBillingProxy']->GetService()->SearchCoupons($request);
}
response=customerbilling_service.SearchCoupons(
Predicates=Predicates,
Ordering=Ordering,
PageInfo=PageInfo,
ReturnAdditionalFields=ReturnAdditionalFields)