Operação de Serviço AddAdGroups - Gestão de Campanhas
Adiciona novos grupos de anúncios a uma campanha especificada.
Elementos do Pedido
O objeto AddAdGroupsRequest 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 |
|---|---|---|
| AdGroups | Uma matriz de objetos do AdGroup para adicionar à campanha especificada. Pode adicionar um máximo de 1000 grupos de anúncios numa única chamada. Cada campanha pode ter até 20 000 grupos de anúncios. |
Matriz AdGroup |
| CampaignId | O identificador da campanha à qual adicionar os grupos de anúncios. | long |
| ReturnInheritedBidStrategyTypes | Reservado para utilização futura. | booleano |
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 AddAdGroupsResponse 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 |
|---|---|---|
| AdGroupIds | Uma lista de identificadores de sistema exclusivos correspondentes aos grupos de anúncios que foram adicionados. A lista de identificadores corresponde diretamente à lista de grupos de anúncios no pedido. Os itens da lista podem ser devolvidos como nulos. Para cada índice de lista onde não foi adicionado um grupo de anúncios, o elemento correspondente será nulo. |
matriz longa |
| InheritedBidStrategyTypes | Reservado para utilização futura. | matriz de cadeia |
| PartialErrors | Uma matriz de objetos BatchError que contêm detalhes para quaisquer itens de pedido que não tenham sido bem-sucedidos. A lista de erros não corresponde diretamente à lista de itens no pedido. A lista pode estar vazia se não existirem erros ou pode incluir um ou mais objetos de erro correspondentes a cada item de lista sem êxito no pedido. |
Matriz BatchError |
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">AddAdGroups</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>
<AddAdGroupsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<CampaignId>ValueHere</CampaignId>
<AdGroups i:nil="false">
<AdGroup>
<AdRotation i:nil="false">
<EndDate i:nil="false">ValueHere</EndDate>
<StartDate i:nil="false">ValueHere</StartDate>
<Type i:nil="false">ValueHere</Type>
</AdRotation>
<AudienceAdsBidAdjustment i:nil="false">ValueHere</AudienceAdsBidAdjustment>
<BiddingScheme i:nil="false" i:type="-- derived type specified here with the appropriate prefix --">
<Type i:nil="false">ValueHere</Type>
<!--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 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 i:nil="false">ValueHere</InheritedBidStrategyType>
<!--This field is applicable if the derived type attribute is set to PercentCpcBiddingScheme-->
<MaxPercentCpc i:nil="false">ValueHere</MaxPercentCpc>
<!--This field is applicable if the derived type attribute is set to CommissionBiddingScheme-->
<CommissionRate i:nil="false">ValueHere</CommissionRate>
<!--This field is applicable if the derived type attribute is set to ManualCpaBiddingScheme-->
<ManualCpi i:nil="false">ValueHere</ManualCpi>
<!--This field is applicable if the derived type attribute is set to CostPerSaleBiddingScheme-->
<TargetCostPerSale i:nil="false">ValueHere</TargetCostPerSale>
</BiddingScheme>
<CommissionRate i:nil="false">
<RateAmount i:nil="false">
<Amount i:nil="false">ValueHere</Amount>
</RateAmount>
</CommissionRate>
<CpcBid i:nil="false">
<Amount i:nil="false">ValueHere</Amount>
</CpcBid>
<EndDate i:nil="false">
<Day>ValueHere</Day>
<Month>ValueHere</Month>
<Year>ValueHere</Year>
</EndDate>
<FinalUrlSuffix i:nil="false">ValueHere</FinalUrlSuffix>
<ForwardCompatibilityMap xmlns:e24="http://schemas.datacontract.org/2004/07/System.Collections.Generic" i:nil="false">
<e24:KeyValuePairOfstringstring>
<e24:key i:nil="false">ValueHere</e24:key>
<e24:value i:nil="false">ValueHere</e24:value>
</e24:KeyValuePairOfstringstring>
</ForwardCompatibilityMap>
<FrequencyCapSettings i:nil="false">
<FrequencyCapSettings>
<CapValue>ValueHere</CapValue>
<TimeGranularity>ValueHere</TimeGranularity>
</FrequencyCapSettings>
</FrequencyCapSettings>
<Id i:nil="false">ValueHere</Id>
<Language i:nil="false">ValueHere</Language>
<MultimediaAdsBidAdjustment i:nil="false">ValueHere</MultimediaAdsBidAdjustment>
<Name i:nil="false">ValueHere</Name>
<Network i:nil="false">ValueHere</Network>
<PercentCpcBid i:nil="false">
<RateAmount i:nil="false">
<Amount i:nil="false">ValueHere</Amount>
</RateAmount>
</PercentCpcBid>
<PrivacyStatus i:nil="false">ValueHere</PrivacyStatus>
<Settings i:nil="false">
<Setting i:type="-- derived type specified here with the appropriate prefix --">
<Type i:nil="false">ValueHere</Type>
<!--This field is applicable if the derived type attribute is set to VerifiedTrackingSetting-->
<Details xmlns:e25="http://schemas.datacontract.org/2004/07/System.Collections.Generic" i:nil="false">
<e25:ArrayOfKeyValuePairOfstringstring>
<e25:KeyValuePairOfstringstring>
<e25:key i:nil="false">ValueHere</e25:key>
<e25:value i:nil="false">ValueHere</e25:value>
</e25:KeyValuePairOfstringstring>
</e25:ArrayOfKeyValuePairOfstringstring>
</Details>
<!--This field is applicable if the derived type attribute is set to DynamicFeedSetting-->
<FeedId i:nil="false">ValueHere</FeedId>
<!--This field is applicable if the derived type attribute is set to TargetSetting-->
<Details i: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 i:nil="false">ValueHere</BidBoostValue>
<BidMaxValue i:nil="false">ValueHere</BidMaxValue>
<BidOption i: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 i:nil="false">ValueHere</AutoGeneratedAssetsEnabled>
<!--These fields are applicable if the derived type attribute is set to PerformanceMaxSetting-->
<AutoGeneratedImageOptOut i:nil="false">ValueHere</AutoGeneratedImageOptOut>
<AutoGeneratedTextOptOut i:nil="false">ValueHere</AutoGeneratedTextOptOut>
<CostPerSaleOptOut i:nil="false">ValueHere</CostPerSaleOptOut>
<FinalUrlExpansionOptOut>ValueHere</FinalUrlExpansionOptOut>
<PageFeedIds i: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 i:nil="false">ValueHere</AutomatedCallToActionOptOut>
<CallToActionOptOut i:nil="false">ValueHere</CallToActionOptOut>
<!--These fields are applicable if the derived type attribute is set to VanityPharmaSetting-->
<DisplayUrlMode i:nil="false">ValueHere</DisplayUrlMode>
<WebsiteDescription i:nil="false">ValueHere</WebsiteDescription>
<!--These fields are applicable if the derived type attribute is set to AppSetting-->
<AppId i:nil="false">ValueHere</AppId>
<AppStore>ValueHere</AppStore>
</Setting>
</Settings>
<StartDate i:nil="false">
<Day>ValueHere</Day>
<Month>ValueHere</Month>
<Year>ValueHere</Year>
</StartDate>
<Status i:nil="false">ValueHere</Status>
<TrackingUrlTemplate i:nil="false">ValueHere</TrackingUrlTemplate>
<UrlCustomParameters i:nil="false">
<Parameters i:nil="false">
<CustomParameter>
<Key i:nil="false">ValueHere</Key>
<Value i:nil="false">ValueHere</Value>
</CustomParameter>
</Parameters>
</UrlCustomParameters>
<UseOptimizedTargeting i:nil="false">ValueHere</UseOptimizedTargeting>
<UsePredictiveTargeting i:nil="false">ValueHere</UsePredictiveTargeting>
<AdScheduleUseSearcherTimeZone i:nil="false">ValueHere</AdScheduleUseSearcherTimeZone>
<AdGroupType i:nil="false">ValueHere</AdGroupType>
<CpvBid i:nil="false">
<Amount i:nil="false">ValueHere</Amount>
</CpvBid>
<CpmBid i:nil="false">
<Amount i:nil="false">ValueHere</Amount>
</CpmBid>
<McpaBid i:nil="false">
<Amount i:nil="false">ValueHere</Amount>
</McpaBid>
</AdGroup>
</AdGroups>
<ReturnInheritedBidStrategyTypes i:nil="false">ValueHere</ReturnInheritedBidStrategyTypes>
</AddAdGroupsRequest>
</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>
<AddAdGroupsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<AdGroupIds d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<a1:long>ValueHere</a1:long>
</AdGroupIds>
<InheritedBidStrategyTypes d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<a1:string>ValueHere</a1:string>
</InheritedBidStrategyTypes>
<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:e26="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e26:KeyValuePairOfstringstring>
<e26:key d4p1:nil="false">ValueHere</e26:key>
<e26:value d4p1:nil="false">ValueHere</e26:value>
</e26: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>
</AddAdGroupsResponse>
</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<AddAdGroupsResponse> AddAdGroupsAsync(
long campaignId,
IList<AdGroup> adGroups,
bool? returnInheritedBidStrategyTypes)
{
var request = new AddAdGroupsRequest
{
CampaignId = campaignId,
AdGroups = adGroups,
ReturnInheritedBidStrategyTypes = returnInheritedBidStrategyTypes
};
return (await CampaignManagementService.CallAsync((s, r) => s.AddAdGroupsAsync(r), request));
}
static AddAdGroupsResponse addAdGroups(
java.lang.Long campaignId,
ArrayOfAdGroup adGroups,
boolean returnInheritedBidStrategyTypes) throws RemoteException, Exception
{
AddAdGroupsRequest request = new AddAdGroupsRequest();
request.setCampaignId(campaignId);
request.setAdGroups(adGroups);
request.setReturnInheritedBidStrategyTypes(returnInheritedBidStrategyTypes);
return CampaignManagementService.getService().addAdGroups(request);
}
static function AddAdGroups(
$campaignId,
$adGroups,
$returnInheritedBidStrategyTypes)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new AddAdGroupsRequest();
$request->CampaignId = $campaignId;
$request->AdGroups = $adGroups;
$request->ReturnInheritedBidStrategyTypes = $returnInheritedBidStrategyTypes;
return $GLOBALS['CampaignManagementProxy']->GetService()->AddAdGroups($request);
}
response=campaignmanagement_service.AddAdGroups(
CampaignId=CampaignId,
AdGroups=AdGroups,
ReturnInheritedBidStrategyTypes=ReturnInheritedBidStrategyTypes)
Requisitos
Serviço: CampaignManagementService.svc v13
Espaço de nomes: https://bingads.microsoft.com/CampaignManagement/v13