Freigeben über

RedeemCoupon-Dienstvorgang – Kundenabrechnung

Löst eine Gutschein für das angegebene Konto ein.

Hinweis

Nur ein Benutzer mit Super Admin oder Standard Anmeldeinformationen und einem genehmigten Zugang zu einem Konto kann Coupons für dieses Konto einlösen. Weitere Informationen finden Sie im technischen Leitfaden zu Benutzerrollen .

Anfordern von Elementen

Das RedeemCouponRequest-Objekt definiert den Text und die Headerelemente der Dienstvorgangsanforderung. Die Elemente müssen in der gleichen Reihenfolge wie im Anforderungs-SOAP dargestellt sein.

Hinweis

Sofern unten nicht anders angegeben, sind alle Anforderungselemente erforderlich.

Anforderungstextelemente

Element Beschreibung Datentyp
AccountId Der Bezeichner des Kontos, für das die Gutschein eingelöst wird. lang
CouponCode Der Code der einzulösende Gutschein. Zeichenfolge

Anforderungsheaderelemente

Element Beschreibung Datentyp
AuthenticationToken Das OAuth-Zugriffstoken, das die Anmeldeinformationen eines Benutzers darstellt, der über Berechtigungen für Microsoft Advertising-Konten verfügt.

Weitere Informationen finden Sie unter Authentifizierung mit OAuth.		 Zeichenfolge
DeveloperToken Das Entwicklertoken, das für den Zugriff auf die Bing Ads-API verwendet wird.

Weitere Informationen finden Sie unter Abrufen eines Entwicklertokens.		 Zeichenfolge
Kennwort Dieses Element ist für die interne Verwendung reserviert und wird aus einer zukünftigen Version der API entfernt. Sie müssen das AuthenticationToken-Element verwenden, um Benutzeranmeldeinformationen festzulegen. Zeichenfolge
UserName Dieses Element ist für die interne Verwendung reserviert und wird aus einer zukünftigen Version der API entfernt. Sie müssen das AuthenticationToken-Element verwenden, um Benutzeranmeldeinformationen festzulegen. Zeichenfolge

Antwortelemente

Das RedeemCouponResponse-Objekt definiert den Text und die Headerelemente der Dienstvorgangsantwort. Die Elemente werden in der gleichen Reihenfolge zurückgegeben, in der die Antwort-SOAP gezeigt wird.

Antworttextelemente

Element Beschreibung Datentyp
RedemptionDate Das Datum und die Uhrzeit, zu dem die Gutschein eingelöst wurde. dateTime

Antwortheaderelemente

Element Beschreibung Datentyp
TrackingId Der Bezeichner des Protokolleintrags, der die Details des API-Aufrufs enthält. Zeichenfolge

SOAP anfordern

Diese Vorlage wurde von einem Tool generiert, um die Reihenfolge der Text- und Headerelemente für die SOAP-Anforderung anzuzeigen. Informationen zu unterstützten Typen, die Sie mit diesem Dienstvorgang verwenden können, finden Sie oben in der Referenz zu Anforderungstextelementen .

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

Antwort-SOAP

Diese Vorlage wurde von einem Tool generiert, um die Reihenfolge der Text- und Headerelemente für die SOAP-Antwort anzuzeigen.

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

Codesyntax

Die Beispielsyntax kann mit Bing Ads SDKs verwendet werden. Weitere Beispiele finden Sie unter Codebeispiele für die Bing Ads-API .

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)

Anforderungen

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

Anforderungs-URL

https://clientcenter.api.bingads.microsoft.com/CustomerBilling/v13/Coupon/Redeem

Anfordern von Elementen

Das RedeemCouponRequest-Objekt definiert den Text und die Headerelemente der Dienstvorgangsanforderung.

Hinweis

Sofern unten nicht anders angegeben, sind alle Anforderungselemente erforderlich.

Anforderungstextelemente

Element Beschreibung Datentyp
AccountId Der Bezeichner des Kontos, für das die Gutschein eingelöst wird. lang
CouponCode Der Code der einzulösende Gutschein. Zeichenfolge

Anforderungsheaderelemente

Element Beschreibung Datentyp
Authorization Das OAuth-Zugriffstoken, das die Anmeldeinformationen eines Benutzers darstellt, der über Berechtigungen für Microsoft Advertising-Konten verfügt. Stellen Sie sicher, dass dem Token das Präfix "Bearer" vorangestellt ist. Dies ist für die ordnungsgemäße Authentifizierung erforderlich.

Weitere Informationen finden Sie unter Authentifizierung mit OAuth.		 Zeichenfolge
DeveloperToken Das Entwicklertoken, das für den Zugriff auf die Bing Ads-API verwendet wird.

Weitere Informationen finden Sie unter Abrufen eines Entwicklertokens.		 Zeichenfolge
Kennwort Dieses Element ist für die interne Verwendung reserviert und wird aus einer zukünftigen Version der API entfernt. Sie müssen das AuthenticationToken-Element verwenden, um Benutzeranmeldeinformationen festzulegen. Zeichenfolge
UserName Dieses Element ist für die interne Verwendung reserviert und wird aus einer zukünftigen Version der API entfernt. Sie müssen das AuthenticationToken-Element verwenden, um Benutzeranmeldeinformationen festzulegen. Zeichenfolge

Antwortelemente

Das RedeemCouponResponse-Objekt definiert den Text und die Headerelemente der Dienstvorgangsantwort. Die Elemente werden in der gleichen Reihenfolge zurückgegeben wie im Antwort-JSON-Code gezeigt.

Antworttextelemente

Element Beschreibung Datentyp
RedemptionDate Das Datum und die Uhrzeit, zu dem die Gutschein eingelöst wurde. dateTime

Antwortheaderelemente

Element Beschreibung Datentyp
TrackingId Der Bezeichner des Protokolleintrags, der die Details des API-Aufrufs enthält. Zeichenfolge

JSON anfordern

Diese Vorlage wurde von einem Tool generiert, um die Text- und Headerelemente für die JSON-Anforderung anzuzeigen. Informationen zu unterstützten Typen, die Sie mit diesem Dienstvorgang verwenden können, finden Sie oben in der Referenz zu Anforderungstextelementen .

{
  "AccountId": "LongValueHere",
  "CouponCode": "ValueHere"
}

Antwort-JSON

Diese Vorlage wurde von einem Tool generiert, um die Text- und Headerelemente für die JSON-Antwort anzuzeigen.

{
  "RedemptionDate": "ValueHere"
}

Codesyntax

Um die REST-API über SDKs aufzurufen, müssen Sie das SDK auf eine bestimmte Version aktualisieren und die Systemparameter konfigurieren. Die Beispielsyntax kann mit Bing Ads SDKs verwendet werden. Weitere Beispiele finden Sie unter Codebeispiele für die Bing Ads-API .

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)