GetCampaignsByIds 服務作業 - 活動管理
取得帳戶內的指定行銷活動。
要求專案
GetCampaignsByIdsRequest物件會定義服務作業要求的主體和標頭元素。 元素的順序必須與 要求 SOAP中所示的順序相同。
注意事項
除非下面另有說明，否則所有要求專案都是必要的。
要求本文專案
| 元素 | 說明 | 資料類型 |
|---|---|---|
| AccountId | 包含要取得之行銷活動的帳戶識別碼。 | 長 |
| CampaignIds | 從指定的帳號取得的活動最多 100 個識別碼。 識別碼必須對應至指定 CampaignType 或類型的活動，否則服務會傳回錯誤碼 EntityIdFilterMismatch (Code 516) 。 |
long 陣列 |
| CampaignType | 要取得的活動類型，例如 搜尋、 購物或 DynamicSearchAds。 此要求專案是選擇性的。 如果您未設定任何行銷活動類型，預設值為 搜尋 ，也就是只會傳回搜尋活動。 您可以將多個值包含為旗標。 指定多個旗標的方式取決於您使用的程式設計語言。 例如，C# 會將這些值視為旗標值，而 JAVA 會將它們視為字串陣列。 SOAP 應該包含字串，其中包含以空格分隔的值清單， <CampaignType>Search Shopping</CampaignType> 例如 。 |
CampaignType |
| ReturnAdditionalFields | 您想要包含在每個傳回行銷活動中的其他屬性清單。 其他域值可讓您使用目前版本的行銷活動管理 API 取得最新功能，而在下一個版本中，預設會包含對應的元素。 此要求專案是選擇性的。 |
CampaignAdditionalField |
要求標頭元素
| 元素 | 說明 | 資料類型 |
|---|---|---|
| AuthenticationToken | OAuth 存取權杖，代表具有 Microsoft Advertising 帳戶許可權之使用者的認證。 如需詳細資訊，請 參閱使用 OAuth 進行驗證。 |
string |
| CustomerAccountId | 擁有或與要求中實體相關聯之廣告帳戶的識別碼。 當兩者都需要時，此標頭元素必須具有與 AccountId body 元素相同的值。 此元素是大部分服務作業的必要專案，最佳做法是一律加以設定。 如需詳細資訊， 請參閱取得您的帳戶和客戶識別碼。 |
string |
| CustomerId | (使用者存取或操作之使用者) 客戶的管理員帳戶識別碼。 使用者可以存取多個管理員帳戶。 此元素是大部分服務作業的必要專案，最佳做法是一律加以設定。 如需詳細資訊， 請參閱取得您的帳戶和客戶識別碼。 |
string |
| DeveloperToken | 用來存取 Bing 廣告 API 的開發人員權杖。 如需詳細資訊 ，請參閱取得開發人員權杖。 |
string |
| 密碼 | 此元素會保留供內部使用，並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定使用者認證。 | string |
| UserName | 此元素會保留供內部使用，並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定使用者認證。 | string |
Response 元素
GetCampaignsByIdsResponse物件會定義服務作業回應的主體和標頭元素。 這些元素的傳回順序與 回應 SOAP中所示的順序相同。
回應本文專案
| 元素 | 說明 | 資料類型 |
|---|---|---|
| 活動 | Campaign物件的陣列，直接對應至您在要求中指定的行銷活動識別碼。 清單的專案可能會傳回為 Null。 對於未擷取行銷活動的每個清單索引，對應的專案會是 Null。 | 行銷活動 陣列 |
| PartialErrors |
BatchError物件的陣列，其中包含未成功擷取之任何活動的詳細資料。 錯誤清單會直接對應至要求中的行銷活動清單。 清單的專案可能會傳回為 Null。 針對成功擷取行銷活動的每個清單索引，對應的錯誤專案會是 Null。 理想情況下，會成功擷取所有活動，而且此清單中的所有元素都是 Null。 |
BatchError 數 組 |
回應標頭元素
| 元素 | 說明 | 資料類型 |
|---|---|---|
| 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/CampaignManagement/v13">
<Action mustUnderstand="1">GetCampaignsByIds</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>
<GetCampaignsByIdsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<AccountId>ValueHere</AccountId>
<CampaignIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</CampaignIds>
<CampaignType>ValueHere</CampaignType>
<ReturnAdditionalFields i:nil="false">ValueHere</ReturnAdditionalFields>
</GetCampaignsByIdsRequest>
</s:Body>
</s:Envelope>
回應 SOAP
此範本是由工具所產生，用來顯示 SOAP 回應的 主體 和 標頭 元素順序。
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<TrackingId d3p1:nil="false" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</TrackingId>
</s:Header>
<s:Body>
<GetCampaignsByIdsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<Campaigns d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<Campaign>
<AudienceAdsBidAdjustment d4p1:nil="false">ValueHere</AudienceAdsBidAdjustment>
<BiddingScheme d4p1:nil="false" d4p1:type="-- derived type specified here with the appropriate prefix --">
<Type d4p1:nil="false">ValueHere</Type>
<!--This field is applicable if the derived type attribute is set to MaxClicksBiddingScheme-->
<MaxCpc d4p1:nil="false">
<Amount d4p1:nil="false">ValueHere</Amount>
</MaxCpc>
<!--These fields are applicable if the derived type attribute is set to MaxConversionsBiddingScheme-->
<MaxCpc d4p1:nil="false">
<Amount d4p1:nil="false">ValueHere</Amount>
</MaxCpc>
<TargetCpa d4p1:nil="false">ValueHere</TargetCpa>
<!--These fields are applicable if the derived type attribute is set to TargetCpaBiddingScheme-->
<MaxCpc d4p1:nil="false">
<Amount d4p1:nil="false">ValueHere</Amount>
</MaxCpc>
<TargetCpa d4p1:nil="false">ValueHere</TargetCpa>
<!--No additional fields are applicable if the derived type attribute is set to ManualCpcBiddingScheme-->
<!--No additional fields are applicable if the derived type attribute is set to EnhancedCpcBiddingScheme-->
<!--No additional fields are applicable if the derived type attribute is set to ManualCpvBiddingScheme-->
<!--No additional fields are applicable if the derived type attribute is set to ManualCpmBiddingScheme-->
<!--This field is applicable if the derived type attribute is set to InheritFromParentBiddingScheme-->
<InheritedBidStrategyType d4p1:nil="false">ValueHere</InheritedBidStrategyType>
<!--These fields are applicable if the derived type attribute is set to TargetRoasBiddingScheme-->
<MaxCpc d4p1:nil="false">
<Amount d4p1:nil="false">ValueHere</Amount>
</MaxCpc>
<TargetRoas d4p1:nil="false">ValueHere</TargetRoas>
<!--This field is applicable if the derived type attribute is set to MaxRoasBiddingScheme-->
<MaxCpc d4p1:nil="false">
<Amount d4p1:nil="false">ValueHere</Amount>
</MaxCpc>
<!--This field is applicable if the derived type attribute is set to MaxConversionValueBiddingScheme-->
<TargetRoas d4p1:nil="false">ValueHere</TargetRoas>
<!--These fields are applicable if the derived type attribute is set to TargetImpressionShareBiddingScheme-->
<MaxCpc d4p1:nil="false">
<Amount d4p1:nil="false">ValueHere</Amount>
</MaxCpc>
<TargetAdPosition d4p1:nil="false">ValueHere</TargetAdPosition>
<TargetImpressionShare d4p1:nil="false">ValueHere</TargetImpressionShare>
<!--This field is applicable if the derived type attribute is set to PercentCpcBiddingScheme-->
<MaxPercentCpc d4p1:nil="false">ValueHere</MaxPercentCpc>
<!--This field is applicable if the derived type attribute is set to CommissionBiddingScheme-->
<CommissionRate d4p1:nil="false">ValueHere</CommissionRate>
<!--This field is applicable if the derived type attribute is set to ManualCpaBiddingScheme-->
<ManualCpi d4p1:nil="false">ValueHere</ManualCpi>
<!--This field is applicable if the derived type attribute is set to CostPerSaleBiddingScheme-->
<TargetCostPerSale d4p1:nil="false">ValueHere</TargetCostPerSale>
</BiddingScheme>
<BudgetType d4p1:nil="false">ValueHere</BudgetType>
<DailyBudget d4p1:nil="false">ValueHere</DailyBudget>
<DealIds d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</DealIds>
<ExperimentId d4p1:nil="false">ValueHere</ExperimentId>
<FinalUrlSuffix d4p1:nil="false">ValueHere</FinalUrlSuffix>
<ForwardCompatibilityMap xmlns:e136="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e136:KeyValuePairOfstringstring>
<e136:key d4p1:nil="false">ValueHere</e136:key>
<e136:value d4p1:nil="false">ValueHere</e136:value>
</e136:KeyValuePairOfstringstring>
</ForwardCompatibilityMap>
<GoalIds d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</GoalIds>
<Id d4p1:nil="false">ValueHere</Id>
<IsDealCampaign d4p1:nil="false">ValueHere</IsDealCampaign>
<MultimediaAdsBidAdjustment d4p1:nil="false">ValueHere</MultimediaAdsBidAdjustment>
<Name d4p1:nil="false">ValueHere</Name>
<Status d4p1:nil="false">ValueHere</Status>
<SubType d4p1:nil="false">ValueHere</SubType>
<TimeZone d4p1:nil="false">ValueHere</TimeZone>
<TrackingUrlTemplate d4p1:nil="false">ValueHere</TrackingUrlTemplate>
<UrlCustomParameters d4p1:nil="false">
<Parameters d4p1:nil="false">
<CustomParameter>
<Key d4p1:nil="false">ValueHere</Key>
<Value d4p1:nil="false">ValueHere</Value>
</CustomParameter>
</Parameters>
</UrlCustomParameters>
<CampaignType d4p1:nil="false">ValueHere</CampaignType>
<Settings d4p1:nil="false">
<Setting d4p1:type="-- derived type specified here with the appropriate prefix --">
<Type d4p1:nil="false">ValueHere</Type>
<!--This field is applicable if the derived type attribute is set to VerifiedTrackingSetting-->
<Details xmlns:e137="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e137:ArrayOfKeyValuePairOfstringstring>
<e137:KeyValuePairOfstringstring>
<e137:key d4p1:nil="false">ValueHere</e137:key>
<e137:value d4p1:nil="false">ValueHere</e137:value>
</e137:KeyValuePairOfstringstring>
</e137:ArrayOfKeyValuePairOfstringstring>
</Details>
<!--These fields are applicable if the derived type attribute is set to ShoppingSetting-->
<FeedLabel d4p1:nil="false">ValueHere</FeedLabel>
<LocalInventoryAdsEnabled d4p1:nil="false">ValueHere</LocalInventoryAdsEnabled>
<Priority d4p1:nil="false">ValueHere</Priority>
<SalesCountryCode d4p1:nil="false">ValueHere</SalesCountryCode>
<ShoppableAdsEnabled d4p1:nil="false">ValueHere</ShoppableAdsEnabled>
<StoreId d4p1:nil="false">ValueHere</StoreId>
<!--This field is applicable if the derived type attribute is set to DynamicFeedSetting-->
<FeedId d4p1:nil="false">ValueHere</FeedId>
<!--These fields are applicable if the derived type attribute is set to DynamicSearchAdsSetting-->
<DomainName d4p1:nil="false">ValueHere</DomainName>
<DynamicDescriptionEnabled d4p1:nil="false">ValueHere</DynamicDescriptionEnabled>
<Language d4p1:nil="false">ValueHere</Language>
<PageFeedIds d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</PageFeedIds>
<Source d4p1:nil="false">ValueHere</Source>
<!--This field is applicable if the derived type attribute is set to TargetSetting-->
<Details d4p1:nil="false">
<TargetSettingDetail>
<CriterionTypeGroup>ValueHere</CriterionTypeGroup>
<TargetAndBid>ValueHere</TargetAndBid>
</TargetSettingDetail>
</Details>
<!--These fields are applicable if the derived type attribute is set to CoOpSetting-->
<BidBoostValue d4p1:nil="false">ValueHere</BidBoostValue>
<BidMaxValue d4p1:nil="false">ValueHere</BidMaxValue>
<BidOption d4p1:nil="false">ValueHere</BidOption>
<!--This field is applicable if the derived type attribute is set to DisclaimerSetting-->
<DisclaimerAdsEnabled>ValueHere</DisclaimerAdsEnabled>
<!--This field is applicable if the derived type attribute is set to HotelSetting-->
<HotelAdGroupType>ValueHere</HotelAdGroupType>
<!--This field is applicable if the derived type attribute is set to ResponsiveSearchAdsSetting-->
<AutoGeneratedAssetsEnabled d4p1:nil="false">ValueHere</AutoGeneratedAssetsEnabled>
<!--These fields are applicable if the derived type attribute is set to PerformanceMaxSetting-->
<AutoGeneratedImageOptOut d4p1:nil="false">ValueHere</AutoGeneratedImageOptOut>
<AutoGeneratedTextOptOut d4p1:nil="false">ValueHere</AutoGeneratedTextOptOut>
<CostPerSaleOptOut d4p1:nil="false">ValueHere</CostPerSaleOptOut>
<FinalUrlExpansionOptOut>ValueHere</FinalUrlExpansionOptOut>
<PageFeedIds d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</PageFeedIds>
<!--These fields are applicable if the derived type attribute is set to CallToActionSetting-->
<AutomatedCallToActionOptOut d4p1:nil="false">ValueHere</AutomatedCallToActionOptOut>
<CallToActionOptOut d4p1:nil="false">ValueHere</CallToActionOptOut>
<!--These fields are applicable if the derived type attribute is set to VanityPharmaSetting-->
<DisplayUrlMode d4p1:nil="false">ValueHere</DisplayUrlMode>
<WebsiteDescription d4p1:nil="false">ValueHere</WebsiteDescription>
<!--These fields are applicable if the derived type attribute is set to AppSetting-->
<AppId d4p1:nil="false">ValueHere</AppId>
<AppStore>ValueHere</AppStore>
</Setting>
</Settings>
<BudgetId d4p1:nil="false">ValueHere</BudgetId>
<Languages d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:string>ValueHere</a1:string>
</Languages>
<AdScheduleUseSearcherTimeZone d4p1:nil="false">ValueHere</AdScheduleUseSearcherTimeZone>
<BidStrategyId d4p1:nil="false">ValueHere</BidStrategyId>
</Campaign>
</Campaigns>
<PartialErrors d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<BatchError d4p1:type="-- derived type specified here with the appropriate prefix --">
<Code>ValueHere</Code>
<Details d4p1:nil="false">ValueHere</Details>
<ErrorCode d4p1:nil="false">ValueHere</ErrorCode>
<FieldPath d4p1:nil="false">ValueHere</FieldPath>
<ForwardCompatibilityMap xmlns:e138="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e138:KeyValuePairOfstringstring>
<e138:key d4p1:nil="false">ValueHere</e138:key>
<e138:value d4p1:nil="false">ValueHere</e138:value>
</e138:KeyValuePairOfstringstring>
</ForwardCompatibilityMap>
<Index>ValueHere</Index>
<Message d4p1:nil="false">ValueHere</Message>
<Type d4p1:nil="false">ValueHere</Type>
<!--These fields are applicable if the derived type attribute is set to EditorialError-->
<Appealable d4p1:nil="false">ValueHere</Appealable>
<DisapprovedText d4p1:nil="false">ValueHere</DisapprovedText>
<Location d4p1:nil="false">ValueHere</Location>
<PublisherCountry d4p1:nil="false">ValueHere</PublisherCountry>
<ReasonCode>ValueHere</ReasonCode>
</BatchError>
</PartialErrors>
</GetCampaignsByIdsResponse>
</s:Body>
</s:Envelope>
程式碼語法
範例語法可以與 Bing 廣告 SDK搭配使用。 如需更多範例，請參閱 Bing 廣告 API 程式碼范 例。
public async Task<GetCampaignsByIdsResponse> GetCampaignsByIdsAsync(
long accountId,
IList<long> campaignIds,
CampaignType campaignType,
CampaignAdditionalField? returnAdditionalFields)
{
var request = new GetCampaignsByIdsRequest
{
AccountId = accountId,
CampaignIds = campaignIds,
CampaignType = campaignType,
ReturnAdditionalFields = returnAdditionalFields
};
return (await CampaignManagementService.CallAsync((s, r) => s.GetCampaignsByIdsAsync(r), request));
}
static GetCampaignsByIdsResponse getCampaignsByIds(
java.lang.Long accountId,
ArrayOflong campaignIds,
ArrayList<CampaignType> campaignType,
ArrayList<CampaignAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
GetCampaignsByIdsRequest request = new GetCampaignsByIdsRequest();
request.setAccountId(accountId);
request.setCampaignIds(campaignIds);
request.setCampaignType(campaignType);
request.setReturnAdditionalFields(returnAdditionalFields);
return CampaignManagementService.getService().getCampaignsByIds(request);
}
static function GetCampaignsByIds(
$accountId,
$campaignIds,
$campaignType,
$returnAdditionalFields)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new GetCampaignsByIdsRequest();
$request->AccountId = $accountId;
$request->CampaignIds = $campaignIds;
$request->CampaignType = $campaignType;
$request->ReturnAdditionalFields = $returnAdditionalFields;
return $GLOBALS['CampaignManagementProxy']->GetService()->GetCampaignsByIds($request);
}
response=campaignmanagement_service.GetCampaignsByIds(
AccountId=AccountId,
CampaignIds=CampaignIds,
CampaignType=CampaignType,
ReturnAdditionalFields=ReturnAdditionalFields)
需求
服務： CampaignManagementService.svc v13
命名 空間： https://bingads.microsoft.com/CampaignManagement/v13