GetBudgetOpportunities 服務作業 - Ad Insight
取得指定之行銷活動的行銷活動預算商機。
要求專案
GetBudgetOpportunitiesRequest物件會定義服務作業要求的主體和標頭元素。 元素的順序必須與 要求 SOAP中所示的順序相同。
注意事項
除非下面另有說明,否則所有要求專案都是必要的。
要求本文專案
元素 | 說明 | 資料類型 |
---|---|---|
CampaignId | 您想要探索可能行銷活動預算商機的活動識別碼。 如果此元素為 nil 或空白,則作業會傳回帳戶的所有預算商機。 |
長 |
要求標頭元素
元素 | 說明 | 資料類型 |
---|---|---|
AuthenticationToken | OAuth 存取權杖,代表具有 Microsoft Advertising 帳戶許可權之使用者的認證。 如需詳細資訊,請 參閱使用 OAuth 進行驗證。 |
string |
CustomerAccountId | 擁有或與要求中實體相關聯之廣告帳戶的識別碼。 當兩者都需要時,此標頭元素必須具有與 AccountId body 元素相同的值。 此元素是大部分服務作業的必要專案,最佳做法是一律加以設定。 如需詳細資訊, 請參閱取得您的帳戶和客戶識別碼。 |
string |
CustomerId | (使用者存取或操作之使用者) 客戶的管理員帳戶識別碼。 使用者可以存取多個管理員帳戶。 此元素是大部分服務作業的必要專案,最佳做法是一律加以設定。 如需詳細資訊, 請參閱取得您的帳戶和客戶識別碼。 |
string |
DeveloperToken | 用來存取 Bing 廣告 API 的開發人員權杖。 如需詳細資訊 ,請參閱取得開發人員權杖。 |
string |
密碼 | 此元素會保留供內部使用,並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定使用者認證。 | string |
UserName | 此元素會保留供內部使用,並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定使用者認證。 | string |
Response 元素
GetBudgetOpportunitiesResponse物件會定義服務作業回應的主體和標頭元素。 這些元素的傳回順序與 回應 SOAP中所示的順序相同。
回應本文專案
元素 | 說明 | 資料類型 |
---|---|---|
機會 | BudgetOpportunity資料物件的陣列,可識別如果您要套用建議預算,其點擊次數和曝光數可能會增加的活動。 此清單不會包含目前由使用者暫停的活動機會。 目前最多可以傳回 1,000 個清單專案,但限制可能會變更。 |
BudgetOpportunity 陣列 |
回應標頭元素
元素 | 說明 | 資料類型 |
---|---|---|
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">GetBudgetOpportunities</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>
<GetBudgetOpportunitiesRequest xmlns="https://bingads.microsoft.com/AdInsight/v13">
<CampaignId i:nil="false">ValueHere</CampaignId>
</GetBudgetOpportunitiesRequest>
</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>
<GetBudgetOpportunitiesResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
<Opportunities d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<BudgetOpportunity>
<BudgetPoints d4p1:nil="false">
<BudgetPoint>
<BudgetAmount>ValueHere</BudgetAmount>
<BudgetPointType>ValueHere</BudgetPointType>
<EstimatedWeeklyClicks>ValueHere</EstimatedWeeklyClicks>
<EstimatedWeeklyCost>ValueHere</EstimatedWeeklyCost>
<EstimatedWeeklyImpressions>ValueHere</EstimatedWeeklyImpressions>
</BudgetPoint>
</BudgetPoints>
<BudgetType>ValueHere</BudgetType>
<CampaignId>ValueHere</CampaignId>
<CurrentBudget>ValueHere</CurrentBudget>
<IncreaseInClicks>ValueHere</IncreaseInClicks>
<IncreaseInImpressions>ValueHere</IncreaseInImpressions>
<PercentageIncreaseInClicks>ValueHere</PercentageIncreaseInClicks>
<PercentageIncreaseInImpressions>ValueHere</PercentageIncreaseInImpressions>
<RecommendedBudget>ValueHere</RecommendedBudget>
</BudgetOpportunity>
</Opportunities>
</GetBudgetOpportunitiesResponse>
</s:Body>
</s:Envelope>
程式碼語法
範例語法可以與 Bing 廣告 SDK搭配使用。 如需更多範例,請參閱 Bing 廣告 API 程式碼范 例。
public async Task<GetBudgetOpportunitiesResponse> GetBudgetOpportunitiesAsync(
long? campaignId)
{
var request = new GetBudgetOpportunitiesRequest
{
CampaignId = campaignId
};
return (await AdInsightService.CallAsync((s, r) => s.GetBudgetOpportunitiesAsync(r), request));
}
static GetBudgetOpportunitiesResponse getBudgetOpportunities(
java.lang.Long campaignId) throws RemoteException, Exception
{
GetBudgetOpportunitiesRequest request = new GetBudgetOpportunitiesRequest();
request.setCampaignId(campaignId);
return AdInsightService.getService().getBudgetOpportunities(request);
}
static function GetBudgetOpportunities(
$campaignId)
{
$GLOBALS['Proxy'] = $GLOBALS['AdInsightProxy'];
$request = new GetBudgetOpportunitiesRequest();
$request->CampaignId = $campaignId;
return $GLOBALS['AdInsightProxy']->GetService()->GetBudgetOpportunities($request);
}
response=adinsight_service.GetBudgetOpportunities(
CampaignId=CampaignId)
需求
服務: AdInsightService.svc v13
命名 空間: https://bingads.microsoft.com/AdInsight/v13