Conversion

O recurso de conversão tem métodos que permitem aos usuários criar, modificar e recuperar conversões do Floodlight em massa. 

Para ver uma lista de métodos desse recurso, consulte o final desta página.

Representações de recursos

Uma lista de conversões.

{
  "kind": "doubleclicksearch#conversionList",
  "conversion": [
    {
      "agencyId": long,
      "advertiserId": long,
      "engineAccountId": long,
      "campaignId": long,
      "customerId": string,
      "adGroupId": long,
      "criterionId": long,
      "adId": long,
      "clickId": string,
      "dsConversionId": long,
      "conversionId": string,
      "state": string,
      "type": string,
      "revenueMicros": long,
      "currencyCode": string,
      "quantityMillis": long,
      "segmentationType": string,
      "segmentationId": long,
      "segmentationName": string,
      "conversionTimestamp": unsigned long,
      "conversionModifiedTimestamp": unsigned long,
      "floodlightOrderId": string,
      "customMetric": [
        {
          "name": string,
          "value": double
        }
      ],
      "customDimension": [
        {
          "name": string,
          "value": string
        }
      ],
      "countMillis": long,
      "attributionModel": string,
      "productGroupId": long,
      "inventoryAccountId": long,
      "productId": string,
      "productCountry": string,
      "productLanguage": string,
      "channel": string,
      "storeId": string,
      "deviceType": string,
      "adUserDataConsent": string,
      "sessionAttributesEncoded": bytes
    }
  ]
}
Nome da propriedade Valor Descrição Observações
conversion[] list As conversões que estão sendo solicitadas.
conversion[].adGroupId long ID do grupo de anúncios do DS.
conversion[].adId long ID do anúncio do DS.
conversion[].adUserDataConsent string Representa o consentimento para preferências dos serviços essenciais de plataforma (CPS, na sigla em inglês) nas configurações. Nenhum valor padrão. Os valores aceitáveis são: GRANTED: o status de consentimento desejado é "conceder". Leia as preferências do CPS nas configurações do GTE. NEGADO: o status de consentimento desejado é "negar"; a lista de CPS está vazia.

Os valores aceitáveis são:
  • "DENIED"
  • "GRANTED"
  • "UNKNOWN"
conversion[].advertiserId long ID do anunciante do DS.
conversion[].agencyId long ID da agência do DS.
conversion[].attributionModel string Disponível para anunciantes somente após entrar em contato com o suporte ao cliente do DoubleClick Search.
conversion[].campaignId long ID da campanha do DS.
conversion[].channel string Canal de vendas do produto. Os valores aceitáveis são:
  • "local": uma loja física
  • "online": uma loja on-line
conversion[].clickId string ID de clique do DSA para a conversão.
conversion[].conversionId string Para conversões off-line, os anunciantes fornecem esse ID. Os anunciantes podem especificar qualquer ID que seja relevante para eles. Cada conversão em uma solicitação precisa especificar um ID exclusivo, e a combinação de ID e carimbo de data/hora precisa ser única entre todas as conversões do anunciante.
Para conversões on-line, o DSA copia a dsConversionId ou a floodlightOrderId para essa propriedade, dependendo das instruções do Floodlight do anunciante.
conversion[].conversionModifiedTimestamp unsigned long A hora em que a conversão foi modificada pela última vez, em milissegundos da época UTC.
conversion[].conversionTimestamp unsigned long A hora em que a conversão ocorreu, em milissegundos da época UTC.
conversion[].countMillis long Disponível para anunciantes somente após entrar em contato com o suporte ao cliente do DoubleClick Search.
conversion[].criterionId long ID do critério (palavra-chave) do DS.
conversion[].currencyCode string O código da moeda da receita da conversão. Precisa estar no formato alfabético (três caracteres) do ISO 4217. gravável
conversion[].customDimension[] list Dimensões personalizadas para a conversão, que podem ser usadas para filtrar dados em um relatório.
conversion[].customDimension[].name string Nome da dimensão personalizada.
conversion[].customDimension[].value string Valor da dimensão personalizada.
conversion[].customMetric[] list Métricas personalizadas para a conversão.
conversion[].customMetric[].name string Nome da métrica personalizada.
conversion[].customMetric[].value double Valor numérico da métrica personalizada.
conversion[].customerId string Novo ID do cliente do Search Ads 360. Precisa ser uma conta de cliente. Quando esse campo é definido, todos os outros campos de ID precisam ser definidos como novos IDs do Search Ads 360.
conversion[].deviceType string O tipo de dispositivo em que a conversão ocorreu.

Os valores aceitáveis são:
  • "DESKTOP"
  • "HIGH_END_MOBILE"
  • "OTHER_DEVICE"
  • "TABLET"
conversion[].dsConversionId long ID gerado pelo DoubleClick Search para cada conversão.
conversion[].engineAccountId long ID da conta de mecanismo do DS.
conversion[].floodlightOrderId string O ID do pedido do Floodlight fornecido pelo anunciante para a conversão.
conversion[].inventoryAccountId long ID gerado e usado pelo DS para identificar exclusivamente a conta de inventário que contém o produto.
conversion[].productCountry string O país registrado no feed do Google Merchant Center que contém o produto. Use um código ISO 3166 para especificar um país.
conversion[].productGroupId long ID do grupo de produtos do DS.
conversion[].productId string O ID do produto (SKU).
conversion[].productLanguage string O idioma registrado no feed do Google Merchant Center que contém o produto. Use um código ISO 639 para especificar um idioma.
conversion[].quantityMillis long A quantidade dessa conversão, em milissegundos. gravável
conversion[].revenueMicros long O valor da receita dessa conversão TRANSACTION, em micros (valor multiplicado por 1000000, sem decimais). Por exemplo, para especificar um valor de receita de "10", insira "10000000" (10 milhões) na solicitação. gravável
conversion[].segmentationId long O identificador de segmentação numérica (por exemplo, o ID da atividade do Floodlight na Pesquisa do DoubleClick).
conversion[].segmentationName string O identificador de segmentação amigável (por exemplo, nome da atividade do Floodlight da Pesquisa do DoubleClick).
conversion[].segmentationType string O tipo de segmentação dessa conversão (por exemplo, FLOODLIGHT).

Os valores aceitáveis são:
  • "FLOODLIGHT"
conversion[].sessionAttributesEncoded bytes Os atributos de sessão do evento, representados como uma string JSON codificada em base64. O conteúdo precisa ser gerado pela biblioteca fornecida pelo Google.
conversion[].state string O estado da conversão, ou seja, ACTIVE ou REMOVED. Observação: o estado DELETED foi descontinuado.

Os valores aceitáveis são:
  • "ACTIVE"
  • "DELETED": descontinuado
  • "REMOVED"
 gravável
conversion[].storeId string O ID da loja local para que o produto foi anunciado. Aplicável apenas quando o canal é "local".
conversion[].type string O tipo da conversão, ou seja, ACTION ou TRANSACTION. Uma conversão ACTION é uma ação do usuário que não tem valor monetário quantificável, enquanto uma conversão TRANSACTION é uma ação que tem um valor monetário quantificável. Exemplos são inscrições em listas de e-mail (ACTION) e compras de e-commerce (TRANSACTION).

Os valores aceitáveis são:
  • "ACTION"
  • "TRANSACTION"
kind string Identifica isso como um recurso da ConversionList. Valor: a string fixa doubleclicksearch#conversionList.

Métodos

get
Recupera uma lista de conversões de uma conta de mecanismo do DoubleClick Search.
getByCustomerId
Retorna uma lista de conversões de uma conta de mecanismo do DoubleClick Search usando um novo ID de cliente do Search Ads 360.
inserir
Insere um lote de novas conversões no DoubleClick Search.
update
Atualiza um lote de conversões no DoubleClick Search.
updateAvailability
Atualiza as disponibilidades de um lote de atividades do Floodlight no DoubleClick Search.