Freigeben über

SearchCoupons-Dienstvorgang – Kundenabrechnung

  • Artikel

Sucht innerhalb der Coupons, bei denen die angegebene customerID als ownerCustomer identifiziert wird, nach Coupons, die einem angegebenen Kriterium entsprechen. Die BesitzerBenutzerdefinierte Bezeichnung wird Coupons zum Zeitpunkt der Prägezeit zugewiesen.

Hinweis

SearchCoupons ermöglicht Es Ihnen, zu sehen, welche Coupons, die mit einem ownerCustomer verbunden sind, von welchem Konto eingelöst wurden. Es wird möglicherweise nicht jede Gutschein zurückgegeben, die Ihrem Konto zugeordnet ist.

Anfordern von Elementen

Das SearchCouponsRequest-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
Ordnung Bestimmt die Reihenfolge der Ergebnisse anhand der angegebenen Eigenschaft eines Gutschein.

Sie sollten nur ein OrderBy-Element im Array angeben. Zusätzliche Elemente werden nicht unterstützt und vom Dienst ignoriert.

Für diesen Dienstvorgang werden die folgenden Werte im Field-Element eines OrderBy-Objekts unterstützt.

CouponClassName : Die Bestellung wird durch das CouponClassName-Element des zurückgegebenen Coupons bestimmt.

CouponStartDate : Die Bestellung wird durch das CouponStartDate-Element des zurückgegebenen Coupons bestimmt.		 OrderBy-Array
PageInfo Bestimmt den Index und die Größe der Ergebnisse pro Seite. Paging
Prädikate Bestimmt die Anforderungsbedingungen. Die Antwort dieses Vorgangs enthält Coupons, die allen angegebenen Prädikaten entsprechen.

Sie können bis zu 4 Prädikate angeben, und eines der Prädikatfelder muss CustomerId sein.

Eine Liste der unterstützten Field - und Operator-Elemente eines Prädikatobjekts für diesen Dienstvorgang finden Sie unter Prädikatshinweise.		 Prädikatarray
ReturnAdditionalFields Wenn sie auf "CouponClaimInfo" festgelegt ist, geben Sie CouponClaimInfo in der Antwort zurück. AccountAdditionalField

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 SearchCouponsResponse-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
Coupons Eine Liste der Coupons, die die angegebenen Kriterien erfüllen. Couponarray

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

Anforderungen

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

Anforderungs-URL

https://clientcenter.api.bingads.microsoft.com/CustomerBilling/v13/Coupons/Search

Anfordern von Elementen

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

Hinweis

Sofern unten nicht anders angegeben, sind alle Anforderungselemente erforderlich.

Anforderungstextelemente

Element Beschreibung Datentyp
Ordnung Bestimmt die Reihenfolge der Ergebnisse anhand der angegebenen Eigenschaft eines Gutschein.

Sie sollten nur ein OrderBy-Element im Array angeben. Zusätzliche Elemente werden nicht unterstützt und vom Dienst ignoriert.

Für diesen Dienstvorgang werden die folgenden Werte im Field-Element eines OrderBy-Objekts unterstützt.

CouponClassName : Die Bestellung wird durch das CouponClassName-Element des zurückgegebenen Coupons bestimmt.

CouponStartDate : Die Bestellung wird durch das CouponStartDate-Element des zurückgegebenen Coupons bestimmt.		 OrderBy-Array
PageInfo Bestimmt den Index und die Größe der Ergebnisse pro Seite. Paging
Prädikate Bestimmt die Anforderungsbedingungen. Die Antwort dieses Vorgangs enthält Coupons, die allen angegebenen Prädikaten entsprechen.

Sie können bis zu 4 Prädikate angeben, und eines der Prädikatfelder muss CustomerId sein.

Eine Liste der unterstützten Field - und Operator-Elemente eines Prädikatobjekts für diesen Dienstvorgang finden Sie unter Prädikatshinweise.		 Prädikatarray
ReturnAdditionalFields Wenn sie auf "CouponClaimInfo" festgelegt ist, geben Sie CouponClaimInfo in der Antwort zurück. AccountAdditionalField

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 SearchCouponsResponse-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
Coupons Eine Liste der Coupons, die die angegebenen Kriterien erfüllen. Couponarray

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 .

{
  "Predicates": [
    {
      "Field": "ValueHere",
      "Operator": "ValueHere",
      "Value": "ValueHere"
    }
  ],
  "Ordering": [
    {
      "Field": "ValueHere",
      "Order": "ValueHere"
    }
  ],
  "PageInfo": {
    "Index": IntValueHere,
    "Size": IntValueHere
  },
  "ReturnAdditionalFields": "ValueHere"
}

Antwort-JSON

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

{
  "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"
    }
  ]
}

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