GetKeywordTrafficEstimates 服務作業 - Ad Insight
提供關鍵字的流量估計值,例如平均的一般一般、平均位置、點選、CTR、曝光數和總成本。 作為輸入,您可以提供報價、語言、位置和網路,以及選擇性的行銷活動預算和負關鍵字篩選。
提示
如需概觀,請參閱 關鍵字構想和流量估計 技術指南。
要求專案
GetKeywordTrafficEstimatesRequest物件會定義服務作業要求的主體和標頭元素。 元素的順序必須與 要求 SOAP中所示的順序相同。
注意事項
除非下面另有說明,否則所有要求專案都是必要的。
要求本文專案
元素 | 說明 | 資料類型 |
---|---|---|
CampaignEstimators | 定義您的行銷活動、廣告群組和關鍵字層級準則,以及所要求關鍵字流量預估的篩選準則。 | CampaignEstimator 數 組 |
要求標頭元素
元素 | 說明 | 資料類型 |
---|---|---|
AuthenticationToken | OAuth 存取權杖,代表具有 Microsoft Advertising 帳戶許可權之使用者的認證。 如需詳細資訊,請 參閱使用 OAuth 進行驗證。 |
string |
CustomerAccountId | 擁有或與要求中實體相關聯之廣告帳戶的識別碼。 當兩者都需要時,此標頭元素必須具有與 AccountId body 元素相同的值。 此元素是大部分服務作業的必要專案,最佳做法是一律加以設定。 如需詳細資訊, 請參閱取得您的帳戶和客戶識別碼。 |
string |
CustomerId | (使用者存取或操作之使用者) 客戶的管理員帳戶識別碼。 使用者可以存取多個管理員帳戶。 此元素是大部分服務作業的必要專案,最佳做法是一律加以設定。 如需詳細資訊, 請參閱取得您的帳戶和客戶識別碼。 |
string |
DeveloperToken | 用來存取 Bing 廣告 API 的開發人員權杖。 如需詳細資訊 ,請參閱取得開發人員權杖。 |
string |
密碼 | 此元素會保留供內部使用,並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定使用者認證。 | string |
UserName | 此元素會保留供內部使用,並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定使用者認證。 | string |
Response 元素
GetKeywordTrafficEstimatesResponse物件會定義服務作業回應的主體和標頭元素。 這些元素的傳回順序與 回應 SOAP中所示的順序相同。
回應本文專案
元素 | 說明 | 資料類型 |
---|---|---|
CampaignEstimates | 行銷活動預估的清單。 在每個行銷活動預估中,是每個廣告群組的關鍵字流量預估的巢狀清單。 您可以檢查 BatchError Details 元素,找出哪些要求的清單專案失敗。 例如,如果詳細資料包含 「CampaignEstimators[0], AdGroupEstimators[1], KeywordEstimators 為 null 或不包含任何值」,則提交清單中的第 2 個 AdGroupEstimator 發生錯誤。 BatchError的 Index 元素只是傳回之批次錯誤的循序計數,無法用來判斷在要求中發生錯誤的位置。 |
CampaignEstimate 數 組 |
回應標頭元素
元素 | 說明 | 資料類型 |
---|---|---|
TrackingId | 包含 API 呼叫詳細資料的記錄專案識別碼。 | string |
要求 SOAP
此範本是由工具所產生,用來顯示 SOAP 要求的主體和標頭元素順序。 如需可搭配此服務作業使用的支援類型,請參閱上述 的要求本文專案 參考。
<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">GetKeywordTrafficEstimates</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>
<GetKeywordTrafficEstimatesRequest xmlns="https://bingads.microsoft.com/AdInsight/v13">
<CampaignEstimators i:nil="false">
<CampaignEstimator>
<AdGroupEstimators i:nil="false">
<AdGroupEstimator>
<AdGroupId i:nil="false">ValueHere</AdGroupId>
<KeywordEstimators i:nil="false">
<KeywordEstimator>
<Keyword i:nil="false">
<Id i:nil="false">ValueHere</Id>
<MatchType>ValueHere</MatchType>
<Text i:nil="false">ValueHere</Text>
</Keyword>
<MaxCpc i:nil="false">ValueHere</MaxCpc>
</KeywordEstimator>
</KeywordEstimators>
<MaxCpc>ValueHere</MaxCpc>
</AdGroupEstimator>
</AdGroupEstimators>
<CampaignId i:nil="false">ValueHere</CampaignId>
<Criteria i:nil="false">
<Criterion i:type="-- derived type specified here with the appropriate prefix --">
<!--This field is applicable if the derived type attribute is set to LocationCriterion-->
<LocationId>ValueHere</LocationId>
<!--This field is applicable if the derived type attribute is set to LanguageCriterion-->
<Language i:nil="false">ValueHere</Language>
<!--This field is applicable if the derived type attribute is set to NetworkCriterion-->
<Network>ValueHere</Network>
<!--This field is applicable if the derived type attribute is set to DeviceCriterion-->
<DeviceName i:nil="false">ValueHere</DeviceName>
</Criterion>
</Criteria>
<DailyBudget i:nil="false">ValueHere</DailyBudget>
<NegativeKeywords i:nil="false">
<NegativeKeyword>
<Id i:nil="false">ValueHere</Id>
<MatchType>ValueHere</MatchType>
<Text i:nil="false">ValueHere</Text>
</NegativeKeyword>
</NegativeKeywords>
</CampaignEstimator>
</CampaignEstimators>
</GetKeywordTrafficEstimatesRequest>
</s:Body>
</s:Envelope>
回應 SOAP
此範本是由工具所產生,用來顯示 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>
<GetKeywordTrafficEstimatesResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
<CampaignEstimates d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<CampaignEstimate>
<AdGroupEstimates d4p1:nil="false">
<AdGroupEstimate>
<AdGroupId d4p1:nil="false">ValueHere</AdGroupId>
<KeywordEstimates d4p1:nil="false">
<KeywordEstimate>
<Keyword d4p1:nil="false">
<Id d4p1:nil="false">ValueHere</Id>
<MatchType>ValueHere</MatchType>
<Text d4p1:nil="false">ValueHere</Text>
</Keyword>
<Maximum d4p1:nil="false">
<AverageCpc>ValueHere</AverageCpc>
<AveragePosition>ValueHere</AveragePosition>
<Clicks>ValueHere</Clicks>
<Ctr>ValueHere</Ctr>
<Impressions>ValueHere</Impressions>
<TotalCost>ValueHere</TotalCost>
</Maximum>
<Minimum d4p1:nil="false">
<AverageCpc>ValueHere</AverageCpc>
<AveragePosition>ValueHere</AveragePosition>
<Clicks>ValueHere</Clicks>
<Ctr>ValueHere</Ctr>
<Impressions>ValueHere</Impressions>
<TotalCost>ValueHere</TotalCost>
</Minimum>
</KeywordEstimate>
</KeywordEstimates>
</AdGroupEstimate>
</AdGroupEstimates>
<CampaignId d4p1:nil="false">ValueHere</CampaignId>
</CampaignEstimate>
</CampaignEstimates>
</GetKeywordTrafficEstimatesResponse>
</s:Body>
</s:Envelope>
程式碼語法
範例語法可以與 Bing 廣告 SDK搭配使用。 如需更多範例,請參閱 Bing 廣告 API 程式碼范 例。
public async Task<GetKeywordTrafficEstimatesResponse> GetKeywordTrafficEstimatesAsync(
IList<CampaignEstimator> campaignEstimators)
{
var request = new GetKeywordTrafficEstimatesRequest
{
CampaignEstimators = campaignEstimators
};
return (await AdInsightService.CallAsync((s, r) => s.GetKeywordTrafficEstimatesAsync(r), request));
}
static GetKeywordTrafficEstimatesResponse getKeywordTrafficEstimates(
ArrayOfCampaignEstimator campaignEstimators) throws RemoteException, Exception
{
GetKeywordTrafficEstimatesRequest request = new GetKeywordTrafficEstimatesRequest();
request.setCampaignEstimators(campaignEstimators);
return AdInsightService.getService().getKeywordTrafficEstimates(request);
}
static function GetKeywordTrafficEstimates(
$campaignEstimators)
{
$GLOBALS['Proxy'] = $GLOBALS['AdInsightProxy'];
$request = new GetKeywordTrafficEstimatesRequest();
$request->CampaignEstimators = $campaignEstimators;
return $GLOBALS['AdInsightProxy']->GetService()->GetKeywordTrafficEstimates($request);
}
response=adinsight_service.GetKeywordTrafficEstimates(
CampaignEstimators=CampaignEstimators)
需求
服務: AdInsightService.svc v13
命名 空間: https://bingads.microsoft.com/AdInsight/v13