Opération de service SearchInsertionOrders - Facturation client
Recherche les ordres d’insertion qui correspondent à un critère spécifié.
Éléments de demande
L’objet SearchInsertionOrdersRequest définit les éléments body et header de la demande d’opération de service. Les éléments doivent être dans le même ordre que celui indiqué dans la requête SOAP.
Remarque
Sauf indication contraire ci-dessous, tous les éléments de requête sont requis.
Éléments du corps de la requête
| Élément | Description | Type de données |
|---|---|---|
| Classement | Détermine l’ordre des résultats par la propriété spécifiée d’un compte. Vous ne devez spécifier qu’un seul élément OrderBy dans le tableau. Les éléments supplémentaires ne sont pas pris en charge et seront ignorés par le service. Pour cette opération de service, les valeurs suivantes sont prises en charge dans l’élément Field d’un objet OrderBy . Id : l’ordre est déterminé par l’élément Id de l’insertionOrder retourné. Name : l’ordre est déterminé par l’élément Name de l’insertionOrder retourné. |
Tableau OrderBy |
| PageInfo | Détermine l’index et la taille des résultats par page. | Pagination |
| Prédicats | Détermine les conditions de la demande. La réponse de cette opération inclut les comptes qui correspondent à tous les prédicats spécifiés. Vous pouvez spécifier jusqu’à 6 prédicats, et l’un des champs de prédicat doit être AccountId. Vous pouvez utiliser les champs de prédicat StartDate et EndDate deux fois chacun pour spécifier des plages de dates de début et de fin. Sinon, vous ne pouvez utiliser chaque champ de prédicat qu’une seule fois. Pour obtenir la liste des éléments Field et Operator pris en charge d’un objet Predicate pour cette opération de service, consultez Remarques sur le prédicat. |
Tableau de prédicats |
| ReturnAdditionalFields | Liste des propriétés supplémentaires que vous souhaitez inclure dans chaque ordre d’insertion retourné. Les valeurs de champ supplémentaires vous permettent d’obtenir les dernières fonctionnalités à l’aide de la version actuelle de l’API Facturation client.
Remarque : Les éléments correspondants seront inclus par défaut dans une prochaine mise à jour. Cet élément de requête est facultatif. |
InsertionOrderAdditionalField |
Éléments d’en-tête de requête
| Élément | Description | Type de données |
|---|---|---|
| AuthenticationToken | Jeton d’accès OAuth qui représente les informations d’identification d’un utilisateur disposant d’autorisations sur les comptes Microsoft Advertising. Pour plus d’informations, consultez Authentification avec OAuth. |
chaîne |
| DeveloperToken | Jeton de développeur utilisé pour accéder à l’API Bing Ads. Pour plus d’informations, consultez Obtenir un jeton de développeur. |
chaîne |
| Mot de passe | Cet élément est réservé à un usage interne et sera supprimé d’une version ultérieure de l’API. Vous devez utiliser l’élément AuthenticationToken pour définir les informations d’identification de l’utilisateur. | chaîne |
| UserName | Cet élément est réservé à un usage interne et sera supprimé d’une version ultérieure de l’API. Vous devez utiliser l’élément AuthenticationToken pour définir les informations d’identification de l’utilisateur. | chaîne |
Éléments Response
L’objet SearchInsertionOrdersResponse définit les éléments body et header de la réponse de l’opération de service. Les éléments sont retournés dans le même ordre que celui indiqué dans la réponse SOAP.
Response Body, éléments
| Élément | Description | Type de données |
|---|---|---|
| InsertionOrders | Liste des ordres d’insertion qui répondent aux critères spécifiés. | Tableau InsertionOrder |
Éléments d’en-tête de réponse
| Élément | Description | Type de données |
|---|---|---|
| TrackingId | Identificateur de l’entrée de journal qui contient les détails de l’appel d’API. | chaîne |
Requête SOAP
Ce modèle a été généré par un outil pour afficher l’ordre des éléments body et header pour la requête SOAP. Pour connaître les types pris en charge que vous pouvez utiliser avec cette opération de service, consultez la référence Éléments du corps de la demande ci-dessus.
<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:e27="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
<e27:Predicate>
<e27:Field i:nil="false">ValueHere</e27:Field>
<e27:Operator>ValueHere</e27:Operator>
<e27:Value i:nil="false">ValueHere</e27:Value>
</e27:Predicate>
</Predicates>
<Ordering xmlns:e28="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
<e28:OrderBy>
<e28:Field>ValueHere</e28:Field>
<e28:Order>ValueHere</e28:Order>
</e28:OrderBy>
</Ordering>
<PageInfo xmlns:e29="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
<e29:Index>ValueHere</e29:Index>
<e29:Size>ValueHere</e29:Size>
</PageInfo>
<ReturnAdditionalFields i:nil="false">ValueHere</ReturnAdditionalFields>
</SearchInsertionOrdersRequest>
</s:Body>
</s:Envelope>
Soap de réponse
Ce modèle a été généré par un outil pour afficher l’ordre des éléments de corps et d’en-tête pour la réponse 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:e30="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<e30:InsertionOrder>
<e30:AccountId>ValueHere</e30:AccountId>
<e30:BookingCountryCode d4p1:nil="false">ValueHere</e30:BookingCountryCode>
<e30:Comment d4p1:nil="false">ValueHere</e30:Comment>
<e30:EndDate d4p1:nil="false">ValueHere</e30:EndDate>
<e30:Id d4p1:nil="false">ValueHere</e30:Id>
<e30:LastModifiedByUserId d4p1:nil="false">ValueHere</e30:LastModifiedByUserId>
<e30:LastModifiedTime d4p1:nil="false">ValueHere</e30:LastModifiedTime>
<e30:NotificationThreshold d4p1:nil="false">ValueHere</e30:NotificationThreshold>
<e30:ReferenceId d4p1:nil="false">ValueHere</e30:ReferenceId>
<e30:SpendCapAmount d4p1:nil="false">ValueHere</e30:SpendCapAmount>
<e30:StartDate d4p1:nil="false">ValueHere</e30:StartDate>
<e30:Name d4p1:nil="false">ValueHere</e30:Name>
<e30:Status d4p1:nil="false">ValueHere</e30:Status>
<e30:PurchaseOrder d4p1:nil="false">ValueHere</e30:PurchaseOrder>
<e30:PendingChanges d4p1:nil="false">
<e30:Comment d4p1:nil="false">ValueHere</e30:Comment>
<e30:EndDate d4p1:nil="false">ValueHere</e30:EndDate>
<e30:RequestedByUserId d4p1:nil="false">ValueHere</e30:RequestedByUserId>
<e30:ModifiedDateTime d4p1:nil="false">ValueHere</e30:ModifiedDateTime>
<e30:NotificationThreshold d4p1:nil="false">ValueHere</e30:NotificationThreshold>
<e30:ReferenceId d4p1:nil="false">ValueHere</e30:ReferenceId>
<e30:SpendCapAmount d4p1:nil="false">ValueHere</e30:SpendCapAmount>
<e30:StartDate d4p1:nil="false">ValueHere</e30:StartDate>
<e30:Name d4p1:nil="false">ValueHere</e30:Name>
<e30:PurchaseOrder d4p1:nil="false">ValueHere</e30:PurchaseOrder>
<e30:ChangeStatus d4p1:nil="false">ValueHere</e30:ChangeStatus>
</e30:PendingChanges>
<e30:AccountNumber d4p1:nil="false">ValueHere</e30:AccountNumber>
<e30:BudgetRemaining d4p1:nil="false">ValueHere</e30:BudgetRemaining>
<e30:BudgetSpent d4p1:nil="false">ValueHere</e30:BudgetSpent>
<e30:BudgetRemainingPercent d4p1:nil="false">ValueHere</e30:BudgetRemainingPercent>
<e30:BudgetSpentPercent d4p1:nil="false">ValueHere</e30:BudgetSpentPercent>
<e30:SeriesName d4p1:nil="false">ValueHere</e30:SeriesName>
<e30:IsInSeries d4p1:nil="false">ValueHere</e30:IsInSeries>
<e30:SeriesFrequencyType d4p1:nil="false">ValueHere</e30:SeriesFrequencyType>
<e30:IsUnlimited d4p1:nil="false">ValueHere</e30:IsUnlimited>
<e30:IsEndless d4p1:nil="false">ValueHere</e30:IsEndless>
</e30:InsertionOrder>
</InsertionOrders>
</SearchInsertionOrdersResponse>
</s:Body>
</s:Envelope>
Syntaxe du code
L’exemple de syntaxe peut être utilisé avec les Kits de développement logiciel (SDK) Bing Ads. Pour plus d’exemples, consultez Exemples de code de l’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)
Configuration requise
Service : CustomerBillingService.svc v13
Namespace: https://bingads.microsoft.com/Billing/v13
URL de la demande
https://clientcenter.api.bingads.microsoft.com/CustomerBilling/v13/InsertionOrders/Search
Éléments de demande
L’objet SearchInsertionOrdersRequest définit les éléments body et header de la demande d’opération de service.
Remarque
Sauf indication contraire ci-dessous, tous les éléments de requête sont requis.
Éléments du corps de la requête
| Élément | Description | Type de données |
|---|---|---|
| Classement | Détermine l’ordre des résultats par la propriété spécifiée d’un compte. Vous ne devez spécifier qu’un seul élément OrderBy dans le tableau. Les éléments supplémentaires ne sont pas pris en charge et seront ignorés par le service. Pour cette opération de service, les valeurs suivantes sont prises en charge dans l’élément Field d’un objet OrderBy . Id : l’ordre est déterminé par l’élément Id de l’insertionOrder retourné. Name : l’ordre est déterminé par l’élément Name de l’insertionOrder retourné. |
Tableau OrderBy |
| PageInfo | Détermine l’index et la taille des résultats par page. | Pagination |
| Prédicats | Détermine les conditions de la demande. La réponse de cette opération inclut les comptes qui correspondent à tous les prédicats spécifiés. Vous pouvez spécifier jusqu’à 6 prédicats, et l’un des champs de prédicat doit être AccountId. Vous pouvez utiliser les champs de prédicat StartDate et EndDate deux fois chacun pour spécifier des plages de dates de début et de fin. Sinon, vous ne pouvez utiliser chaque champ de prédicat qu’une seule fois. Pour obtenir la liste des éléments Field et Operator pris en charge d’un objet Predicate pour cette opération de service, consultez Remarques sur le prédicat. |
Tableau de prédicats |
| ReturnAdditionalFields | Liste des propriétés supplémentaires que vous souhaitez inclure dans chaque ordre d’insertion retourné. Les valeurs de champ supplémentaires vous permettent d’obtenir les dernières fonctionnalités à l’aide de la version actuelle de l’API Facturation client.
Remarque : Les éléments correspondants seront inclus par défaut dans une prochaine mise à jour. Cet élément de requête est facultatif. |
InsertionOrderAdditionalField |
Éléments d’en-tête de requête
| Élément | Description | Type de données |
|---|---|---|
| Autorisation | Jeton d’accès OAuth qui représente les informations d’identification d’un utilisateur disposant d’autorisations sur les comptes Microsoft Advertising. Vérifiez que le jeton est précédé de « Porteur », ce qui est nécessaire pour une authentification appropriée. Pour plus d’informations, consultez Authentification avec OAuth. |
chaîne |
| DeveloperToken | Jeton de développeur utilisé pour accéder à l’API Bing Ads. Pour plus d’informations, consultez Obtenir un jeton de développeur. |
chaîne |
| Mot de passe | Cet élément est réservé à un usage interne et sera supprimé d’une version ultérieure de l’API. Vous devez utiliser l’élément AuthenticationToken pour définir les informations d’identification de l’utilisateur. | chaîne |
| UserName | Cet élément est réservé à un usage interne et sera supprimé d’une version ultérieure de l’API. Vous devez utiliser l’élément AuthenticationToken pour définir les informations d’identification de l’utilisateur. | chaîne |
Éléments Response
L’objet SearchInsertionOrdersResponse définit les éléments body et header de la réponse de l’opération de service. Les éléments sont retournés dans le même ordre que celui indiqué dans le json de réponse.
Response Body, éléments
| Élément | Description | Type de données |
|---|---|---|
| InsertionOrders | Liste des ordres d’insertion qui répondent aux critères spécifiés. | Tableau InsertionOrder |
Éléments d’en-tête de réponse
| Élément | Description | Type de données |
|---|---|---|
| TrackingId | Identificateur de l’entrée de journal qui contient les détails de l’appel d’API. | chaîne |
Requête JSON
Ce modèle a été généré par un outil pour afficher le corps et les éléments d’en-tête de la requête JSON. Pour connaître les types pris en charge que vous pouvez utiliser avec cette opération de service, consultez la référence Éléments du corps de la demande ci-dessus.
{
"Predicates": [
{
"Field": "ValueHere",
"Operator": "ValueHere",
"Value": "ValueHere"
}
],
"Ordering": [
{
"Field": "ValueHere",
"Order": "ValueHere"
}
],
"PageInfo": {
"Index": IntValueHere,
"Size": IntValueHere
},
"ReturnAdditionalFields": "ValueHere"
}
JSON de réponse
Ce modèle a été généré par un outil pour afficher le corps et les éléments d’en-tête de la réponse 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"
}
]
}
Syntaxe du code
Pour appeler l’API REST via des kits SDK, vous devez mettre à niveau le KIT de développement logiciel (SDK) vers une certaine version et configurer les paramètres système. L’exemple de syntaxe peut être utilisé avec les Kits de développement logiciel (SDK) Bing Ads. Pour plus d’exemples, consultez Exemples de code de l’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)