SearchInsertionOrders 服务操作 - 客户计费

搜索与指定条件匹配的插入订单。

请求元素

SearchInsertionOrdersRequest 对象定义服务操作请求的正文和标头元素。 元素的顺序必须与 请求 SOAP 中所示的顺序相同。

注意

除非下面另有说明，否则需要所有请求元素。

请求正文元素

元素	说明	数据类型
订购	按帐户的指定属性确定结果的顺序。 在数组中只应指定一个 OrderBy 元素。 其他元素不受支持，服务将忽略。 对于此服务操作，OrderBy 对象的 Field 元素支持以下值。 Id - 顺序由返回的 InsertionOrder 的 Id 元素决定。 名称 - 顺序由返回的 InsertionOrder 的 Name 元素决定。	OrderBy 数组
PageInfo	确定每页结果的索引和大小。	分页
谓词	确定请求条件。 此操作的响应将包括与所有指定谓词匹配的帐户。 最多可以指定 6 个谓词，其中一个谓词字段必须是 AccountId。 可以使用 StartDate 和 EndDate 谓词字段两次来指定开始日期和结束日期范围，否则只能使用每个谓词字段一次。 有关此服务操作的谓词对象支持的 Field 和 Operator 元素的列表，请参阅 Predicate 备注。	谓词 数组
ReturnAdditionalFields	要包含在每个返回的插入顺序中的其他属性的列表。 借助其他字段值，可以使用当前版本的客户计费 API 获取最新功能。 注意：默认情况下，相应的元素将包含在将来的更新中。 此请求元素是可选的。	InsertionOrderAdditionalField

请求标头元素

元素	说明	数据类型
AuthenticationToken	OAuth 访问令牌，表示有权Microsoft广告帐户的用户的凭据。 有关详细信息，请参阅 使用 OAuth 进行身份验证。	string
DeveloperToken	用于访问必应广告 API 的开发人员令牌。 有关详细信息，请参阅 获取开发人员令牌。	string
Password	此元素保留供内部使用，将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。	string
UserName	此元素保留供内部使用，将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。	string

响应元素

SearchInsertionOrdersResponse 对象定义服务操作响应的正文和标头元素。 元素的返回顺序与 响应 SOAP 中所示的顺序相同。

响应正文元素

元素	说明	数据类型
插入Orders	符合指定条件的插入订单列表。	InsertionOrder 数组

响应标头元素

元素	说明	数据类型
跟踪 ID	包含 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>

代码语法

示例语法可用于 必应广告 SDK。 有关更多示例，请参阅 必应广告 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 谓词字段两次来指定开始日期和结束日期范围，否则只能使用每个谓词字段一次。 有关此服务操作的谓词对象支持的 Field 和 Operator 元素的列表，请参阅 Predicate 备注。	谓词 数组
ReturnAdditionalFields	要包含在每个返回的插入顺序中的其他属性的列表。 借助其他字段值，可以使用当前版本的客户计费 API 获取最新功能。 注意：默认情况下，相应的元素将包含在将来的更新中。 此请求元素是可选的。	InsertionOrderAdditionalField

请求标头元素

元素	说明	数据类型
Authorization	OAuth 访问令牌，表示有权Microsoft广告帐户的用户的凭据。 请确保令牌的前缀为“持有者”，这是正确身份验证所必需的。 有关详细信息，请参阅 使用 OAuth 进行身份验证。	string
DeveloperToken	用于访问必应广告 API 的开发人员令牌。 有关详细信息，请参阅 获取开发人员令牌。	string
Password	此元素保留供内部使用，将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。	string
UserName	此元素保留供内部使用，将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。	string

响应元素

SearchInsertionOrdersResponse 对象定义服务操作响应的正文和标头元素。 元素的返回顺序与 响应 JSON 中所示的顺序相同。

响应正文元素

元素	说明	数据类型
插入Orders	符合指定条件的插入订单列表。	InsertionOrder 数组

响应标头元素

元素	说明	数据类型
跟踪 ID	包含 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 升级到特定版本并配置系统参数。示例语法可用于 必应广告 SDK。 有关更多示例，请参阅 必应广告 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)