Condividi tramite

Operazione del servizio GetCouponInfo - Fatturazione del cliente

Ottiene informazioni sui coupon associati a un ID cliente.

Elementi della richiesta

L'oggetto GetCouponInfoRequest definisce il corpo e gli elementi dell'intestazione della richiesta di operazione del servizio. Gli elementi devono essere nello stesso ordine indicato nella richiesta SOAP.

Nota

Se non diversamente indicato di seguito, sono necessari tutti gli elementi della richiesta.

Elementi del corpo della richiesta

Elemento Descrizione Tipo di dati
CustomerId ID cliente. long

Elementi dell'intestazione della richiesta

Elemento Descrizione Tipo di dati
AuthenticationToken Token di accesso OAuth che rappresenta le credenziali di un utente che dispone delle autorizzazioni per gli account Microsoft Advertising.

Per altre informazioni, vedere Autenticazione con OAuth.		 corda
DeveloperToken Token di sviluppo usato per accedere all'API Bing Ads.

Per altre informazioni, vedere Ottenere un token per sviluppatori.		 corda
Password Questo elemento è riservato per l'uso interno e verrà rimosso da una versione futura dell'API. È necessario usare l'elemento AuthenticationToken per impostare le credenziali utente. corda
UserName Questo elemento è riservato per l'uso interno e verrà rimosso da una versione futura dell'API. È necessario usare l'elemento AuthenticationToken per impostare le credenziali utente. corda

Elementi di risposta

L'oggetto GetCouponInfoResponse definisce il corpo e gli elementi dell'intestazione della risposta dell'operazione del servizio. Gli elementi vengono restituiti nello stesso ordine illustrato nella soap di risposta.

Elementi del corpo della risposta

Elemento Descrizione Tipo di dati
CouponInfoData Elenco di oggetti dati di informazioni sui coupon. Matrice CouponInfoData

Elementi dell'intestazione della risposta

Elemento Descrizione Tipo di dati
TrackingId Identificatore della voce di log che contiene i dettagli della chiamata API. corda

Richiedi SOAP

Questo modello è stato generato da uno strumento per visualizzare l'ordine degli elementi corpo e intestazione per la richiesta SOAP. Per i tipi supportati che è possibile usare con questa operazione del servizio, vedere il riferimento Request Body Elements sopra riportato.

<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 della risposta

Questo modello è stato generato da uno strumento per visualizzare l'ordine degli elementi del corpo e dell'intestazione per la risposta 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>

Sintassi del codice

La sintassi di esempio può essere usata con gli SDK di Bing Ads. Per altri esempi, vedere Esempi di codice DELL'API Bing Ads .

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)

Requisiti

Servizio: CustomerBillingService.svc v13
Namespace: https://bingads.microsoft.com/Billing/v13

URL richiesta

https://clientcenter.api.bingads.microsoft.com/CustomerBilling/v13/CouponInfo/Query

Elementi della richiesta

L'oggetto GetCouponInfoRequest definisce il corpo e gli elementi dell'intestazione della richiesta di operazione del servizio.

Nota

Se non diversamente indicato di seguito, sono necessari tutti gli elementi della richiesta.

Elementi del corpo della richiesta

Elemento Descrizione Tipo di dati
CustomerId ID cliente. long

Elementi dell'intestazione della richiesta

Elemento Descrizione Tipo di dati
Autorizzazione Token di accesso OAuth che rappresenta le credenziali di un utente che dispone delle autorizzazioni per gli account Microsoft Advertising. Assicurarsi che il token sia preceduto da "Bearer", necessario per l'autenticazione corretta.

Per altre informazioni, vedere Autenticazione con OAuth.		 corda
DeveloperToken Token di sviluppo usato per accedere all'API Bing Ads.

Per altre informazioni, vedere Ottenere un token per sviluppatori.		 corda
Password Questo elemento è riservato per l'uso interno e verrà rimosso da una versione futura dell'API. È necessario usare l'elemento AuthenticationToken per impostare le credenziali utente. corda
UserName Questo elemento è riservato per l'uso interno e verrà rimosso da una versione futura dell'API. È necessario usare l'elemento AuthenticationToken per impostare le credenziali utente. corda

Elementi di risposta

L'oggetto GetCouponInfoResponse definisce il corpo e gli elementi dell'intestazione della risposta dell'operazione del servizio. Gli elementi vengono restituiti nello stesso ordine illustrato nel codice JSON della risposta.

Elementi del corpo della risposta

Elemento Descrizione Tipo di dati
CouponInfoData Elenco di oggetti dati di informazioni sui coupon. Matrice CouponInfoData

Elementi dell'intestazione della risposta

Elemento Descrizione Tipo di dati
TrackingId Identificatore della voce di log che contiene i dettagli della chiamata API. corda

Richiedere JSON

Questo modello è stato generato da uno strumento per visualizzare il corpo e gli elementi di intestazione per la richiesta JSON. Per i tipi supportati che è possibile usare con questa operazione del servizio, vedere il riferimento Request Body Elements sopra riportato.

{
  "CustomerId": "LongValueHere"
}

Risposta JSON

Questo modello è stato generato da uno strumento per mostrare il corpo e gli elementi dell'intestazione per la risposta 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
    }
  ]
}

Sintassi del codice

Per chiamare l'API REST tramite SDK, è necessario aggiornare l'SDK a una determinata versione e configurare i parametri di sistema. La sintassi di esempio può essere usata con gli SDK di Bing Ads. Per altri esempi, vedere Esempi di codice DELL'API Bing Ads .

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)