GetCampaignsByIds Hizmeti İşlemi - Kampanya Yönetimi
Belirtilen kampanyaları bir hesap içinde alır.
İstek Öğeleri
GetCampaignsByIdsRequest 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ü |
|---|---|---|
| AccountId | Alınacak kampanyaları içeren hesabın tanımlayıcısı. | Uzun |
| CampaignId'ler | Belirtilen hesaptan alınacak kampanyaların en fazla 100 tanımlayıcısı. Tanımlayıcıların belirtilen CampaignType veya türlerdeki kampanyalara karşılık olması gerekir ve aksi takdirde hizmet EntityIdFilterMismatch (Kod 516) hata kodu döndürür. |
uzun dizi |
| CampaignType | Alınacak kampanyaların türü( örneğin Arama, Alışveriş veya DynamicSearchAds). Bu istek öğesi isteğe bağlıdır. Herhangi bir kampanya türü ayarlamazsanız varsayılan değer Arama'dır ; örneğin, yalnızca Arama kampanyaları döndürülür. Bayrak olarak birden çok değer ekleyebilirsiniz. Birden çok bayrağı nasıl belirttiğiniz, kullandığınız programlama diline bağlıdır. Örneğin, C# bu değerleri bayrak değerleri olarak değerlendirir ve Java bunları bir dize dizisi olarak değerlendirir. SOAP, boşlukla ayrılmış bir değer listesi içeren bir dize içermelidir. Örneğin, <CampaignType>Search Shopping</CampaignType>. |
CampaignType |
| ReturnAdditionalFields | Döndürülen her kampanyaya eklenmesini istediğiniz ek özelliklerin listesi. Ek alan değerleri, Kampanya Yönetimi 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. |
CampaignAdditionalField |
İ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
GetCampaignsByIdsResponse 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ü |
|---|---|---|
| Kampanya | İstekte belirttiğiniz kampanya tanımlayıcılarına doğrudan karşılık gelen bir dizi Campaign nesnesi. Listedeki öğeler null olarak döndürülebilir. Kampanyanın alınmadığı her liste dizini için ilgili öğe null olur. | Kampanya dizisi |
| PartialErrors | Başarılı bir şekilde alınmayan tüm kampanyaların ayrıntılarını içeren batcherror nesneleri dizisi. Hata listesi doğrudan istekteki kampanyaların listesine karşılık gelir. Listedeki öğeler null olarak döndürülebilir. Bir kampanyanın başarıyla alındığı her liste dizini için ilgili hata öğesi null olur. İdeal olarak tüm kampanyalar başarıyla alınır ve bu listedeki tüm öğeler null olur. |
BatchError dizisi |
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/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>
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/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>
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<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)
Gereksinimler
Hizmet: CampaignManagementService.svc v13
Ad alanı: https://bingads.microsoft.com/CampaignManagement/v13