Freigeben über

SearchInsertionOrders Service Operation – Kundenabrechnung

  • Artikel

Sucht nach Einfügeaufträgen, die einem angegebenen Kriterium entsprechen.

Anfordern von Elementen

Das SearchInsertionOrdersRequest-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 Kontos.

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.

Id : Die Reihenfolge wird durch das Id-Element der zurückgegebenen InsertionOrder bestimmt.

Name : Die Reihenfolge wird durch das Name-Element der zurückgegebenen InsertionOrder 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 Konten, die allen angegebenen Prädikaten entsprechen.

Sie können bis zu 6 Prädikate angeben, und eines der Prädikatfelder muss AccountId sein. Sie können die Prädikatfelder StartDate und EndDate jeweils zweimal verwenden, um Start- und Enddatumsbereiche anzugeben. Andernfalls können Sie jedes Prädikatfeld nur einmal verwenden.

Eine Liste der unterstützten Field - und Operator-Elemente eines Prädikatobjekts für diesen Dienstvorgang finden Sie unter Prädikatshinweise.		 Prädikatarray
ReturnAdditionalFields Die Liste der zusätzlichen Eigenschaften, die in jeder zurückgegebenen Einfügereihenfolge enthalten sein sollen. Mit den zusätzlichen Feldwerten können Sie die neuesten Features mithilfe der aktuellen Version der Kundenabrechnungs-API abrufen. Hinweis: Entsprechende Elemente werden standardmäßig in einem zukünftigen Update enthalten sein.

Dieses Anforderungselement ist optional.		 InsertionOrderAdditionalField

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 SearchInsertionOrdersResponse-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
InsertionOrders Eine Liste von Einfügeaufträgen, die die angegebenen Kriterien erfüllen. InsertionOrder-Array

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

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

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

Anforderungen

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

Anforderungs-URL

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

Anfordern von Elementen

Das SearchInsertionOrdersRequest-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 Kontos.

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.

Id : Die Reihenfolge wird durch das Id-Element der zurückgegebenen InsertionOrder bestimmt.

Name : Die Reihenfolge wird durch das Name-Element der zurückgegebenen InsertionOrder 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 Konten, die allen angegebenen Prädikaten entsprechen.

Sie können bis zu 6 Prädikate angeben, und eines der Prädikatfelder muss AccountId sein. Sie können die Prädikatfelder StartDate und EndDate jeweils zweimal verwenden, um Start- und Enddatumsbereiche anzugeben. Andernfalls können Sie jedes Prädikatfeld nur einmal verwenden.

Eine Liste der unterstützten Field - und Operator-Elemente eines Prädikatobjekts für diesen Dienstvorgang finden Sie unter Prädikatshinweise.		 Prädikatarray
ReturnAdditionalFields Die Liste der zusätzlichen Eigenschaften, die in jeder zurückgegebenen Einfügereihenfolge enthalten sein sollen. Mit den zusätzlichen Feldwerten können Sie die neuesten Features mithilfe der aktuellen Version der Kundenabrechnungs-API abrufen. Hinweis: Entsprechende Elemente werden standardmäßig in einem zukünftigen Update enthalten sein.

Dieses Anforderungselement ist optional.		 InsertionOrderAdditionalField

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 SearchInsertionOrdersResponse-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
InsertionOrders Eine Liste von Einfügeaufträgen, die die angegebenen Kriterien erfüllen. InsertionOrder-Array

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.

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

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