RedeemCoupon Service Operation – Faturação do Cliente

Artigo
12/21/2023

Resgata um cupão para a conta especificada.

Nota

Apenas um utilizador da fatura da conta para o cliente com credenciais Super Administração ou Standard pode resgatar cupões. Para obter mais informações, veja o Guia técnico das Funções de Utilizador .

Elementos do Pedido

O objeto RedeemCouponRequest 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
AccountId	O identificador da conta para a qual o cupão é resgatado.	long
CouponCode	O código do cupão a resgatar.	cadeia

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 RedeemCouponResponse 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
RedemptionDate	A data e hora em que o cupão foi resgatado.	dateTime

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">RedeemCoupon</Action>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
  </s:Header>
  <s:Body>
    <RedeemCouponRequest xmlns="https://bingads.microsoft.com/Billing/v13">
      <AccountId>ValueHere</AccountId>
      <CouponCode i:nil="false">ValueHere</CouponCode>
    </RedeemCouponRequest>
  </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>
    <RedeemCouponResponse xmlns="https://bingads.microsoft.com/Billing/v13">
      <RedemptionDate>ValueHere</RedemptionDate>
    </RedeemCouponResponse>
  </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<RedeemCouponResponse> RedeemCouponAsync(
	long accountId,
	string couponCode)
{
	var request = new RedeemCouponRequest
	{
		AccountId = accountId,
		CouponCode = couponCode
	};

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

static RedeemCouponResponse redeemCoupon(
	java.lang.Long accountId,
	java.lang.String couponCode) throws RemoteException, Exception
{
	RedeemCouponRequest request = new RedeemCouponRequest();

	request.setAccountId(accountId);
	request.setCouponCode(couponCode);

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

static function RedeemCoupon(
	$accountId,
	$couponCode)
{

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

	$request = new RedeemCouponRequest();

	$request->AccountId = $accountId;
	$request->CouponCode = $couponCode;

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

response=customerbilling_service.RedeemCoupon(
	AccountId=AccountId,
	CouponCode=CouponCode)

Requisitos

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

Partilhar via