GetAuctionInsightData Hizmeti İşlemi - Ad Insight
Bir hesap, kampanya, reklam grubu veya anahtar sözcük için açık artırma içgörü verilerini alır.
Nerede başarılı olduğunuzu ve gelişmiş performans fırsatlarını nerede kaçırabileceğinizi göstererek, açık artırma içgörü verileri stratejik iyileştirme kararları alma konusunda size yardımcı olabilir.
Bu yeni bir kampanyaysa veya çok az gösterim varsa açık artırma içgörü verileri oluşturulmaz.
Veri saklama süresi 180 gündür.
İstek Öğeleri
GetAuctionInsightDataRequest nesnesi, hizmet işlemi isteğinin gövde ve üst bilgi öğelerini tanımlar. Öğelerin İstek SOAP'sinde gösterildiği gibi aynı sırada olması gerekir.
Not
Aşağıda aksi belirtilmedikçe, tüm istek öğeleri gereklidir.
İstek Gövdesi Öğeleri
| Öğe | Açıklama | Veri Türü |
|---|---|---|
| EntityIds | En fazla 200 kampanya, reklam grubu veya anahtar sözcük için Microsoft Advertising tanımlayıcıları. Bu öğe kampanya, reklam grubu ve anahtar sözcük varlık türleri için gereklidir. EntityType Account ise, bu öğe isteğe bağlıdır ve CustomerAccountId üst bilgisinde ayarlanan değeri geçersiz kılar. Varlık türünden bağımsız olarak CustomerId ve CustomerAccountId üst bilgi öğelerini ayarlamanız gerekir. |
uzun dizi |
| Entitytype | Açık artırma içgörü verileri istemek istediğiniz varlık düzeyi. Hesap, Kampanya, AdGroup ve Anahtar Sözcük desteklenen değerlerdir. Bu öğe gereklidir. |
Entitytype |
| ReturnAdditionalFields | Döndürülen her açık artırma içgörü KPI'sine eklenmesini istediğiniz ek özelliklerin listesi. Ek alan değerleri, Ad Insight API'sinin geçerli sürümünü kullanarak en son özellikleri edinmenizi sağlar ve sonraki sürümde karşılık gelen öğeler varsayılan olarak eklenir. Bu istek öğesi isteğe bağlıdır. |
AuctionInsightKpiAdditionalField |
| SearchParameters | Arama parametreleri, açık artırma içgörü verileri için ölçütlerinizi ve filtrelerinizi tanımlar. Tam olarak bir DateRangeSearchParameter eklemeniz gerekir. Ayrıca isteğe bağlı olarak Day, DayOfWeek ve Device gibi üç farklı AuctionSegmentSearchParameter nesnesi ekleyebilirsiniz. SearchParameter'dan türetilen diğer nesneler bu işlem için geçerli değildir. |
SearchParameter dizisi |
İstek Üst Bilgisi Öğeleri
| Öğe | Açıklama | Veri Türü |
|---|---|---|
| AuthenticationToken | Microsoft Advertising hesaplarına izinleri olan bir kullanıcının kimlik bilgilerini temsil eden OAuth erişim belirteci. Daha fazla bilgi için bkz. OAuth ile kimlik doğrulaması. |
Dize |
| CustomerAccountId | İstekteki varlıklara sahip olan veya bunlarla ilişkilendirilmiş reklam hesabının tanımlayıcısı. Her ikisi de gerektiğinde bu üst bilgi öğesi AccountId gövde öğesiyle aynı değere sahip olmalıdır. Bu öğe çoğu hizmet işlemi için gereklidir ve en iyi yöntem olarak her zaman ayarlamanız gerekir. Daha fazla bilgi için bkz. Hesabınızı ve Müşteri Kimliklerinizi Alma. |
Dize |
| Customerıd | Kullanıcının eriştiği veya faaliyette olduğu yönetici hesabının (müşteri) tanımlayıcısı. Bir kullanıcı birden çok yönetici hesabına erişebilir. Bu öğe çoğu hizmet işlemi için gereklidir ve en iyi yöntem olarak her zaman ayarlamanız gerekir. Daha fazla bilgi için bkz. Hesabınızı ve Müşteri Kimliklerinizi Alma. |
Dize |
| DeveloperToken | Bing Ads API'sine erişmek için kullanılan geliştirici belirteci. Daha fazla bilgi için bkz . Geliştirici Belirteci Alma. |
Dize |
| Password | Bu öğe iç kullanım için ayrılmıştır ve API'nin gelecekteki bir sürümünden kaldırılacaktır. Kullanıcı kimlik bilgilerini ayarlamak için AuthenticationToken öğesini kullanmanız gerekir. | Dize |
| Username | Bu öğe iç kullanım için ayrılmıştır ve API'nin gelecekteki bir sürümünden kaldırılacaktır. Kullanıcı kimlik bilgilerini ayarlamak için AuthenticationToken öğesini kullanmanız gerekir. | Dize |
Yanıt Öğeleri
GetAuctionInsightDataResponse nesnesi, hizmet işlemi yanıtının gövde ve üst bilgi öğelerini tanımlar. Öğeler , Yanıt SOAP'sinde gösterildiği gibi aynı sırada döndürülür.
Yanıt Gövdesi Öğeleri
| Öğe | Açıklama | Veri Türü |
|---|---|---|
| Sonuç | İstenen varlık, tarih aralığı ve segment arama parametreleri için açık artırma içgörü girişlerini içerir. | AuctionInsightResult |
Yanıt Üst Bilgisi Öğeleri
| Öğe | Açıklama | Veri Türü |
|---|---|---|
| TrackingId | API çağrısının ayrıntılarını içeren günlük girdisinin tanımlayıcısı. | Dize |
SOAP isteme
Bu şablon, SOAP isteği için gövde ve üst bilgi öğelerinin sırasını gösteren bir araç tarafından oluşturulmuştur. Bu hizmet işlemiyle kullanabileceğiniz desteklenen türler için yukarıdaki İstek Gövdesi Öğeleri başvurusuna bakın.
<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>
Yanıt SOAP
Bu şablon, SOAP yanıtı için gövde ve üst bilgi öğelerinin sırasını gösteren bir araç tarafından oluşturulmuştur.
<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>
Kod Söz Dizimi
Örnek söz dizimi Bing Reklam SDK'ları ile kullanılabilir. Daha fazla örnek için bkz . Bing Ads API Kod Örnekleri .
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)
Gereksinimler
Hizmet: AdInsightService.svc v13
Ad alanı: https://bingads.microsoft.com/AdInsight/v13