Partilhar via

Operação de Serviço ApplyOfflineConversions – Gestão de Campanhas

  • Artigo

Aplica conversões offline para a conta com o ID de Clique da Microsoft entre outros dados de conversão offline.

Nota

Se precisar de carregar muitas conversões offline num curto período de tempo, recomendamos que carregue o máximo possível em cada pedido. Pode carregar 1000 conversões offline por pedido.

Digamos que um cliente vê o seu anúncio, clica no mesmo, mas acaba por ligar-lhe, o que leva a uma venda que foi colocada offline. Como pode controlar quando o seu anúncio de pesquisa leva a uma conversão offline e fora do seu site? Pode importar conversões offline para medir melhor o que acontece depois de clicar no seu anúncio.

Depois de criar um OfflineConversionGoal, terá de aguardar duas horas antes de enviar o Microsoft Advertising para quaisquer conversões offline. Se não esperar duas horas, os dados de conversão offline poderão não ser aplicados. Depois de enviar o Microsoft Advertising para as conversões offline, pode demorar até seis horas a ver os dados de conversão.

Cada conversão offline pode ser dividida em vários IDs de clique. No entanto, um ID de clique único pode ser associado a vários objetivos de conversão e também ser associado ao mesmo objetivo várias vezes, desde que o tempo de conversão seja diferente. Além disso, a mesma conversão não pode ser importada mais do que uma vez. Se for tentada mais do que uma, a primeira instância será utilizada e as outras serão ignoradas.

O valor da conversão pode ser incluído no ficheiro de importação juntamente com uma moeda personalizada. Se não for indicada nenhuma moeda, será utilizada a predefinição do objetivo de conversão.

Para obter mais informações, veja Controlar conversões offline.

Elementos do Pedido

O objeto ApplyOfflineConversionsRequest 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
OfflineConversions A lista de conversões offline para a conta.

Pode adicionar um máximo de 1000 conversões offline por pedido de serviço.

Cada conversão offline pode ser dividida em vários IDs de clique. No entanto, um ID de clique único pode ser associado a vários objetivos de conversão e também ser associado ao mesmo objetivo várias vezes, desde que o tempo de conversão seja diferente. Além disso, a mesma conversão não pode ser aplicada mais do que uma vez. Se enviar duplicados do Microsoft Advertising, a primeira instância será utilizada e as outras serão ignoradas.		 Matriz OfflineConversion

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 ApplyOfflineConversionsResponse 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
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">ApplyOfflineConversions</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>
    <ApplyOfflineConversionsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <OfflineConversions i:nil="false">
        <OfflineConversion>
          <ConversionCurrencyCode i:nil="false">ValueHere</ConversionCurrencyCode>
          <ConversionName i:nil="false">ValueHere</ConversionName>
          <ConversionTime>ValueHere</ConversionTime>
          <ConversionValue i:nil="false">ValueHere</ConversionValue>
          <ExternalAttributionCredit i:nil="false">ValueHere</ExternalAttributionCredit>
          <ExternalAttributionModel i:nil="false">ValueHere</ExternalAttributionModel>
          <HashedEmailAddress i:nil="false">ValueHere</HashedEmailAddress>
          <HashedPhoneNumber i:nil="false">ValueHere</HashedPhoneNumber>
          <MicrosoftClickId i:nil="false">ValueHere</MicrosoftClickId>
        </OfflineConversion>
      </OfflineConversions>
    </ApplyOfflineConversionsRequest>
  </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>
    <ApplyOfflineConversionsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <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:e287="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e287:KeyValuePairOfstringstring>
              <e287:key d4p1:nil="false">ValueHere</e287:key>
              <e287:value d4p1:nil="false">ValueHere</e287:value>
            </e287: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>
    </ApplyOfflineConversionsResponse>
  </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<ApplyOfflineConversionsResponse> ApplyOfflineConversionsAsync(
	IList<OfflineConversion> offlineConversions)
{
	var request = new ApplyOfflineConversionsRequest
	{
		OfflineConversions = offlineConversions
	};

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

static ApplyOfflineConversionsResponse applyOfflineConversions(
	ArrayOfOfflineConversion offlineConversions) throws RemoteException, Exception
{
	ApplyOfflineConversionsRequest request = new ApplyOfflineConversionsRequest();

	request.setOfflineConversions(offlineConversions);

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

static function ApplyOfflineConversions(
	$offlineConversions)
{

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

	$request = new ApplyOfflineConversionsRequest();

	$request->OfflineConversions = $offlineConversions;

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

response=campaignmanagement_service.ApplyOfflineConversions(
	OfflineConversions=OfflineConversions)

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/OfflineConversions/Apply

Elementos do Pedido

O objeto ApplyOfflineConversionsRequest 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
OfflineConversions A lista de conversões offline para a conta.

Pode adicionar um máximo de 1000 conversões offline por pedido de serviço.

Cada conversão offline pode ser dividida em vários IDs de clique. No entanto, um ID de clique único pode ser associado a vários objetivos de conversão e também ser associado ao mesmo objetivo várias vezes, desde que o tempo de conversão seja diferente. Além disso, a mesma conversão não pode ser aplicada mais do que uma vez. Se enviar duplicados do Microsoft Advertising, a primeira instância será utilizada e as outras serão ignoradas.		 Matriz OfflineConversion

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 ApplyOfflineConversionsResponse 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
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.

{
  "OfflineConversions": [
    {
      "ConversionCurrencyCode": "ValueHere",
      "ConversionName": "ValueHere",
      "ConversionTime": "ValueHere",
      "ConversionValue": DoubleValueHere,
      "ExternalAttributionCredit": DoubleValueHere,
      "ExternalAttributionModel": "ValueHere",
      "HashedEmailAddress": "ValueHere",
      "HashedPhoneNumber": "ValueHere",
      "MicrosoftClickId": "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.

{
  "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<ApplyOfflineConversionsResponse> ApplyOfflineConversionsAsync(
	IList<OfflineConversion> offlineConversions)
{
	var request = new ApplyOfflineConversionsRequest
	{
		OfflineConversions = offlineConversions
	};

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

static ApplyOfflineConversionsResponse applyOfflineConversions(
	ArrayOfOfflineConversion offlineConversions) throws RemoteException, Exception
{
	ApplyOfflineConversionsRequest request = new ApplyOfflineConversionsRequest();

	request.setOfflineConversions(offlineConversions);

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

static function ApplyOfflineConversions(
	$offlineConversions)
{

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

	$request = new ApplyOfflineConversionsRequest();

	$request->OfflineConversions = $offlineConversions;

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

response=campaignmanagement_service.ApplyOfflineConversions(
	OfflineConversions=OfflineConversions)