Operação SearchCoupons – Faturação do Cliente

Artigo
12/21/2023

Procura cupões que correspondam a critérios especificados.

Elementos do Pedido

O objeto SearchCouponsRequest 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
Encomenda	Determina a ordem dos resultados pela propriedade especificada de um cupão. Só deve especificar um elemento OrderBy na matriz. Os elementos adicionais não são suportados e serão ignorados pelo serviço. Para esta operação de serviço, os seguintes valores são suportados no elemento Campo de um objeto OrderBy . ClassName - A encomenda é determinada pelo elemento ClassName do Cupão devolvido. StartDate – a encomenda é determinada pelo elemento StartDate do Cupão devolvido.	Matriz OrderBy
PageInfo	Determina o índice e o tamanho dos resultados por página.	Paginação
Predicados	Determina as condições do pedido. A resposta desta operação incluirá cupões que correspondem a todos os predicados especificados. Pode especificar até 4 predicados e um dos campos predicados tem de ser CustomerId. Para obter uma lista dos elementos de Campo e Operador suportados de um objeto Predicado para esta operação de serviço, veja Predicado Observações.	Predicado de matriz
ReturnAdditionalFields	Se estiver definido como "CouponClaimInfo", devolva CouponClaimInfo na resposta.	AccountAdditionalField

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 SearchCouponsResponse 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
Cupões	Uma lista de cupões que cumprem os critérios especificados.	Matriz de cupões

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">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:e10="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
        <e10:Predicate>
          <e10:Field i:nil="false">ValueHere</e10:Field>
          <e10:Operator>ValueHere</e10:Operator>
          <e10:Value i:nil="false">ValueHere</e10:Value>
        </e10:Predicate>
      </Predicates>
      <Ordering xmlns:e11="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
        <e11:OrderBy>
          <e11:Field>ValueHere</e11:Field>
          <e11:Order>ValueHere</e11:Order>
        </e11:OrderBy>
      </Ordering>
      <PageInfo xmlns:e12="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
        <e12:Index>ValueHere</e12:Index>
        <e12:Size>ValueHere</e12:Size>
      </PageInfo>
      <ReturnAdditionalFields i:nil="false">ValueHere</ReturnAdditionalFields>
    </SearchCouponsRequest>
  </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>
    <SearchCouponsResponse xmlns="https://bingads.microsoft.com/Billing/v13">
      <Coupons xmlns:e13="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e13:Coupon>
          <e13:CouponCode d4p1:nil="false">ValueHere</e13:CouponCode>
          <e13:ClassName d4p1:nil="false">ValueHere</e13:ClassName>
          <e13:CouponType d4p1:nil="false">ValueHere</e13:CouponType>
          <e13:Amount>ValueHere</e13:Amount>
          <e13:SpendThreshold>ValueHere</e13:SpendThreshold>
          <e13:CurrencyCode d4p1:nil="false">ValueHere</e13:CurrencyCode>
          <e13:PercentOff d4p1:nil="false">ValueHere</e13:PercentOff>
          <e13:ActiveDuration d4p1:nil="false">ValueHere</e13:ActiveDuration>
          <e13:ExpirationDate d4p1:nil="false">ValueHere</e13:ExpirationDate>
          <e13:StartDate d4p1:nil="false">ValueHere</e13:StartDate>
          <e13:EndDate d4p1:nil="false">ValueHere</e13:EndDate>
          <e13:SendToEmail d4p1:nil="false">ValueHere</e13:SendToEmail>
          <e13:SendToDate d4p1:nil="false">ValueHere</e13:SendToDate>
          <e13:IsRedeemed>ValueHere</e13:IsRedeemed>
          <e13:RedemptionInfo d4p1:nil="false">
            <e13:AccountId>ValueHere</e13:AccountId>
            <e13:AccountNumber d4p1:nil="false">ValueHere</e13:AccountNumber>
            <e13:SpendToThreshold>ValueHere</e13:SpendToThreshold>
            <e13:Balance>ValueHere</e13:Balance>
            <e13:CurrencyCode d4p1:nil="false">ValueHere</e13:CurrencyCode>
            <e13:RedemptionDate>ValueHere</e13:RedemptionDate>
            <e13:ExpirationDate>ValueHere</e13:ExpirationDate>
            <e13:ActivationDate d4p1:nil="false">ValueHere</e13:ActivationDate>
          </e13:RedemptionInfo>
          <e13:ClaimInfo d4p1:nil="false">
            <e13:AccountId>ValueHere</e13:AccountId>
            <e13:AccountNumber d4p1:nil="false">ValueHere</e13:AccountNumber>
            <e13:ClaimDate>ValueHere</e13:ClaimDate>
          </e13:ClaimInfo>
        </e13:Coupon>
      </Coupons>
    </SearchCouponsResponse>
  </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<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

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

Partilhar via