Operação do Serviço GetAdGroupsByCampaignId – Gestão de Campanhas
Obtém os grupos de anúncios na campanha especificada.
Elementos do Pedido
O objeto GetAdGroupsByCampaignIdRequest define os elementos do corpo e do cabeçalho do pedido de operação do serviço. Os elementos têm de estar na mesma ordem mostrada no Pedido SOAP.
Nota
Salvo indicação em contrário abaixo, todos os elementos do pedido são necessários.
Elementos do Corpo do Pedido
| Elemento | Descrição | Tipo de Dados |
|---|---|---|
| CampaignId | O identificador da campanha que contém os grupos de anúncios a obter. | long |
| ReturnAdditionalFields | A lista de propriedades adicionais que pretende incluir em cada grupo de anúncios devolvido. Os valores de campo adicionais permitem-lhe obter as funcionalidades mais recentes com a versão atual da API de Gestão de Campanhas e, na próxima versão, os elementos correspondentes serão incluídos por predefinição. Este elemento de pedido é opcional. |
AdGroupAdditionalField |
Elementos do Cabeçalho do Pedido
| Elemento | Descrição | Tipo de Dados |
|---|---|---|
| AuthenticationToken | O token de acesso OAuth que representa as credenciais de um utilizador que tem permissões para contas do Microsoft Advertising. Para obter mais informações, veja Authentication with OAuth (Autenticação com OAuth). |
cadeia |
| CustomerAccountId | O identificador da conta de anúncio que detém ou está associada às entidades no pedido. Este elemento de cabeçalho tem de ter o mesmo valor que o elemento do corpo AccountId quando ambos são necessários. Este elemento é necessário para a maioria das operações de serviço e, como melhor prática, deve sempre defini-lo. Para obter mais informações, veja Obter a Sua Conta e IDs de Cliente. |
cadeia |
| CustomerId | O identificador da conta de gestor (cliente) a partir da qual o utilizador está a aceder ou a operar. Um utilizador pode ter acesso a várias contas de gestor. Este elemento é necessário para a maioria das operações de serviço e, como melhor prática, deve sempre defini-lo. Para obter mais informações, veja Obter a Sua Conta e IDs de Cliente. |
cadeia |
| DeveloperToken | O token de programador utilizado para aceder à API de Anúncios do Bing. Para obter mais informações, veja Obter um Token de Programador. |
cadeia |
| Palavra-passe | Este elemento está reservado para utilização interna e será removido de uma versão futura da API. Tem de utilizar o elemento AuthenticationToken para definir credenciais de utilizador. | cadeia |
| Nome de Utilizador | Este elemento está reservado para utilização interna e será removido de uma versão futura da API. Tem de utilizar o elemento AuthenticationToken para definir credenciais de utilizador. | cadeia |
Elementos de Resposta
O objeto GetAdGroupsByCampaignIdResponse define os elementos do corpo e do cabeçalho da resposta da operação do serviço. Os elementos são devolvidos pela mesma ordem mostrada no SOAP de Resposta.
Elementos do Corpo da Resposta
| Elemento | Descrição | Tipo de Dados |
|---|---|---|
| AdGroups | A lista de grupos de anúncios na campanha especificada. Se a campanha não contiver grupos de anúncios, é devolvida uma matriz vazia. | Matriz AdGroup |
Elementos do Cabeçalho de Resposta
| Elemento | Descrição | Tipo de Dados |
|---|---|---|
| TrackingId | O identificador da entrada de registo que contém os detalhes da chamada à API. | cadeia |
Pedir SOAP
Este modelo foi gerado por uma ferramenta para mostrar a ordem dos elementos do corpo e do cabeçalho do pedido SOAP. Para tipos suportados que pode utilizar com esta operação de serviço, veja a referência Request Body Elements (Elementos do Corpo do Pedido ) acima.
<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">GetAdGroupsByCampaignId</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>
<GetAdGroupsByCampaignIdRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<CampaignId>ValueHere</CampaignId>
<ReturnAdditionalFields i:nil="false">ValueHere</ReturnAdditionalFields>
</GetAdGroupsByCampaignIdRequest>
</s:Body>
</s:Envelope>
Soap de Resposta
Este modelo foi gerado por uma ferramenta para mostrar a ordem dos elementos do corpo e do cabeçalho para a resposta 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>
<GetAdGroupsByCampaignIdResponse 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:e106="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e106:KeyValuePairOfstringstring>
<e106:key d4p1:nil="false">ValueHere</e106:key>
<e106:value d4p1:nil="false">ValueHere</e106:value>
</e106: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:e107="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e107:ArrayOfKeyValuePairOfstringstring>
<e107:KeyValuePairOfstringstring>
<e107:key d4p1:nil="false">ValueHere</e107:key>
<e107:value d4p1:nil="false">ValueHere</e107:value>
</e107:KeyValuePairOfstringstring>
</e107: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>
</GetAdGroupsByCampaignIdResponse>
</s:Body>
</s:Envelope>
Sintaxe de Código
A sintaxe de exemplo pode ser utilizada com os SDKs de Anúncios do Bing. Veja Exemplos de Código da API de Anúncios do Bing para obter mais exemplos.
public async Task<GetAdGroupsByCampaignIdResponse> GetAdGroupsByCampaignIdAsync(
long campaignId,
AdGroupAdditionalField? returnAdditionalFields)
{
var request = new GetAdGroupsByCampaignIdRequest
{
CampaignId = campaignId,
ReturnAdditionalFields = returnAdditionalFields
};
return (await CampaignManagementService.CallAsync((s, r) => s.GetAdGroupsByCampaignIdAsync(r), request));
}
static GetAdGroupsByCampaignIdResponse getAdGroupsByCampaignId(
java.lang.Long campaignId,
ArrayList<AdGroupAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
GetAdGroupsByCampaignIdRequest request = new GetAdGroupsByCampaignIdRequest();
request.setCampaignId(campaignId);
request.setReturnAdditionalFields(returnAdditionalFields);
return CampaignManagementService.getService().getAdGroupsByCampaignId(request);
}
static function GetAdGroupsByCampaignId(
$campaignId,
$returnAdditionalFields)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new GetAdGroupsByCampaignIdRequest();
$request->CampaignId = $campaignId;
$request->ReturnAdditionalFields = $returnAdditionalFields;
return $GLOBALS['CampaignManagementProxy']->GetService()->GetAdGroupsByCampaignId($request);
}
response=campaignmanagement_service.GetAdGroupsByCampaignId(
CampaignId=CampaignId,
ReturnAdditionalFields=ReturnAdditionalFields)
Requisitos
Serviço: CampaignManagementService.svc v13
Espaço de nomes: https://bingads.microsoft.com/CampaignManagement/v13