Opération du service GetAuctionInsightData - Ad Insight
Obtient des données d’insights d’enchères pour un compte, des campagnes, des groupes d’annonces ou des mots clés.
En vous montrant où vous réussissez et où vous risquez de manquer des opportunités d’amélioration des performances, les données d’insights d’enchères peuvent vous aider à prendre des décisions d’optimisation stratégiques.
S’il s’agit d’une nouvelle campagne ou si vous avez trop peu d’impressions, les données d’insights d’enchères ne seront pas générées.
La période de conservation des données est de 180 jours.
Éléments de demande
L’objet GetAuctionInsightDataRequest 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 |
---|---|---|
EntityIds | Identificateurs Microsoft Advertising pour jusqu’à 200 campagnes, groupes d’annonces ou mots clés. Cet élément est requis pour la campagne, le groupe d’annonces et les types d’entités mot clé. Si EntityType a la valeur Account, cet élément est facultatif et remplace la valeur définie dans l’en-tête CustomerAccountId. Quel que soit le type d’entité, vous devez définir les éléments d’en-tête CustomerId et CustomerAccountId. |
tableau long |
EntityType | Niveau d’entité auquel vous souhaitez demander des données d’insights d’enchères. Les valeurs prises en charge sont Account, Campaign, AdGroup et Keyword. Cet élément est obligatoire. |
EntityType |
ReturnAdditionalFields | Liste des propriétés supplémentaires que vous souhaitez inclure dans chaque indicateur de performance clé d’analyse de l’enchère 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 Ad Insight, et dans la version suivante, les éléments correspondants seront inclus par défaut. Cet élément de requête est facultatif. |
AuctionInsightKpiAdditionalField |
SearchParameters | Les paramètres de recherche définissent vos critères et filtres pour les données d’insights d’enchères. Vous devez inclure exactement un DateRangeSearchParameter. En outre, vous pouvez éventuellement inclure jusqu’à trois objets AuctionSegmentSearchParameter différents, par exemple pour Day, DayOfWeek et Device. Les autres objets qui dérivent de SearchParameter ne sont pas valides pour cette opération. |
Tableau SearchParameter |
É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 |
CustomerAccountId | Identificateur du compte publicitaire qui possède ou est associé aux entités dans la demande. Cet élément d’en-tête doit avoir la même valeur que l’élément de corps AccountId lorsque les deux sont nécessaires. Cet élément est requis pour la plupart des opérations de service et, à titre de bonne pratique, vous devez toujours le définir. Pour plus d’informations, consultez Obtenir votre compte et ID de client. |
chaîne |
Customerid | Identificateur du compte de responsable (client) auquel l’utilisateur accède ou à partir duquel il opère. Un utilisateur peut avoir accès à plusieurs comptes de gestionnaire. Cet élément est requis pour la plupart des opérations de service et, à titre de bonne pratique, vous devez toujours le définir. Pour plus d’informations, consultez Obtenir votre compte et ID de client. |
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 |
Password | 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 GetAuctionInsightDataResponse 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 |
---|---|---|
Résultat | Inclut les entrées d’insights d’enchères pour l’entité demandée, la plage de dates et les paramètres de recherche de segment. | AuctionInsightResult |
É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/AdInsight/v13">
<Action mustUnderstand="1">GetAuctionInsightData</Action>
<AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
<CustomerAccountId i:nil="false">ValueHere</CustomerAccountId>
<CustomerId i:nil="false">ValueHere</CustomerId>
<DeveloperToken i:nil="false">ValueHere</DeveloperToken>
</s:Header>
<s:Body>
<GetAuctionInsightDataRequest xmlns="https://bingads.microsoft.com/AdInsight/v13">
<EntityType>ValueHere</EntityType>
<EntityIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</EntityIds>
<SearchParameters i:nil="false">
<SearchParameter i:type="-- derived type specified here with the appropriate prefix --">
<!--These fields are applicable if the derived type attribute is set to DateRangeSearchParameter-->
<EndDate i:nil="false">
<Day>ValueHere</Day>
<Month>ValueHere</Month>
<Year>ValueHere</Year>
</EndDate>
<StartDate i:nil="false">
<Day>ValueHere</Day>
<Month>ValueHere</Month>
<Year>ValueHere</Year>
</StartDate>
<!--This field is applicable if the derived type attribute is set to AuctionSegmentSearchParameter-->
<Segment>ValueHere</Segment>
</SearchParameter>
</SearchParameters>
<ReturnAdditionalFields i:nil="false">ValueHere</ReturnAdditionalFields>
</GetAuctionInsightDataRequest>
</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/AdInsight/v13">
<TrackingId d3p1:nil="false" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</TrackingId>
</s:Header>
<s:Body>
<GetAuctionInsightDataResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
<Result d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<Segments d4p1:nil="false">
<AuctionSegment>ValueHere</AuctionSegment>
</Segments>
<Entries d4p1:nil="false">
<AuctionInsightEntry>
<DisplayDomain d4p1:nil="false">ValueHere</DisplayDomain>
<AggregatedKpi d4p1:nil="false">
<Segments d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:string>ValueHere</a1:string>
</Segments>
<ImpressionShare>ValueHere</ImpressionShare>
<OverlapRate>ValueHere</OverlapRate>
<AveragePosition>ValueHere</AveragePosition>
<AboveRate>ValueHere</AboveRate>
<TopOfPageRate>ValueHere</TopOfPageRate>
<OutrankingShare>ValueHere</OutrankingShare>
<AbsoluteTopOfPageRate>ValueHere</AbsoluteTopOfPageRate>
</AggregatedKpi>
<SegmentedKpis d4p1:nil="false">
<AuctionInsightKpi>
<Segments d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:string>ValueHere</a1:string>
</Segments>
<ImpressionShare>ValueHere</ImpressionShare>
<OverlapRate>ValueHere</OverlapRate>
<AveragePosition>ValueHere</AveragePosition>
<AboveRate>ValueHere</AboveRate>
<TopOfPageRate>ValueHere</TopOfPageRate>
<OutrankingShare>ValueHere</OutrankingShare>
<AbsoluteTopOfPageRate>ValueHere</AbsoluteTopOfPageRate>
</AuctionInsightKpi>
</SegmentedKpis>
</AuctionInsightEntry>
</Entries>
<UsedImpressions>ValueHere</UsedImpressions>
<UsedKeywords>ValueHere</UsedKeywords>
</Result>
</GetAuctionInsightDataResponse>
</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<GetAuctionInsightDataResponse> GetAuctionInsightDataAsync(
EntityType entityType,
IList<long> entityIds,
IList<SearchParameter> searchParameters,
AuctionInsightKpiAdditionalField? returnAdditionalFields)
{
var request = new GetAuctionInsightDataRequest
{
EntityType = entityType,
EntityIds = entityIds,
SearchParameters = searchParameters,
ReturnAdditionalFields = returnAdditionalFields
};
return (await AdInsightService.CallAsync((s, r) => s.GetAuctionInsightDataAsync(r), request));
}
static GetAuctionInsightDataResponse getAuctionInsightData(
EntityType entityType,
ArrayOflong entityIds,
ArrayOfSearchParameter searchParameters,
ArrayList<AuctionInsightKpiAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
GetAuctionInsightDataRequest request = new GetAuctionInsightDataRequest();
request.setEntityType(entityType);
request.setEntityIds(entityIds);
request.setSearchParameters(searchParameters);
request.setReturnAdditionalFields(returnAdditionalFields);
return AdInsightService.getService().getAuctionInsightData(request);
}
static function GetAuctionInsightData(
$entityType,
$entityIds,
$searchParameters,
$returnAdditionalFields)
{
$GLOBALS['Proxy'] = $GLOBALS['AdInsightProxy'];
$request = new GetAuctionInsightDataRequest();
$request->EntityType = $entityType;
$request->EntityIds = $entityIds;
$request->SearchParameters = $searchParameters;
$request->ReturnAdditionalFields = $returnAdditionalFields;
return $GLOBALS['AdInsightProxy']->GetService()->GetAuctionInsightData($request);
}
response=adinsight_service.GetAuctionInsightData(
EntityType=EntityType,
EntityIds=EntityIds,
SearchParameters=SearchParameters,
ReturnAdditionalFields=ReturnAdditionalFields)
Configuration requise
Service : AdInsightService.svc v13
Noms: https://bingads.microsoft.com/AdInsight/v13