GetAdGroupsByIds Hizmeti İşlemi - Kampanya Yönetimi
Belirtilen kampanya içinde belirtilen reklam gruplarını alır.
İstek Öğeleri
GetAdGroupsByIdsRequest 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ü |
|---|---|---|
| AdGroupIds | Alınacak reklam gruplarının en fazla 1.000 tanımlayıcısı. | uzun dizi |
| CampaignId | Alınacak reklam gruplarını içeren kampanyanın tanımlayıcısı. | Uzun |
| ReturnAdditionalFields | Döndürülen her reklam grubuna 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. |
AdGroupAdditionalField |
İ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
GetAdGroupsByIdsResponse 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ü |
|---|---|---|
| AdGroups | İstekte belirttiğiniz reklam grubu tanımlayıcılarına doğrudan karşılık gelen reklam gruplarının listesi. Listedeki öğeler null olarak döndürülebilir. Bir reklam grubunun alınmadığı her liste dizini için ilgili öğe null olur. | AdGroup dizisi |
| PartialErrors | Başarılı olmayan tüm istek öğelerinin ayrıntılarını içeren toplu iş hatalarının listesi. Hata listesi doğrudan istekteki öğe listesine karşılık gelir. Hata yoksa liste boş olabilir veya istekteki başarısız liste öğelerine karşılık gelen bir veya daha fazla hata nesnesi içerebilir. |
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">GetAdGroupsByIds</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>
<GetAdGroupsByIdsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<CampaignId>ValueHere</CampaignId>
<AdGroupIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</AdGroupIds>
<ReturnAdditionalFields i:nil="false">ValueHere</ReturnAdditionalFields>
</GetAdGroupsByIdsRequest>
</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>
<GetAdGroupsByIdsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<AdGroups d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<AdGroup>
<AdRotation d4p1:nil="false">
<EndDate d4p1:nil="false">ValueHere</EndDate>
<StartDate d4p1:nil="false">ValueHere</StartDate>
<Type d4p1:nil="false">ValueHere</Type>
</AdRotation>
<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>
<CommissionRate d4p1:nil="false">
<RateAmount d4p1:nil="false">
<Amount d4p1:nil="false">ValueHere</Amount>
</RateAmount>
</CommissionRate>
<CpcBid d4p1:nil="false">
<Amount d4p1:nil="false">ValueHere</Amount>
</CpcBid>
<EndDate d4p1:nil="false">
<Day>ValueHere</Day>
<Month>ValueHere</Month>
<Year>ValueHere</Year>
</EndDate>
<FinalUrlSuffix d4p1:nil="false">ValueHere</FinalUrlSuffix>
<ForwardCompatibilityMap xmlns:e108="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e108:KeyValuePairOfstringstring>
<e108:key d4p1:nil="false">ValueHere</e108:key>
<e108:value d4p1:nil="false">ValueHere</e108:value>
</e108:KeyValuePairOfstringstring>
</ForwardCompatibilityMap>
<FrequencyCapSettings d4p1:nil="false">
<FrequencyCapSettings>
<CapValue>ValueHere</CapValue>
<TimeGranularity>ValueHere</TimeGranularity>
</FrequencyCapSettings>
</FrequencyCapSettings>
<Id d4p1:nil="false">ValueHere</Id>
<Language d4p1:nil="false">ValueHere</Language>
<MultimediaAdsBidAdjustment d4p1:nil="false">ValueHere</MultimediaAdsBidAdjustment>
<Name d4p1:nil="false">ValueHere</Name>
<Network d4p1:nil="false">ValueHere</Network>
<PercentCpcBid d4p1:nil="false">
<RateAmount d4p1:nil="false">
<Amount d4p1:nil="false">ValueHere</Amount>
</RateAmount>
</PercentCpcBid>
<PrivacyStatus d4p1:nil="false">ValueHere</PrivacyStatus>
<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:e109="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e109:ArrayOfKeyValuePairOfstringstring>
<e109:KeyValuePairOfstringstring>
<e109:key d4p1:nil="false">ValueHere</e109:key>
<e109:value d4p1:nil="false">ValueHere</e109:value>
</e109:KeyValuePairOfstringstring>
</e109: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>
<StartDate d4p1:nil="false">
<Day>ValueHere</Day>
<Month>ValueHere</Month>
<Year>ValueHere</Year>
</StartDate>
<Status d4p1:nil="false">ValueHere</Status>
<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>
<UseOptimizedTargeting d4p1:nil="false">ValueHere</UseOptimizedTargeting>
<UsePredictiveTargeting d4p1:nil="false">ValueHere</UsePredictiveTargeting>
<AdScheduleUseSearcherTimeZone d4p1:nil="false">ValueHere</AdScheduleUseSearcherTimeZone>
<AdGroupType d4p1:nil="false">ValueHere</AdGroupType>
<CpvBid d4p1:nil="false">
<Amount d4p1:nil="false">ValueHere</Amount>
</CpvBid>
<CpmBid d4p1:nil="false">
<Amount d4p1:nil="false">ValueHere</Amount>
</CpmBid>
<McpaBid d4p1:nil="false">
<Amount d4p1:nil="false">ValueHere</Amount>
</McpaBid>
</AdGroup>
</AdGroups>
<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:e110="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e110:KeyValuePairOfstringstring>
<e110:key d4p1:nil="false">ValueHere</e110:key>
<e110:value d4p1:nil="false">ValueHere</e110:value>
</e110: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>
</GetAdGroupsByIdsResponse>
</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<GetAdGroupsByIdsResponse> GetAdGroupsByIdsAsync(
long campaignId,
IList<long> adGroupIds,
AdGroupAdditionalField? returnAdditionalFields)
{
var request = new GetAdGroupsByIdsRequest
{
CampaignId = campaignId,
AdGroupIds = adGroupIds,
ReturnAdditionalFields = returnAdditionalFields
};
return (await CampaignManagementService.CallAsync((s, r) => s.GetAdGroupsByIdsAsync(r), request));
}
static GetAdGroupsByIdsResponse getAdGroupsByIds(
java.lang.Long campaignId,
ArrayOflong adGroupIds,
ArrayList<AdGroupAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
GetAdGroupsByIdsRequest request = new GetAdGroupsByIdsRequest();
request.setCampaignId(campaignId);
request.setAdGroupIds(adGroupIds);
request.setReturnAdditionalFields(returnAdditionalFields);
return CampaignManagementService.getService().getAdGroupsByIds(request);
}
static function GetAdGroupsByIds(
$campaignId,
$adGroupIds,
$returnAdditionalFields)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new GetAdGroupsByIdsRequest();
$request->CampaignId = $campaignId;
$request->AdGroupIds = $adGroupIds;
$request->ReturnAdditionalFields = $returnAdditionalFields;
return $GLOBALS['CampaignManagementProxy']->GetService()->GetAdGroupsByIds($request);
}
response=campaignmanagement_service.GetAdGroupsByIds(
CampaignId=CampaignId,
AdGroupIds=AdGroupIds,
ReturnAdditionalFields=ReturnAdditionalFields)
Gereksinimler
Hizmet: CampaignManagementService.svc v13
Ad alanı: https://bingads.microsoft.com/CampaignManagement/v13