Operação de Serviço SearchInsertionOrders – Faturação do Cliente
Procura encomendas de inserção que correspondam a critérios especificados.
Elementos do Pedido
O objeto SearchInsertionOrdersRequest define os elementos do corpo e do cabeçalho do pedido de operação do serviço. Os elementos têm de estar na mesma ordem mostrada no Pedido SOAP.
Nota
Salvo indicação em contrário abaixo, todos os elementos do pedido são necessários.
Elementos do Corpo do Pedido
| Elemento | Descrição | Tipo de Dados |
|---|---|---|
| Encomenda | Determina a ordem dos resultados pela propriedade especificada de uma conta. Só deve especificar um elemento OrderBy na matriz. Os elementos adicionais não são suportados e serão ignorados pelo serviço. Para esta operação de serviço, os seguintes valores são suportados no elemento Campo de um objeto OrderBy . ID – a ordem é determinada pelo elemento ID da InsertionOrder devolvida. Nome – a ordem é determinada pelo elemento Nome da InsertionOrder devolvida. |
Matriz OrderBy |
| PageInfo | Determina o índice e o tamanho dos resultados por página. | Paginação |
| Predicados | Determina as condições do pedido. A resposta desta operação incluirá contas que correspondem a todos os predicados especificados. Pode especificar até 6 predicados e um dos campos predicados tem de ser AccountId. Pode utilizar os campos de predicado StartDate e EndDate duas vezes cada para especificar intervalos de datas de início e de fim e, caso contrário, só poderá utilizar cada campo de predicado uma vez. Para obter uma lista dos elementos de Campo e Operador suportados de um objeto Predicado para esta operação de serviço, veja Predicado Observações. |
Predicado de matriz |
| ReturnAdditionalFields | A lista de propriedades adicionais que pretende incluir em cada ordem de inserção devolvida. Os valores de campo adicionais permitem-lhe obter as funcionalidades mais recentes com a versão atual da API de Faturação do Cliente.
Nota: os elementos correspondentes serão incluídos por predefinição numa atualização futura. Este elemento de pedido é opcional. |
InsertionOrderAdditionalField |
Elementos do Cabeçalho do Pedido
| Elemento | Descrição | Tipo de Dados |
|---|---|---|
| AuthenticationToken | O token de acesso OAuth que representa as credenciais de um utilizador que tem permissões para contas do Microsoft Advertising. Para obter mais informações, veja Authentication with OAuth (Autenticação com OAuth). |
cadeia |
| DeveloperToken | O token de programador utilizado para aceder à API de Anúncios do Bing. Para obter mais informações, veja Obter um Token de Programador. |
cadeia |
| Palavra-passe | Este elemento está reservado para utilização interna e será removido de uma versão futura da API. Tem de utilizar o elemento AuthenticationToken para definir credenciais de utilizador. | cadeia |
| Nome de Utilizador | Este elemento está reservado para utilização interna e será removido de uma versão futura da API. Tem de utilizar o elemento AuthenticationToken para definir credenciais de utilizador. | cadeia |
Elementos de Resposta
O objeto SearchInsertionOrdersResponse define os elementos do corpo e do cabeçalho da resposta da operação do serviço. Os elementos são devolvidos pela mesma ordem mostrada no SOAP de Resposta.
Elementos do Corpo da Resposta
| Elemento | Descrição | Tipo de Dados |
|---|---|---|
| InsertionOrders | Uma lista de encomendas de inserção que cumprem os critérios especificados. | Matriz InsertionOrder |
Elementos do Cabeçalho de Resposta
| Elemento | Descrição | Tipo de Dados |
|---|---|---|
| TrackingId | O identificador da entrada de registo que contém os detalhes da chamada à API. | cadeia |
Pedir SOAP
Este modelo foi gerado por uma ferramenta para mostrar a ordem dos elementos do corpo e do cabeçalho do pedido SOAP. Para tipos suportados que pode utilizar com esta operação de serviço, veja a referência Request Body Elements (Elementos do Corpo do Pedido ) acima.
<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 de Resposta
Este modelo foi gerado por uma ferramenta para mostrar a ordem dos elementos do corpo e do cabeçalho para a resposta 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>
Sintaxe de Código
A sintaxe de exemplo pode ser utilizada com os SDKs de Anúncios do Bing. Veja Exemplos de Código da API de Anúncios do Bing para obter mais exemplos.
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)
Requisitos
Serviço: CustomerBillingService.svc v13
Espaço de nomes: https://bingads.microsoft.com/Billing/v13
URL do Pedido
https://clientcenter.api.bingads.microsoft.com/CustomerBilling/v13/InsertionOrders/Search
Elementos do Pedido
O objeto SearchInsertionOrdersRequest define os elementos do corpo e do cabeçalho do pedido de operação do serviço.
Nota
Salvo indicação em contrário abaixo, todos os elementos do pedido são necessários.
Elementos do Corpo do Pedido
| Elemento | Descrição | Tipo de Dados |
|---|---|---|
| Encomenda | Determina a ordem dos resultados pela propriedade especificada de uma conta. Só deve especificar um elemento OrderBy na matriz. Os elementos adicionais não são suportados e serão ignorados pelo serviço. Para esta operação de serviço, os seguintes valores são suportados no elemento Campo de um objeto OrderBy . ID – a ordem é determinada pelo elemento ID da InsertionOrder devolvida. Nome – a ordem é determinada pelo elemento Nome da InsertionOrder devolvida. |
Matriz OrderBy |
| PageInfo | Determina o índice e o tamanho dos resultados por página. | Paginação |
| Predicados | Determina as condições do pedido. A resposta desta operação incluirá contas que correspondem a todos os predicados especificados. Pode especificar até 6 predicados e um dos campos predicados tem de ser AccountId. Pode utilizar os campos de predicado StartDate e EndDate duas vezes cada para especificar intervalos de datas de início e de fim e, caso contrário, só poderá utilizar cada campo de predicado uma vez. Para obter uma lista dos elementos de Campo e Operador suportados de um objeto Predicado para esta operação de serviço, veja Predicado Observações. |
Predicado de matriz |
| ReturnAdditionalFields | A lista de propriedades adicionais que pretende incluir em cada ordem de inserção devolvida. Os valores de campo adicionais permitem-lhe obter as funcionalidades mais recentes com a versão atual da API de Faturação do Cliente.
Nota: os elementos correspondentes serão incluídos por predefinição numa atualização futura. Este elemento de pedido é opcional. |
InsertionOrderAdditionalField |
Elementos do Cabeçalho do Pedido
| Elemento | Descrição | Tipo de Dados |
|---|---|---|
| Autorização | O token de acesso OAuth que representa as credenciais de um utilizador que tem permissões para contas do Microsoft Advertising. Certifique-se de que o token tem o prefixo "Portador", que é necessário para uma autenticação adequada. Para obter mais informações, veja Authentication with OAuth (Autenticação com OAuth). |
cadeia |
| DeveloperToken | O token de programador utilizado para aceder à API de Anúncios do Bing. Para obter mais informações, veja Obter um Token de Programador. |
cadeia |
| Palavra-passe | Este elemento está reservado para utilização interna e será removido de uma versão futura da API. Tem de utilizar o elemento AuthenticationToken para definir credenciais de utilizador. | cadeia |
| Nome de Utilizador | Este elemento está reservado para utilização interna e será removido de uma versão futura da API. Tem de utilizar o elemento AuthenticationToken para definir credenciais de utilizador. | cadeia |
Elementos de Resposta
O objeto SearchInsertionOrdersResponse define os elementos do corpo e do cabeçalho da resposta da operação do serviço. Os elementos são devolvidos pela mesma ordem mostrada no JSON de Resposta.
Elementos do Corpo da Resposta
| Elemento | Descrição | Tipo de Dados |
|---|---|---|
| InsertionOrders | Uma lista de encomendas de inserção que cumprem os critérios especificados. | Matriz InsertionOrder |
Elementos do Cabeçalho de Resposta
| Elemento | Descrição | Tipo de Dados |
|---|---|---|
| TrackingId | O identificador da entrada de registo que contém os detalhes da chamada à API. | cadeia |
Pedir JSON
Este modelo foi gerado por uma ferramenta para mostrar os elementos do corpo e do cabeçalho do pedido JSON. Para tipos suportados que pode utilizar com esta operação de serviço, veja a referência Request Body Elements (Elementos do Corpo do Pedido ) acima.
{
"Predicates": [
{
"Field": "ValueHere",
"Operator": "ValueHere",
"Value": "ValueHere"
}
],
"Ordering": [
{
"Field": "ValueHere",
"Order": "ValueHere"
}
],
"PageInfo": {
"Index": IntValueHere,
"Size": IntValueHere
},
"ReturnAdditionalFields": "ValueHere"
}
JSON de Resposta
Este modelo foi gerado por uma ferramenta para mostrar os elementos do corpo e do cabeçalho da resposta 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"
}
]
}
Sintaxe de Código
Para chamar a API REST através de SDKs, tem de atualizar o SDK para uma determinada versão e configurar os parâmetros do sistema. A sintaxe de exemplo pode ser utilizada com os SDKs de Anúncios do Bing. Veja Exemplos de Código da API de Anúncios do Bing para obter mais exemplos.
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)