Partilhar via

AddConversionGoals Service Operation – Gestão de Campanhas

  • Artigo

Adiciona novos objetivos de conversão à biblioteca de objetivos de conversão partilhada da conta.

Importante

Sempre que adicionar ou atualizar uma nova DurationGoal, EventGoal, OfflineConversionGoal, PagesViewedPerVisitGoal ou UrlGoal através da aplicação Web Microsoft Advertising ou da API de Gestão de Campanhas, o valor MSCLKIDAutoTaggingEnabled da AccountProperty correspondente é definido como Verdadeiro automaticamente. Se o Âmbito do objetivo estiver definido como Ao nível do cliente , a Propriedade da Conta para todas as contas no Cliente será definida.

Nota

Para criar um objetivo de conversão melhorado e definir isEnhancedConversionsEnabled=trueo , tem de criar um objetivo de conversão para a conta através da IU do Microsoft Advertising com a definição de conversão melhorada selecionada e a caixa de verificação associada selecionada.

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 AddConversionGoalsRequest 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
ConversionGoals A lista de objetivos de conversão a adicionar à biblioteca de objetivos de conversão partilhada da conta.

Pode adicionar um máximo de 100 objetivos de conversão por pedido de serviço.

A conta é determinada pelo elemento de cabeçalho CustomerAccountId necessário.		 Matriz ConversionGoal

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 AddConversionGoalsResponse 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
ConversionGoalIds Uma lista de identificadores de sistema exclusivos correspondentes aos objetivos de conversão que foram adicionados.

A lista de identificadores corresponde diretamente à lista de objetivos de conversão no pedido. Os itens da lista podem ser devolvidos como nulos. Para cada índice de lista onde não foi adicionado um objetivo de conversão, o elemento correspondente será nulo.		 matriz longa
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">AddConversionGoals</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>
    <AddConversionGoalsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <ConversionGoals i:nil="false">
        <ConversionGoal i:type="-- derived type specified here with the appropriate prefix --">
          <AttributionModelType i:nil="false">ValueHere</AttributionModelType>
          <ConversionWindowInMinutes i:nil="false">ValueHere</ConversionWindowInMinutes>
          <CountType i:nil="false">ValueHere</CountType>
          <ExcludeFromBidding i:nil="false">ValueHere</ExcludeFromBidding>
          <GoalCategory i:nil="false">ValueHere</GoalCategory>
          <Id i:nil="false">ValueHere</Id>
          <IsEnhancedConversionsEnabled i:nil="false">ValueHere</IsEnhancedConversionsEnabled>
          <Name i:nil="false">ValueHere</Name>
          <Revenue i:nil="false">
            <CurrencyCode i:nil="false">ValueHere</CurrencyCode>
            <Type i:nil="false">ValueHere</Type>
            <Value i:nil="false">ValueHere</Value>
          </Revenue>
          <Scope i:nil="false">ValueHere</Scope>
          <Status i:nil="false">ValueHere</Status>
          <TagId i:nil="false">ValueHere</TagId>
          <TrackingStatus i:nil="false">ValueHere</TrackingStatus>
          <Type i:nil="false">ValueHere</Type>
          <ViewThroughConversionWindowInMinutes i:nil="false">ValueHere</ViewThroughConversionWindowInMinutes>
          <!--These fields are applicable if the derived type attribute is set to UrlGoal-->
          <UrlExpression i:nil="false">ValueHere</UrlExpression>
          <UrlOperator i:nil="false">ValueHere</UrlOperator>
          <!--This field is applicable if the derived type attribute is set to DurationGoal-->
          <MinimumDurationInSeconds i:nil="false">ValueHere</MinimumDurationInSeconds>
          <!--This field is applicable if the derived type attribute is set to PagesViewedPerVisitGoal-->
          <MinimumPagesViewed i:nil="false">ValueHere</MinimumPagesViewed>
          <!--These fields are applicable if the derived type attribute is set to EventGoal-->
          <ActionExpression i:nil="false">ValueHere</ActionExpression>
          <ActionOperator i:nil="false">ValueHere</ActionOperator>
          <CategoryExpression i:nil="false">ValueHere</CategoryExpression>
          <CategoryOperator i:nil="false">ValueHere</CategoryOperator>
          <LabelExpression i:nil="false">ValueHere</LabelExpression>
          <LabelOperator i:nil="false">ValueHere</LabelOperator>
          <Value i:nil="false">ValueHere</Value>
          <ValueOperator i:nil="false">ValueHere</ValueOperator>
          <!--These fields are applicable if the derived type attribute is set to AppInstallGoal-->
          <AppPlatform i:nil="false">ValueHere</AppPlatform>
          <AppStoreId i:nil="false">ValueHere</AppStoreId>
          <!--This field is applicable if the derived type attribute is set to OfflineConversionGoal-->
          <IsExternallyAttributed i:nil="false">ValueHere</IsExternallyAttributed>
          <!--No additional fields are applicable if the derived type attribute is set to InStoreTransactionGoal-->
        </ConversionGoal>
      </ConversionGoals>
    </AddConversionGoalsRequest>
  </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>
    <AddConversionGoalsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <ConversionGoalIds 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>
      </ConversionGoalIds>
      <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:e237="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e237:KeyValuePairOfstringstring>
              <e237:key d4p1:nil="false">ValueHere</e237:key>
              <e237:value d4p1:nil="false">ValueHere</e237:value>
            </e237: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>
    </AddConversionGoalsResponse>
  </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<AddConversionGoalsResponse> AddConversionGoalsAsync(
	IList<ConversionGoal> conversionGoals)
{
	var request = new AddConversionGoalsRequest
	{
		ConversionGoals = conversionGoals
	};

	return (await CampaignManagementService.CallAsync((s, r) => s.AddConversionGoalsAsync(r), request));
}

static AddConversionGoalsResponse addConversionGoals(
	ArrayOfConversionGoal conversionGoals) throws RemoteException, Exception
{
	AddConversionGoalsRequest request = new AddConversionGoalsRequest();

	request.setConversionGoals(conversionGoals);

	return CampaignManagementService.getService().addConversionGoals(request);
}

static function AddConversionGoals(
	$conversionGoals)
{

	$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];

	$request = new AddConversionGoalsRequest();

	$request->ConversionGoals = $conversionGoals;

	return $GLOBALS['CampaignManagementProxy']->GetService()->AddConversionGoals($request);
}

response=campaignmanagement_service.AddConversionGoals(
	ConversionGoals=ConversionGoals)

Requisitos

Serviço: CampaignManagementService.svc v13
Espaço de nomes: https://bingads.microsoft.com/CampaignManagement/v13

URL do Pedido

https://campaign.api.bingads.microsoft.com/CampaignManagement/v13/ConversionGoals

Elementos do Pedido

O objeto AddConversionGoalsRequest define os elementos do corpo e do cabeçalho do pedido de operação do serviço.

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
ConversionGoals A lista de objetivos de conversão a adicionar à biblioteca de objetivos de conversão partilhada da conta.

Pode adicionar um máximo de 100 objetivos de conversão por pedido de serviço.

A conta é determinada pelo elemento de cabeçalho CustomerAccountId necessário.		 Matriz ConversionGoal

Elementos do Cabeçalho do Pedido

Elemento Descrição Tipo de Dados
Autorização O token de acesso OAuth que representa as credenciais de um utilizador que tem permissões para contas do Microsoft Advertising. Certifique-se de que o token tem o prefixo "Portador", que é necessário para uma autenticação adequada.

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 AddConversionGoalsResponse 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 JSON de Resposta.

Elementos do Corpo da Resposta

Elemento Descrição Tipo de Dados
ConversionGoalIds Uma lista de identificadores de sistema exclusivos correspondentes aos objetivos de conversão que foram adicionados.

A lista de identificadores corresponde diretamente à lista de objetivos de conversão no pedido. Os itens da lista podem ser devolvidos como nulos. Para cada índice de lista onde não foi adicionado um objetivo de conversão, o elemento correspondente será nulo.		 matriz longa
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 JSON

Este modelo foi gerado por uma ferramenta para mostrar os elementos do corpo e do cabeçalho do pedido JSON. 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.

Segue-se um exemplo aplicável se o tipo de ConversionGoal for AppInstallGoal.

{
  "ConversionGoals": [
    {
      "AttributionModelType": "ValueHere",
      "ConversionWindowInMinutes": IntValueHere,
      "CountType": "ValueHere",
      "ExcludeFromBidding": "ValueHere",
      "GoalCategory": "ValueHere",
      "Id": "LongValueHere",
      "IsEnhancedConversionsEnabled": "ValueHere",
      "Name": "ValueHere",
      "Revenue": {
        "CurrencyCode": "ValueHere",
        "Type": "ValueHere",
        "Value": DecimalValueHere
      },
      "Scope": "ValueHere",
      "Status": "ValueHere",
      "TagId": "LongValueHere",
      "TrackingStatus": "ValueHere",
      "Type": "AppInstall",
      "ViewThroughConversionWindowInMinutes": IntValueHere,
      "AppPlatform": "ValueHere",
      "AppStoreId": "ValueHere"
    }
  ]
}

JSON de Resposta

Este modelo foi gerado por uma ferramenta para mostrar os elementos do corpo e do cabeçalho da resposta JSON.

Segue-se um exemplo aplicável se o tipo de BatchError for EditorialError.

{
  "ConversionGoalIds": [
    "LongValueHere"
  ],
  "PartialErrors": [
    {
      "Code": IntValueHere,
      "Details": "ValueHere",
      "ErrorCode": "ValueHere",
      "FieldPath": "ValueHere",
      "ForwardCompatibilityMap": [
        {
          "key": "ValueHere",
          "value": "ValueHere"
        }
      ],
      "Index": IntValueHere,
      "Message": "ValueHere",
      "Type": "EditorialError",
      "Appealable": "ValueHere",
      "DisapprovedText": "ValueHere",
      "Location": "ValueHere",
      "PublisherCountry": "ValueHere",
      "ReasonCode": IntValueHere
    }
  ]
}

Sintaxe de Código

Para chamar a API REST através de SDKs, tem de atualizar o SDK para uma determinada versão e configurar os parâmetros do sistema. 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<AddConversionGoalsResponse> AddConversionGoalsAsync(
	IList<ConversionGoal> conversionGoals)
{
	var request = new AddConversionGoalsRequest
	{
		ConversionGoals = conversionGoals
	};

	return (await CampaignManagementService.CallAsync((s, r) => s.AddConversionGoalsAsync(r), request));
}

static AddConversionGoalsResponse addConversionGoals(
	ArrayOfConversionGoal conversionGoals) throws RemoteException, Exception
{
	AddConversionGoalsRequest request = new AddConversionGoalsRequest();

	request.setConversionGoals(conversionGoals);

	return CampaignManagementService.getService().addConversionGoals(request);
}

static function AddConversionGoals(
	$conversionGoals)
{

	$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];

	$request = new AddConversionGoalsRequest();

	$request->ConversionGoals = $conversionGoals;

	return $GLOBALS['CampaignManagementProxy']->GetService()->AddConversionGoals($request);
}

response=campaignmanagement_service.AddConversionGoals(
	ConversionGoals=ConversionGoals)