SearchInsertionOrders 服務作業 - 客戶計費

搜尋符合指定準則的插入順序。

要求專案

SearchInsertionOrdersRequest 物件會定義服務作業要求的主體和標頭元素。 元素的順序必須與 要求SOAP中所示的順序相同。

注意事項

除非下面另有說明，否則所有要求專案都是必要的。

要求本文專案

元素	描述	資料類型
訂購	根據帳戶的指定屬性來決定結果的順序。 您應該只在陣列中指定一個 OrderBy 元素。 不支援其他項目，服務將會忽略這些專案。 針對此服務作業，OrderBy 物件的 Field 元素支援下列值。 Id - 順序取決於傳回之 InsertionOrder 的 Id 元素。 名稱 - 順序取決於傳回之 InsertionOrder 的 Name 元素。	OrderBy 陣 列
PageInfo	決定每頁結果的索引和大小。	分頁
謂詞	決定要求條件。 此作業的回應將包含符合所有指定述詞的帳戶。 您最多可以指定 6 個述詞，其中一個述詞字段必須是 AccountId。 您可以使用 StartDate 和 EndDate 述詞欄位兩次來指定開始和結束日期範圍，否則只能使用每個述詞欄位一次。 如需此服務作業之 Predicate 物件支援的 Field 和 Operator 元素清單，請參閱述詞備註。	述詞陣 語
ReturnAdditionalFields	您要包含在每個傳回插入順序中的其他屬性清單。 其他域值可讓您使用目前版本的客戶帳單 API 取得最新功能。 注意：對應的元素預設會包含在未來的更新中。 此要求項目是選擇性的。	InsertionOrderAdditionalField

要求標頭元素

元素	描述	資料類型
AuthenticationToken	OAuth 存取令牌，代表有權Microsoft Advertising 帳戶之用戶的認證。 如需詳細資訊，請 參閱使用 OAuth 進行驗證。	string
DeveloperToken	用來存取 Bing 廣告 API 的開發人員令牌。 如需詳細資訊 ，請參閱取得開發人員令牌。	string
密碼	此元素會保留供內部使用，並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定用戶認證。	string
UserName	此元素會保留供內部使用，並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定用戶認證。	string

Response 元素

SearchInsertionOrdersResponse 物件會定義服務作業響應的主體和標頭元素。 這些元素的傳回順序與 回應SOAP中所示的順序相同。

回應本文專案

元素	描述	資料類型
InsertionOrders	符合指定準則的插入順序列表。	InsertionOrder 陣 列

回應標頭元素

元素	描述	資料類型
TrackingId	包含 API 呼叫詳細數據的記錄項目識別碼。	string

要求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">SearchInsertionOrders</Action>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
  </s:Header>
  <s:Body>
    <SearchInsertionOrdersRequest xmlns="https://bingads.microsoft.com/Billing/v13">
      <Predicates xmlns:e173="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
        <e173:Predicate>
          <e173:Field i:nil="false">ValueHere</e173:Field>
          <e173:Operator>ValueHere</e173:Operator>
          <e173:Value i:nil="false">ValueHere</e173:Value>
        </e173:Predicate>
      </Predicates>
      <Ordering xmlns:e174="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
        <e174:OrderBy>
          <e174:Field>ValueHere</e174:Field>
          <e174:Order>ValueHere</e174:Order>
        </e174:OrderBy>
      </Ordering>
      <PageInfo xmlns:e175="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
        <e175:Index>ValueHere</e175:Index>
        <e175:Size>ValueHere</e175:Size>
      </PageInfo>
      <ReturnAdditionalFields i:nil="false">ValueHere</ReturnAdditionalFields>
    </SearchInsertionOrdersRequest>
  </s:Body>
</s:Envelope>

回應 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>
    <SearchInsertionOrdersResponse xmlns="https://bingads.microsoft.com/Billing/v13">
      <InsertionOrders xmlns:e176="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e176:InsertionOrder>
          <e176:AccountId>ValueHere</e176:AccountId>
          <e176:BookingCountryCode d4p1:nil="false">ValueHere</e176:BookingCountryCode>
          <e176:Comment d4p1:nil="false">ValueHere</e176:Comment>
          <e176:EndDate d4p1:nil="false">ValueHere</e176:EndDate>
          <e176:Id d4p1:nil="false">ValueHere</e176:Id>
          <e176:LastModifiedByUserId d4p1:nil="false">ValueHere</e176:LastModifiedByUserId>
          <e176:LastModifiedTime d4p1:nil="false">ValueHere</e176:LastModifiedTime>
          <e176:NotificationThreshold d4p1:nil="false">ValueHere</e176:NotificationThreshold>
          <e176:ReferenceId d4p1:nil="false">ValueHere</e176:ReferenceId>
          <e176:SpendCapAmount d4p1:nil="false">ValueHere</e176:SpendCapAmount>
          <e176:StartDate d4p1:nil="false">ValueHere</e176:StartDate>
          <e176:Name d4p1:nil="false">ValueHere</e176:Name>
          <e176:Status d4p1:nil="false">ValueHere</e176:Status>
          <e176:PurchaseOrder d4p1:nil="false">ValueHere</e176:PurchaseOrder>
          <e176:PendingChanges d4p1:nil="false">
            <e176:Comment d4p1:nil="false">ValueHere</e176:Comment>
            <e176:EndDate d4p1:nil="false">ValueHere</e176:EndDate>
            <e176:RequestedByUserId d4p1:nil="false">ValueHere</e176:RequestedByUserId>
            <e176:ModifiedDateTime d4p1:nil="false">ValueHere</e176:ModifiedDateTime>
            <e176:NotificationThreshold d4p1:nil="false">ValueHere</e176:NotificationThreshold>
            <e176:ReferenceId d4p1:nil="false">ValueHere</e176:ReferenceId>
            <e176:SpendCapAmount d4p1:nil="false">ValueHere</e176:SpendCapAmount>
            <e176:StartDate d4p1:nil="false">ValueHere</e176:StartDate>
            <e176:Name d4p1:nil="false">ValueHere</e176:Name>
            <e176:PurchaseOrder d4p1:nil="false">ValueHere</e176:PurchaseOrder>
            <e176:ChangeStatus d4p1:nil="false">ValueHere</e176:ChangeStatus>
          </e176:PendingChanges>
          <e176:AccountNumber d4p1:nil="false">ValueHere</e176:AccountNumber>
          <e176:BudgetRemaining d4p1:nil="false">ValueHere</e176:BudgetRemaining>
          <e176:BudgetSpent d4p1:nil="false">ValueHere</e176:BudgetSpent>
          <e176:BudgetRemainingPercent d4p1:nil="false">ValueHere</e176:BudgetRemainingPercent>
          <e176:BudgetSpentPercent d4p1:nil="false">ValueHere</e176:BudgetSpentPercent>
          <e176:SeriesName d4p1:nil="false">ValueHere</e176:SeriesName>
          <e176:IsInSeries d4p1:nil="false">ValueHere</e176:IsInSeries>
          <e176:SeriesFrequencyType d4p1:nil="false">ValueHere</e176:SeriesFrequencyType>
          <e176:IsUnlimited d4p1:nil="false">ValueHere</e176:IsUnlimited>
          <e176:IsEndless d4p1:nil="false">ValueHere</e176:IsEndless>
        </e176:InsertionOrder>
      </InsertionOrders>
    </SearchInsertionOrdersResponse>
  </s:Body>
</s:Envelope>

程序代碼語法

範例語法可以與 Bing 廣告 SDK 搭配使用。 如需更多範例，請參閱 Bing 廣告 API 程式代碼範 例。

public async Task<SearchInsertionOrdersResponse> SearchInsertionOrdersAsync(
	IList<Predicate> predicates,
	IList<OrderBy> ordering,
	Paging pageInfo,
	InsertionOrderAdditionalField? returnAdditionalFields)
{
	var request = new SearchInsertionOrdersRequest
	{
		Predicates = predicates,
		Ordering = ordering,
		PageInfo = pageInfo,
		ReturnAdditionalFields = returnAdditionalFields
	};

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

static SearchInsertionOrdersResponse searchInsertionOrders(
	ArrayOfPredicate predicates,
	ArrayOfOrderBy ordering,
	Paging pageInfo,
	ArrayList<InsertionOrderAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
	SearchInsertionOrdersRequest request = new SearchInsertionOrdersRequest();

	request.setPredicates(predicates);
	request.setOrdering(ordering);
	request.setPageInfo(pageInfo);
	request.setReturnAdditionalFields(returnAdditionalFields);

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

static function SearchInsertionOrders(
	$predicates,
	$ordering,
	$pageInfo,
	$returnAdditionalFields)
{

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

	$request = new SearchInsertionOrdersRequest();

	$request->Predicates = $predicates;
	$request->Ordering = $ordering;
	$request->PageInfo = $pageInfo;
	$request->ReturnAdditionalFields = $returnAdditionalFields;

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

response=customerbilling_service.SearchInsertionOrders(
	Predicates=Predicates,
	Ordering=Ordering,
	PageInfo=PageInfo,
	ReturnAdditionalFields=ReturnAdditionalFields)

需求

服務： CustomerBillingService.svc v13
命名空間： https://bingads.microsoft.com/Billing/v13

要求 URL

生產URL

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

沙箱 URL

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

要求專案

SearchInsertionOrdersRequest 物件會定義服務作業要求的主體和標頭元素。

注意事項

除非下面另有說明，否則所有要求專案都是必要的。

要求本文專案

元素	描述	資料類型
訂購	根據帳戶的指定屬性來決定結果的順序。 您應該只在陣列中指定一個 OrderBy 元素。 不支援其他項目，服務將會忽略這些專案。 針對此服務作業，OrderBy 物件的 Field 元素支援下列值。 Id - 順序取決於傳回之 InsertionOrder 的 Id 元素。 名稱 - 順序取決於傳回之 InsertionOrder 的 Name 元素。	OrderBy 陣 列
PageInfo	決定每頁結果的索引和大小。	分頁
謂詞	決定要求條件。 此作業的回應將包含符合所有指定述詞的帳戶。 您最多可以指定 6 個述詞，其中一個述詞字段必須是 AccountId。 您可以使用 StartDate 和 EndDate 述詞欄位兩次來指定開始和結束日期範圍，否則只能使用每個述詞欄位一次。 如需此服務作業之 Predicate 物件支援的 Field 和 Operator 元素清單，請參閱述詞備註。	述詞陣 語
ReturnAdditionalFields	您要包含在每個傳回插入順序中的其他屬性清單。 其他域值可讓您使用目前版本的客戶帳單 API 取得最新功能。 注意：對應的元素預設會包含在未來的更新中。 此要求項目是選擇性的。	InsertionOrderAdditionalField

要求標頭元素

元素	描述	資料類型
授權	OAuth 存取令牌，代表有權Microsoft Advertising 帳戶之用戶的認證。 請確定令牌前面加上 「Bearer」 ，這是正確驗證的必要專案。 如需詳細資訊，請 參閱使用 OAuth 進行驗證。	string
DeveloperToken	用來存取 Bing 廣告 API 的開發人員令牌。 如需詳細資訊 ，請參閱取得開發人員令牌。	string
密碼	此元素會保留供內部使用，並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定用戶認證。	string
UserName	此元素會保留供內部使用，並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定用戶認證。	string

Response 元素

SearchInsertionOrdersResponse 物件會定義服務作業響應的主體和標頭元素。 這些元素的傳回順序與 回應 JSON 中所示的順序相同。

回應本文專案

元素	描述	資料類型
InsertionOrders	符合指定準則的插入順序列表。	InsertionOrder 陣 列

回應標頭元素

元素	描述	資料類型
TrackingId	包含 API 呼叫詳細數據的記錄項目識別碼。	string

要求 JSON

此範本是由工具所產生，用來顯示 JSON 要求的 主體 和 標頭 元素。 如需可搭配此服務作業使用的支援類型，請參閱上述 的要求本文項目 參考。

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

回應 JSON

此範本是由工具所產生，用來顯示 JSON 回應的 主體 和 標頭 元素。

{
  "InsertionOrders": [
    {
      "AccountId": "LongValueHere",
      "AccountNumber": "ValueHere",
      "BookingCountryCode": "ValueHere",
      "BudgetRemaining": DoubleValueHere,
      "BudgetRemainingPercent": DoubleValueHere,
      "BudgetSpent": DoubleValueHere,
      "BudgetSpentPercent": DoubleValueHere,
      "Comment": "ValueHere",
      "EndDate": "ValueHere",
      "Id": "LongValueHere",
      "IsEndless": "ValueHere",
      "IsInSeries": "ValueHere",
      "IsUnlimited": "ValueHere",
      "LastModifiedByUserId": "LongValueHere",
      "LastModifiedTime": "ValueHere",
      "Name": "ValueHere",
      "NotificationThreshold": DoubleValueHere,
      "PendingChanges": {
        "ChangeStatus": "ValueHere",
        "Comment": "ValueHere",
        "EndDate": "ValueHere",
        "ModifiedDateTime": "ValueHere",
        "Name": "ValueHere",
        "NotificationThreshold": DoubleValueHere,
        "PurchaseOrder": "ValueHere",
        "ReferenceId": "LongValueHere",
        "RequestedByUserId": IntValueHere,
        "SpendCapAmount": DoubleValueHere,
        "StartDate": "ValueHere"
      },
      "PurchaseOrder": "ValueHere",
      "ReferenceId": "LongValueHere",
      "SeriesFrequencyType": "ValueHere",
      "SeriesName": "ValueHere",
      "SpendCapAmount": DoubleValueHere,
      "StartDate": "ValueHere",
      "Status": "ValueHere"
    }
  ]
}

程序代碼語法

若要透過 SDK 呼叫 REST API，您必須將 SDK 升級至特定版本並設定系統參數。範例語法可以與 Bing 廣告 SDK 搭配使用。 如需更多範例，請參閱 Bing 廣告 API 程式代碼範 例。

public async Task<SearchInsertionOrdersResponse> SearchInsertionOrdersAsync(
	IList<Predicate> predicates,
	IList<OrderBy> ordering,
	Paging pageInfo,
	InsertionOrderAdditionalField? returnAdditionalFields)
{
	var request = new SearchInsertionOrdersRequest
	{
		Predicates = predicates,
		Ordering = ordering,
		PageInfo = pageInfo,
		ReturnAdditionalFields = returnAdditionalFields
	};

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

static SearchInsertionOrdersResponse searchInsertionOrders(
	ArrayOfPredicate predicates,
	ArrayOfOrderBy ordering,
	Paging pageInfo,
	ArrayList<InsertionOrderAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
	SearchInsertionOrdersRequest request = new SearchInsertionOrdersRequest();

	request.setPredicates(predicates);
	request.setOrdering(ordering);
	request.setPageInfo(pageInfo);
	request.setReturnAdditionalFields(returnAdditionalFields);

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

static function SearchInsertionOrders(
	$predicates,
	$ordering,
	$pageInfo,
	$returnAdditionalFields)
{

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

	$request = new SearchInsertionOrdersRequest();

	$request->Predicates = $predicates;
	$request->Ordering = $ordering;
	$request->PageInfo = $pageInfo;
	$request->ReturnAdditionalFields = $returnAdditionalFields;

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

response=customerbilling_service.SearchInsertionOrders(
	Predicates=Predicates,
	Ordering=Ordering,
	PageInfo=PageInfo,
	ReturnAdditionalFields=ReturnAdditionalFields)