Operação de Serviço GetCampaignCriterionsByIds – Gestão de Campanhas
Obtém os critérios de campanha especificados.
Elementos do Pedido
O objeto GetCampaignCriterionsByIdsRequest 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 |
|---|---|---|
| CampaignCriterionIds | Uma lista de identificadores exclusivos que identificam os critérios de campanha a obter. Pode incluir até 100 identificadores de critério de campanha por pedido. Se este elemento for nulo, todos os critérios para o CampaignId especificado serão obtidos. |
matriz longa |
| CampaignId | O identificador exclusivo da campanha cujos critérios pretende obter. | long |
| CriterionType | O tipo de critério a obter, por exemplo, página Web. Só pode especificar um tipo. O valor Targets não é permitido para esta operação. | CampaignCriterionType |
| ReturnAdditionalFields | A lista de propriedades adicionais que pretende incluir em cada critério de campanha 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. |
CriterionAdditionalField |
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 GetCampaignCriterionsByIdsResponse 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 |
|---|---|---|
| CampaignCriterions | A lista de critérios de campanha que correspondem diretamente aos identificadores especificados no pedido. Os itens da lista podem ser devolvidos como nulos. Para cada índice de lista onde não foi obtido um critério, o elemento correspondente será nulo. | Matriz CampaignCriterion |
| 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">GetCampaignCriterionsByIds</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>
<GetCampaignCriterionsByIdsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<CampaignCriterionIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</CampaignCriterionIds>
<CampaignId>ValueHere</CampaignId>
<CriterionType>ValueHere</CriterionType>
<ReturnAdditionalFields i:nil="false">ValueHere</ReturnAdditionalFields>
</GetCampaignCriterionsByIdsRequest>
</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>
<GetCampaignCriterionsByIdsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<CampaignCriterions d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<CampaignCriterion d4p1:type="-- derived type specified here with the appropriate prefix --">
<CampaignId>ValueHere</CampaignId>
<Criterion d4p1:nil="false" d4p1:type="-- derived type specified here with the appropriate prefix --">
<Type d4p1:nil="false">ValueHere</Type>
<!--These fields are applicable if the derived type attribute is set to ProductPartition-->
<Condition d4p1:nil="false">
<Attribute d4p1:nil="false">ValueHere</Attribute>
<Operand d4p1:nil="false">ValueHere</Operand>
<Operator d4p1:nil="false">ValueHere</Operator>
</Condition>
<ParentCriterionId d4p1:nil="false">ValueHere</ParentCriterionId>
<PartitionType>ValueHere</PartitionType>
<!--These fields are applicable if the derived type attribute is set to HotelGroup-->
<Listing d4p1:nil="false">
<Attribute d4p1:nil="false">ValueHere</Attribute>
<Operand d4p1:nil="false">ValueHere</Operand>
</Listing>
<ListingType>ValueHere</ListingType>
<ParentCriterionId d4p1:nil="false">ValueHere</ParentCriterionId>
<!--These fields are applicable if the derived type attribute is set to HotelAdvanceBookingWindowCriterion-->
<MaxDays d4p1:nil="false">ValueHere</MaxDays>
<MinDays d4p1:nil="false">ValueHere</MinDays>
<!--These fields are applicable if the derived type attribute is set to HotelCheckInDateCriterion-->
<EndDate d4p1:nil="false">ValueHere</EndDate>
<StartDate d4p1:nil="false">ValueHere</StartDate>
<!--This field is applicable if the derived type attribute is set to HotelCheckInDayCriterion-->
<CheckInDay d4p1:nil="false">ValueHere</CheckInDay>
<!--This field is applicable if the derived type attribute is set to HotelDateSelectionTypeCriterion-->
<HotelDateSelectionType d4p1:nil="false">ValueHere</HotelDateSelectionType>
<!--These fields are applicable if the derived type attribute is set to HotelLengthOfStayCriterion-->
<MaxNights d4p1:nil="false">ValueHere</MaxNights>
<MinNights d4p1:nil="false">ValueHere</MinNights>
<!--This field is applicable if the derived type attribute is set to ProductScope-->
<Conditions d4p1:nil="false">
<ProductCondition>
<Attribute d4p1:nil="false">ValueHere</Attribute>
<Operand d4p1:nil="false">ValueHere</Operand>
<Operator d4p1:nil="false">ValueHere</Operator>
</ProductCondition>
</Conditions>
<!--This field is applicable if the derived type attribute is set to Webpage-->
<Parameter d4p1:nil="false">
<Conditions d4p1:nil="false">
<WebpageCondition>
<Argument d4p1:nil="false">ValueHere</Argument>
<Operand>ValueHere</Operand>
<Operator d4p1:nil="false">ValueHere</Operator>
</WebpageCondition>
</Conditions>
<CriterionName d4p1:nil="false">ValueHere</CriterionName>
</Parameter>
<!--This field is applicable if the derived type attribute is set to AgeCriterion-->
<AgeRange d4p1:nil="false">ValueHere</AgeRange>
<!--These fields are applicable if the derived type attribute is set to DeviceCriterion-->
<DeviceName d4p1:nil="false">ValueHere</DeviceName>
<OSName d4p1:nil="false">ValueHere</OSName>
<!--These fields are applicable if the derived type attribute is set to DayTimeCriterion-->
<Day d4p1:nil="false">ValueHere</Day>
<FromHour d4p1:nil="false">ValueHere</FromHour>
<FromMinute d4p1:nil="false">ValueHere</FromMinute>
<ToHour d4p1:nil="false">ValueHere</ToHour>
<ToMinute d4p1:nil="false">ValueHere</ToMinute>
<!--This field is applicable if the derived type attribute is set to GenderCriterion-->
<GenderType d4p1:nil="false">ValueHere</GenderType>
<!--These fields are applicable if the derived type attribute is set to RadiusCriterion-->
<LatitudeDegrees d4p1:nil="false">ValueHere</LatitudeDegrees>
<LongitudeDegrees d4p1:nil="false">ValueHere</LongitudeDegrees>
<Name d4p1:nil="false">ValueHere</Name>
<Radius d4p1:nil="false">ValueHere</Radius>
<RadiusUnit d4p1:nil="false">ValueHere</RadiusUnit>
<!--These fields are applicable if the derived type attribute is set to LocationCriterion-->
<DisplayName d4p1:nil="false">ValueHere</DisplayName>
<EnclosedLocationIds d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</EnclosedLocationIds>
<LocationId d4p1:nil="false">ValueHere</LocationId>
<LocationType d4p1:nil="false">ValueHere</LocationType>
<!--This field is applicable if the derived type attribute is set to LocationIntentCriterion-->
<IntentOption d4p1:nil="false">ValueHere</IntentOption>
<!--These fields are applicable if the derived type attribute is set to AudienceCriterion-->
<AudienceId d4p1:nil="false">ValueHere</AudienceId>
<AudienceType d4p1:nil="false">ValueHere</AudienceType>
<!--These fields are applicable if the derived type attribute is set to ProfileCriterion-->
<ProfileId>ValueHere</ProfileId>
<ProfileType>ValueHere</ProfileType>
<!--This field is applicable if the derived type attribute is set to StoreCriterion-->
<StoreId d4p1:nil="false">ValueHere</StoreId>
<!--This field is applicable if the derived type attribute is set to DealCriterion-->
<DealId>ValueHere</DealId>
<!--This field is applicable if the derived type attribute is set to GenreCriterion-->
<GenreId>ValueHere</GenreId>
</Criterion>
<ForwardCompatibilityMap xmlns:e130="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e130:KeyValuePairOfstringstring>
<e130:key d4p1:nil="false">ValueHere</e130:key>
<e130:value d4p1:nil="false">ValueHere</e130:value>
</e130:KeyValuePairOfstringstring>
</ForwardCompatibilityMap>
<Id d4p1:nil="false">ValueHere</Id>
<Status d4p1:nil="false">ValueHere</Status>
<Type d4p1:nil="false">ValueHere</Type>
<!--No additional fields are applicable if the derived type attribute is set to NegativeCampaignCriterion-->
<!--These fields are applicable if the derived type attribute is set to BiddableCampaignCriterion-->
<CriterionBid 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 RateBid-->
<RateAmount d4p1:nil="false">
<Amount d4p1:nil="false">ValueHere</Amount>
</RateAmount>
<!--This field is applicable if the derived type attribute is set to FixedBid-->
<Amount>ValueHere</Amount>
<!--This field is applicable if the derived type attribute is set to BidMultiplier-->
<Multiplier>ValueHere</Multiplier>
</CriterionBid>
<CriterionCashback 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 CashbackAdjustment-->
<CashbackPercent d4p1:nil="false">ValueHere</CashbackPercent>
</CriterionCashback>
</CampaignCriterion>
</CampaignCriterions>
<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:e131="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e131:KeyValuePairOfstringstring>
<e131:key d4p1:nil="false">ValueHere</e131:key>
<e131:value d4p1:nil="false">ValueHere</e131:value>
</e131: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>
</GetCampaignCriterionsByIdsResponse>
</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<GetCampaignCriterionsByIdsResponse> GetCampaignCriterionsByIdsAsync(
IList<long> campaignCriterionIds,
long campaignId,
CampaignCriterionType criterionType,
CriterionAdditionalField? returnAdditionalFields)
{
var request = new GetCampaignCriterionsByIdsRequest
{
CampaignCriterionIds = campaignCriterionIds,
CampaignId = campaignId,
CriterionType = criterionType,
ReturnAdditionalFields = returnAdditionalFields
};
return (await CampaignManagementService.CallAsync((s, r) => s.GetCampaignCriterionsByIdsAsync(r), request));
}
static GetCampaignCriterionsByIdsResponse getCampaignCriterionsByIds(
ArrayOflong campaignCriterionIds,
java.lang.Long campaignId,
ArrayList<CampaignCriterionType> criterionType,
ArrayList<CriterionAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
GetCampaignCriterionsByIdsRequest request = new GetCampaignCriterionsByIdsRequest();
request.setCampaignCriterionIds(campaignCriterionIds);
request.setCampaignId(campaignId);
request.setCriterionType(criterionType);
request.setReturnAdditionalFields(returnAdditionalFields);
return CampaignManagementService.getService().getCampaignCriterionsByIds(request);
}
static function GetCampaignCriterionsByIds(
$campaignCriterionIds,
$campaignId,
$criterionType,
$returnAdditionalFields)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new GetCampaignCriterionsByIdsRequest();
$request->CampaignCriterionIds = $campaignCriterionIds;
$request->CampaignId = $campaignId;
$request->CriterionType = $criterionType;
$request->ReturnAdditionalFields = $returnAdditionalFields;
return $GLOBALS['CampaignManagementProxy']->GetService()->GetCampaignCriterionsByIds($request);
}
response=campaignmanagement_service.GetCampaignCriterionsByIds(
CampaignCriterionIds=CampaignCriterionIds,
CampaignId=CampaignId,
CriterionType=CriterionType,
ReturnAdditionalFields=ReturnAdditionalFields)
Requisitos
Serviço: CampaignManagementService.svc v13
Espaço de nomes: https://bingads.microsoft.com/CampaignManagement/v13