次の方法で共有

SearchInsertionOrders サービス操作 - 顧客の課金

  • [アーティクル]

指定した条件に一致する挿入順序を検索します。

Request 要素

SearchInsertionOrdersRequest オブジェクトは、サービス操作要求の本文要素とヘッダー要素を定義します。 要素は、 要求 SOAP に示されている順序と同じ順序である必要があります。

注:

以下に特に記載がない限り、すべての要求要素が必要です。

要求本文要素

要素 説明 データ型
順序 アカウントの指定したプロパティによって結果の順序を決定します。

配列では 、OrderBy 要素を 1 つだけ指定する必要があります。 追加の要素はサポートされていないため、サービスによって無視されます。

このサービス操作では、OrderBy オブジェクトの Field 要素で次の値がサポートされます。

Id - 順序は、返される InsertionOrder の Id 要素によって決まります。

Name - 順序は、返される InsertionOrder の Name 要素によって決まります。		 OrderBy 配列
PageInfo ページごとの結果のインデックスとサイズを決定します。 Paging
述語 要求条件を決定します。 この操作の応答には、指定されたすべての述語に一致するアカウントが含まれます。

最大 6 つの述語を指定でき、述語フィールドの 1 つは AccountId である必要があります。 StartDate 述語フィールドと EndDate 述語フィールドをそれぞれ 2 回使用して開始日と終了日の範囲を指定できます。それ以外の場合は、各述語フィールドを 1 回だけ使用できます。

このサービス操作で Predicate オブジェクトのサポートされている Field 要素と Operator 要素の一覧については、「述語の備考」を参照してください。		 述語 配列
ReturnAdditionalFields 返される各挿入順序に含めたい追加のプロパティの一覧。 追加のフィールド値を使用すると、現在のバージョンの Customer Billing API を使用して最新の機能を取得できます。 注: 対応する要素は、今後の更新プログラムに既定で含まれます。

この要求要素は省略可能です。		 InsertionOrderAdditionalField

要求ヘッダー要素

要素 説明 データ型
AuthenticationToken Microsoft Advertising アカウントへのアクセス許可を持つユーザーの資格情報を表す OAuth アクセス トークン。

詳細については、「 OAuth による認証」を参照してください。		 string
DeveloperToken Bing Ads API へのアクセスに使用される開発者トークン。

詳細については、「 開発者トークンを取得する」を参照してください。		 string
Password この要素は内部使用のために予約されており、今後のバージョンの 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
Namespace: https://bingads.microsoft.com/Billing/v13

要求 URL

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

Request 要素

SearchInsertionOrdersRequest オブジェクトは、サービス操作要求の本文要素とヘッダー要素を定義します。

注:

以下に特に記載がない限り、すべての要求要素が必要です。

要求本文要素

要素 説明 データ型
順序 アカウントの指定したプロパティによって結果の順序を決定します。

配列では 、OrderBy 要素を 1 つだけ指定する必要があります。 追加の要素はサポートされていないため、サービスによって無視されます。

このサービス操作では、OrderBy オブジェクトの Field 要素で次の値がサポートされます。

Id - 順序は、返される InsertionOrder の Id 要素によって決まります。

Name - 順序は、返される InsertionOrder の Name 要素によって決まります。		 OrderBy 配列
PageInfo ページごとの結果のインデックスとサイズを決定します。 Paging
述語 要求条件を決定します。 この操作の応答には、指定されたすべての述語に一致するアカウントが含まれます。

最大 6 つの述語を指定でき、述語フィールドの 1 つは AccountId である必要があります。 StartDate 述語フィールドと EndDate 述語フィールドをそれぞれ 2 回使用して開始日と終了日の範囲を指定できます。それ以外の場合は、各述語フィールドを 1 回だけ使用できます。

このサービス操作で Predicate オブジェクトのサポートされている Field 要素と Operator 要素の一覧については、「述語の備考」を参照してください。		 述語 配列
ReturnAdditionalFields 返される各挿入順序に含めたい追加のプロパティの一覧。 追加のフィールド値を使用すると、現在のバージョンの Customer Billing API を使用して最新の機能を取得できます。 注: 対応する要素は、今後の更新プログラムに既定で含まれます。

この要求要素は省略可能です。		 InsertionOrderAdditionalField

要求ヘッダー要素

要素 説明 データ型
Authorization Microsoft Advertising アカウントへのアクセス許可を持つユーザーの資格情報を表す OAuth アクセス トークン。 トークンのプレフィックスに "Bearer" があることを確認してください。これは、適切な認証に必要です。

詳細については、「 OAuth による認証」を参照してください。		 string
DeveloperToken Bing Ads API へのアクセスに使用される開発者トークン。

詳細については、「 開発者トークンを取得する」を参照してください。		 string
Password この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。 ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。 string
UserName この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。 ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。 string

Response 要素

SearchInsertionOrdersResponse オブジェクトは、サービス操作応答の本文要素とヘッダー要素を定義します。 要素は、 Response 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)