การดําเนินการบริการ SearchCoupons - การเรียกเก็บเงินของลูกค้า
ค้นหาคูปองที่ตรงกับเกณฑ์ที่ระบุ
ร้องขอองค์ประกอบ
วัตถุ SearchCouponsRequest กําหนดเนื้อหาและองค์ประกอบส่วนหัวของคําขอการดําเนินการบริการ องค์ประกอบต้องอยู่ในลําดับเดียวกับที่แสดงใน Request SOAP
หมายเหตุ
เว้นแต่ระบุไว้เป็นอย่างอื่นด้านล่าง จําเป็นต้องระบุองค์ประกอบคําขอทั้งหมด
ร้องขอองค์ประกอบเนื้อความ
องค์ ประกอบ | คำอธิบาย | ชนิดข้อมูล |
---|---|---|
สั่ง ซื้อ | กําหนดลําดับของผลลัพธ์ตามคุณสมบัติที่ระบุของคูปอง คุณควรระบุองค์ประกอบ OrderBy เพียงองค์ประกอบเดียวในอาร์เรย์ องค์ประกอบเพิ่มเติมไม่ได้รับการสนับสนุนและจะถูกละเว้นโดยบริการ สําหรับการดําเนินการบริการนี้ ค่าต่อไปนี้ได้รับการสนับสนุนในองค์ประกอบ Field ของวัตถุ OrderBy ClassName - ลําดับจะถูกกําหนดโดยองค์ประกอบ ClassName ของ คูปองที่ส่งกลับ StartDate - คําสั่งซื้อจะถูกกําหนดโดยองค์ประกอบ StartDate ของ คูปองที่ส่งกลับ |
อาร์เรย์ OrderBy |
PageInfo | กําหนดดัชนีและขนาดของผลลัพธ์ต่อหน้า | เพ จจิ้ง |
เพรดิเคต | กําหนดเงื่อนไขของคําขอ การตอบสนองของการดําเนินการนี้จะรวมคูปองที่ตรงกับเพรดิเคตที่ระบุทั้งหมด คุณสามารถระบุเพรดิเคตได้สูงสุด 4 เพรดิเคต และหนึ่งในเขตข้อมูลเพรดิเคตต้องเป็น CustomerId สําหรับรายการขององค์ประกอบเขตข้อมูลและตัวดําเนินการที่สนับสนุนของวัตถุเพรดิเคตสําหรับการดําเนินการบริการนี้ ดู หมายเหตุเพรดิเคต |
เพรดิเคต อาร์เรย์ |
ReturnAdditionalFields | หากตั้งค่าเป็น "CouponClaimInfo" ให้ส่งกลับ CouponClaimInfo ในการตอบสนอง | AccountAdditionalField |
องค์ประกอบส่วนหัวของคําขอ
องค์ ประกอบ | คำอธิบาย | ชนิดข้อมูล |
---|---|---|
AuthenticationToken | โทเค็นการเข้าถึง OAuth ที่แสดงข้อมูลประจําตัวของผู้ใช้ที่มีสิทธิ์เข้าถึงบัญชี Microsoft Advertising สําหรับข้อมูลเพิ่มเติม ดูการรับรองความถูกต้องด้วย OAuth |
สาย อักขระ |
DeveloperToken | โทเค็นนักพัฒนาที่ใช้เพื่อเข้าถึง Bing Ads API สําหรับข้อมูลเพิ่มเติม ดูรับโทเค็นนักพัฒนา |
สาย อักขระ |
รหัส ผ่าน | องค์ประกอบนี้สงวนไว้สําหรับการใช้ภายในและจะถูกเอาออกจากเวอร์ชันในอนาคตของ API คุณต้องใช้องค์ประกอบ AuthenticationToken เพื่อตั้งค่าข้อมูลประจําตัวของผู้ใช้ | สาย อักขระ |
ชื่อ | องค์ประกอบนี้สงวนไว้สําหรับการใช้ภายในและจะถูกเอาออกจากเวอร์ชันในอนาคตของ API คุณต้องใช้องค์ประกอบ AuthenticationToken เพื่อตั้งค่าข้อมูลประจําตัวของผู้ใช้ | สาย อักขระ |
องค์ประกอบการตอบสนอง
วัตถุ SearchCouponsResponse จะกําหนดองค์ประกอบ เนื้อความ และ ส่วนหัว ของการตอบสนองการดําเนินการบริการ องค์ประกอบจะถูกส่งกลับตามลําดับเดียวกับที่แสดงใน Response SOAP
องค์ประกอบเนื้อความการตอบสนอง
องค์ ประกอบ | คำอธิบาย | ชนิดข้อมูล |
---|---|---|
คูปอง | รายการคูปองที่ตรงตามเกณฑ์ที่ระบุ | อาร์เรย์คูปอง |
องค์ประกอบส่วนหัวการตอบสนอง
องค์ ประกอบ | คำอธิบาย | ชนิดข้อมูล |
---|---|---|
TrackingId | ตัวระบุของรายการบันทึกที่ประกอบด้วยรายละเอียดของการเรียกใช้ API | สาย อักขระ |
ร้องขอ SOAP
เทมเพลตนี้ถูกสร้างขึ้นโดยเครื่องมือเพื่อแสดง ลําดับ ขององค์ประกอบ เนื้อความ และ ส่วนหัว สําหรับคําขอ SOAP สําหรับชนิดที่สนับสนุนที่คุณสามารถใช้กับการดําเนินการบริการนี้ โปรดดูการอ้างอิง องค์ประกอบเนื้อความคําขอ ด้านบน
<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>
Response SOAP
เทมเพลตนี้ถูกสร้างขึ้นโดยเครื่องมือเพื่อแสดงลําดับขององค์ประกอบ เนื้อ ความและ ส่วนหัว สําหรับการตอบสนอง 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>
ไวยากรณ์โค้ด
ไวยากรณ์ตัวอย่างสามารถใช้กับ Bing Ads SDKs ได้ ดู ตัวอย่างโค้ด API ของโฆษณา Bing สําหรับตัวอย่างเพิ่มเติม
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)
ข้อกําหนด
บริการ: CustomerBillingService.svc v13
Namespace: https://bingads.microsoft.com/Billing/v13