Condividi tramite

Operazione del servizio SearchInsertionOrders - Fatturazione del cliente

  • Articolo

Cerca gli ordini di inserimento che corrispondono a criteri specificati.

Elementi della richiesta

L'oggetto SearchInsertionOrdersRequest definisce il corpo e gli elementi dell'intestazione della richiesta di operazione del servizio. Gli elementi devono essere nello stesso ordine indicato nella richiesta SOAP.

Nota

Se non diversamente indicato di seguito, sono necessari tutti gli elementi della richiesta.

Elementi del corpo della richiesta

Elemento Descrizione Tipo di dati
Ordinando Determina l'ordine dei risultati in base alla proprietà specificata di un account.

È necessario specificare un solo elemento OrderBy nella matrice. Gli elementi aggiuntivi non sono supportati e verranno ignorati dal servizio.

Per questa operazione di servizio, i valori seguenti sono supportati nell'elemento Field di un oggetto OrderBy .

Id : l'ordine è determinato dall'elemento Id dell'oggetto InsertionOrder restituito.

Name : l'ordine è determinato dall'elemento Name dell'oggetto InsertionOrder restituito.		 Matrice OrderBy
PageInfo Determina l'indice e le dimensioni dei risultati per pagina. Paging
Predicati Determina le condizioni della richiesta. La risposta di questa operazione includerà account che corrispondono a tutti i predicati specificati.

È possibile specificare fino a 6 predicati e uno dei campi del predicato deve essere AccountId. È possibile utilizzare i campi predicato StartDate e EndDate due volte ciascuno per specificare gli intervalli di date di inizio e fine e in caso contrario è possibile usare ogni campo predicato una sola volta.

Per un elenco degli elementi Field e Operator supportati di un oggetto Predicate per questa operazione del servizio, vedere Predicate Remarks.		 Matrice predicato
ReturnAdditionalFields Elenco di proprietà aggiuntive che si desidera includere in ogni ordine di inserimento restituito. I valori di campo aggiuntivi consentono di ottenere le funzionalità più recenti usando la versione corrente dell'API di fatturazione del cliente. Nota: gli elementi corrispondenti verranno inclusi per impostazione predefinita in un aggiornamento futuro.

Questo elemento della richiesta è facoltativo.		 InsertionOrderAdditionalField

Elementi dell'intestazione della richiesta

Elemento Descrizione Tipo di dati
AuthenticationToken Token di accesso OAuth che rappresenta le credenziali di un utente che dispone delle autorizzazioni per gli account Microsoft Advertising.

Per altre informazioni, vedere Autenticazione con OAuth.		 corda
DeveloperToken Token di sviluppo usato per accedere all'API Bing Ads.

Per altre informazioni, vedere Ottenere un token per sviluppatori.		 corda
Password Questo elemento è riservato per l'uso interno e verrà rimosso da una versione futura dell'API. È necessario usare l'elemento AuthenticationToken per impostare le credenziali utente. corda
UserName Questo elemento è riservato per l'uso interno e verrà rimosso da una versione futura dell'API. È necessario usare l'elemento AuthenticationToken per impostare le credenziali utente. corda

Elementi di risposta

L'oggetto SearchInsertionOrdersResponse definisce il corpo e gli elementi dell'intestazione della risposta dell'operazione del servizio. Gli elementi vengono restituiti nello stesso ordine illustrato nella soap di risposta.

Elementi del corpo della risposta

Elemento Descrizione Tipo di dati
InsertionOrders Elenco di ordini di inserimento che soddisfano i criteri specificati. Matrice InsertionOrder

Elementi dell'intestazione della risposta

Elemento Descrizione Tipo di dati
TrackingId Identificatore della voce di log che contiene i dettagli della chiamata API. corda

Richiedi SOAP

Questo modello è stato generato da uno strumento per visualizzare l'ordine degli elementi corpo e intestazione per la richiesta SOAP. Per i tipi supportati che è possibile usare con questa operazione del servizio, vedere il riferimento Request Body Elements sopra riportato.

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

Questo modello è stato generato da uno strumento per visualizzare l'ordine degli elementi del corpo e dell'intestazione per la risposta 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>

Sintassi del codice

La sintassi di esempio può essere usata con gli SDK di Bing Ads. Per altri esempi, vedere Esempi di codice DELL'API Bing Ads .

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)

Requisiti

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

URL richiesta

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

Elementi della richiesta

L'oggetto SearchInsertionOrdersRequest definisce il corpo e gli elementi dell'intestazione della richiesta di operazione del servizio.

Nota

Se non diversamente indicato di seguito, sono necessari tutti gli elementi della richiesta.

Elementi del corpo della richiesta

Elemento Descrizione Tipo di dati
Ordinando Determina l'ordine dei risultati in base alla proprietà specificata di un account.

È necessario specificare un solo elemento OrderBy nella matrice. Gli elementi aggiuntivi non sono supportati e verranno ignorati dal servizio.

Per questa operazione di servizio, i valori seguenti sono supportati nell'elemento Field di un oggetto OrderBy .

Id : l'ordine è determinato dall'elemento Id dell'oggetto InsertionOrder restituito.

Name : l'ordine è determinato dall'elemento Name dell'oggetto InsertionOrder restituito.		 Matrice OrderBy
PageInfo Determina l'indice e le dimensioni dei risultati per pagina. Paging
Predicati Determina le condizioni della richiesta. La risposta di questa operazione includerà account che corrispondono a tutti i predicati specificati.

È possibile specificare fino a 6 predicati e uno dei campi del predicato deve essere AccountId. È possibile utilizzare i campi predicato StartDate e EndDate due volte ciascuno per specificare gli intervalli di date di inizio e fine e in caso contrario è possibile usare ogni campo predicato una sola volta.

Per un elenco degli elementi Field e Operator supportati di un oggetto Predicate per questa operazione del servizio, vedere Predicate Remarks.		 Matrice predicato
ReturnAdditionalFields Elenco di proprietà aggiuntive che si desidera includere in ogni ordine di inserimento restituito. I valori di campo aggiuntivi consentono di ottenere le funzionalità più recenti usando la versione corrente dell'API di fatturazione del cliente. Nota: gli elementi corrispondenti verranno inclusi per impostazione predefinita in un aggiornamento futuro.

Questo elemento della richiesta è facoltativo.		 InsertionOrderAdditionalField

Elementi dell'intestazione della richiesta

Elemento Descrizione Tipo di dati
Autorizzazione Token di accesso OAuth che rappresenta le credenziali di un utente che dispone delle autorizzazioni per gli account Microsoft Advertising. Assicurarsi che il token sia preceduto da "Bearer", necessario per l'autenticazione corretta.

Per altre informazioni, vedere Autenticazione con OAuth.		 corda
DeveloperToken Token di sviluppo usato per accedere all'API Bing Ads.

Per altre informazioni, vedere Ottenere un token per sviluppatori.		 corda
Password Questo elemento è riservato per l'uso interno e verrà rimosso da una versione futura dell'API. È necessario usare l'elemento AuthenticationToken per impostare le credenziali utente. corda
UserName Questo elemento è riservato per l'uso interno e verrà rimosso da una versione futura dell'API. È necessario usare l'elemento AuthenticationToken per impostare le credenziali utente. corda

Elementi di risposta

L'oggetto SearchInsertionOrdersResponse definisce il corpo e gli elementi dell'intestazione della risposta dell'operazione del servizio. Gli elementi vengono restituiti nello stesso ordine illustrato nel codice JSON della risposta.

Elementi del corpo della risposta

Elemento Descrizione Tipo di dati
InsertionOrders Elenco di ordini di inserimento che soddisfano i criteri specificati. Matrice InsertionOrder

Elementi dell'intestazione della risposta

Elemento Descrizione Tipo di dati
TrackingId Identificatore della voce di log che contiene i dettagli della chiamata API. corda

Richiedere JSON

Questo modello è stato generato da uno strumento per visualizzare il corpo e gli elementi di intestazione per la richiesta JSON. Per i tipi supportati che è possibile usare con questa operazione del servizio, vedere il riferimento Request Body Elements sopra riportato.

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

Risposta JSON

Questo modello è stato generato da uno strumento per mostrare il corpo e gli elementi dell'intestazione per la risposta 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"
    }
  ]
}

Sintassi del codice

Per chiamare l'API REST tramite SDK, è necessario aggiornare l'SDK a una determinata versione e configurare i parametri di sistema. La sintassi di esempio può essere usata con gli SDK di Bing Ads. Per altri esempi, vedere Esempi di codice DELL'API Bing Ads .

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)