Operação de Serviço GetConversionGoalsByIds – Gestão de Campanhas
Obtém os objetivos de conversão especificados.
Sugestão
Para obter uma descrição geral da implementação, veja o Guia técnico do Controlo de Eventos Universal .
Elementos do Pedido
O objeto GetConversionGoalsByIdsRequest 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 |
|---|---|---|
| ConversionGoalIds | Um máximo de 100 identificadores dos objetivos de conversão que pretende obter. Se ConversionGoalIds for nulo ou estiver vazio, está efetivamente a pedir todos os objetivos de conversão dos tipos especificados para a conta. |
matriz longa |
| ConversionGoalTypes | O tipo de objetivos de conversão a devolver. Pode incluir múltiplos valores como sinalizadores. A forma como especifica vários sinalizadores depende da linguagem de programação que utiliza. Por exemplo, C# trata estes valores como valores de sinalizador e Java trata-os como uma matriz de cadeias. O SOAP deve incluir uma cadeia que contém uma lista delimitada por espaço de valores, por exemplo, <ConversionGoalTypes>Url Duration</ConversionGoalTypes>. |
ConversionGoalType |
| ReturnAdditionalFields | A lista de propriedades adicionais que pretende incluir dentro de cada objetivo de conversão 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. |
ConversionGoalAdditionalField |
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 GetConversionGoalsByIdsResponse 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 |
|---|---|---|
| ConversionGoals | Uma matriz de objetos ConversionGoal que corresponde diretamente aos identificadores de objetivos de conversão que especificou no pedido. Os itens da matriz podem ser devolvidos como nulos. Para cada índice de matriz onde não foi obtido um objetivo de conversão, o elemento correspondente será nulo. | Matriz ConversionGoal |
| 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">GetConversionGoalsByIds</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>
<GetConversionGoalsByIdsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<ConversionGoalIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</ConversionGoalIds>
<ConversionGoalTypes>ValueHere</ConversionGoalTypes>
<ReturnAdditionalFields i:nil="false">ValueHere</ReturnAdditionalFields>
</GetConversionGoalsByIdsRequest>
</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>
<GetConversionGoalsByIdsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<ConversionGoals d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<ConversionGoal d4p1:type="-- derived type specified here with the appropriate prefix --">
<AttributionModelType d4p1:nil="false">ValueHere</AttributionModelType>
<ConversionWindowInMinutes d4p1:nil="false">ValueHere</ConversionWindowInMinutes>
<CountType d4p1:nil="false">ValueHere</CountType>
<ExcludeFromBidding d4p1:nil="false">ValueHere</ExcludeFromBidding>
<GoalCategory d4p1:nil="false">ValueHere</GoalCategory>
<Id d4p1:nil="false">ValueHere</Id>
<IsEnhancedConversionsEnabled d4p1:nil="false">ValueHere</IsEnhancedConversionsEnabled>
<Name d4p1:nil="false">ValueHere</Name>
<Revenue d4p1:nil="false">
<CurrencyCode d4p1:nil="false">ValueHere</CurrencyCode>
<Type d4p1:nil="false">ValueHere</Type>
<Value d4p1:nil="false">ValueHere</Value>
</Revenue>
<Scope d4p1:nil="false">ValueHere</Scope>
<Status d4p1:nil="false">ValueHere</Status>
<TagId d4p1:nil="false">ValueHere</TagId>
<TrackingStatus d4p1:nil="false">ValueHere</TrackingStatus>
<Type d4p1:nil="false">ValueHere</Type>
<ViewThroughConversionWindowInMinutes d4p1:nil="false">ValueHere</ViewThroughConversionWindowInMinutes>
<!--These fields are applicable if the derived type attribute is set to UrlGoal-->
<UrlExpression d4p1:nil="false">ValueHere</UrlExpression>
<UrlOperator d4p1:nil="false">ValueHere</UrlOperator>
<!--This field is applicable if the derived type attribute is set to DurationGoal-->
<MinimumDurationInSeconds d4p1:nil="false">ValueHere</MinimumDurationInSeconds>
<!--This field is applicable if the derived type attribute is set to PagesViewedPerVisitGoal-->
<MinimumPagesViewed d4p1:nil="false">ValueHere</MinimumPagesViewed>
<!--These fields are applicable if the derived type attribute is set to EventGoal-->
<ActionExpression d4p1:nil="false">ValueHere</ActionExpression>
<ActionOperator d4p1:nil="false">ValueHere</ActionOperator>
<CategoryExpression d4p1:nil="false">ValueHere</CategoryExpression>
<CategoryOperator d4p1:nil="false">ValueHere</CategoryOperator>
<LabelExpression d4p1:nil="false">ValueHere</LabelExpression>
<LabelOperator d4p1:nil="false">ValueHere</LabelOperator>
<Value d4p1:nil="false">ValueHere</Value>
<ValueOperator d4p1:nil="false">ValueHere</ValueOperator>
<!--These fields are applicable if the derived type attribute is set to AppInstallGoal-->
<AppPlatform d4p1:nil="false">ValueHere</AppPlatform>
<AppStoreId d4p1:nil="false">ValueHere</AppStoreId>
<!--This field is applicable if the derived type attribute is set to OfflineConversionGoal-->
<IsExternallyAttributed d4p1:nil="false">ValueHere</IsExternallyAttributed>
<!--No additional fields are applicable if the derived type attribute is set to InStoreTransactionGoal-->
</ConversionGoal>
</ConversionGoals>
<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:e139="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e139:KeyValuePairOfstringstring>
<e139:key d4p1:nil="false">ValueHere</e139:key>
<e139:value d4p1:nil="false">ValueHere</e139:value>
</e139: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>
</GetConversionGoalsByIdsResponse>
</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<GetConversionGoalsByIdsResponse> GetConversionGoalsByIdsAsync(
IList<long> conversionGoalIds,
ConversionGoalType conversionGoalTypes,
ConversionGoalAdditionalField? returnAdditionalFields)
{
var request = new GetConversionGoalsByIdsRequest
{
ConversionGoalIds = conversionGoalIds,
ConversionGoalTypes = conversionGoalTypes,
ReturnAdditionalFields = returnAdditionalFields
};
return (await CampaignManagementService.CallAsync((s, r) => s.GetConversionGoalsByIdsAsync(r), request));
}
static GetConversionGoalsByIdsResponse getConversionGoalsByIds(
ArrayOflong conversionGoalIds,
ArrayList<ConversionGoalType> conversionGoalTypes,
ArrayList<ConversionGoalAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
GetConversionGoalsByIdsRequest request = new GetConversionGoalsByIdsRequest();
request.setConversionGoalIds(conversionGoalIds);
request.setConversionGoalTypes(conversionGoalTypes);
request.setReturnAdditionalFields(returnAdditionalFields);
return CampaignManagementService.getService().getConversionGoalsByIds(request);
}
static function GetConversionGoalsByIds(
$conversionGoalIds,
$conversionGoalTypes,
$returnAdditionalFields)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new GetConversionGoalsByIdsRequest();
$request->ConversionGoalIds = $conversionGoalIds;
$request->ConversionGoalTypes = $conversionGoalTypes;
$request->ReturnAdditionalFields = $returnAdditionalFields;
return $GLOBALS['CampaignManagementProxy']->GetService()->GetConversionGoalsByIds($request);
}
response=campaignmanagement_service.GetConversionGoalsByIds(
ConversionGoalIds=ConversionGoalIds,
ConversionGoalTypes=ConversionGoalTypes,
ReturnAdditionalFields=ReturnAdditionalFields)
Requisitos
Serviço: CampaignManagementService.svc v13
Espaço de nomes: https://bingads.microsoft.com/CampaignManagement/v13
Comentários
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulte https://aka.ms/ContentUserFeedback.
Enviar e exibir comentários de