getVisitorValues

Última atualização em 2023-05-24
  • Tópicos
  • Identities
    Exibir mais informações sobre este tópico
  • Integrations
    Exibir mais informações sobre este tópico
  • Criado para:
  • Developer
    User
    Admin
    Leader

Esta é uma API assíncrona que retorna os identificadores para o Analytics, o serviço de ID, o cancelamento da coleta de dados, a localização geográfica e o conteúdo “blob” de metadados por padrão. Além disso, você pode controlar quais IDs deseja retornar com a enumeração opcional visitor.FIELDS.

Conteúdo:

Sintaxe

Essa função usa a seguinte sintaxe (itálico representa um espaço reservado para uma variável): var *valores* = visitor.getVisitorValues (callback, [visitor.FIELDS. *tipo de ID*, visitor.FIELDS. *tipo de ID*]);

Nos parâmetros da função:

  • O *retorno de chamada* representa seu próprio código de retorno de chamada que recebe as IDs retornadas.
  • (Opcional) visitor.FIELDS. *Tipo de ID* é um enum que permite especificar quais valores de ID você deseja que a função retorne.

Consulte os casos de uso e as definições a seguir para obter mais informações.

Caso de uso 1: solicitar o conjunto de dados padrão

Esse código retorna o conjunto de dados padrão. Sua solicitação e resposta podem ser semelhantes aos exemplos a seguir.

//Call the ID service
var visitor = Visitor.getInstance ("Insert Experience Cloud organization ID here",{...});

//Add your callback to the GET method to return IDs and data.
visitor.getVisitorValues(visitorIdsCallback);

Na resposta de amostra padrão, alguns valores foram encurtados para fins de demonstração.

//Formatted IDs in JSON response
{
    MCMID: 'mid-1234',
    MCOPTOUT: 'isoptedout-true',
    MCAID: 'aid-1234',
    MCAAMLH: 7,
    MCAAMB: 'hgfe54236786oygj'
}

Caso de uso 2: solicitar um conjunto de dados personalizado

Esse código usa uma matriz para retornar um conjunto específico de IDs usando o visitor.FIELDS enum. Nesse caso, desejamos apenas a Experience Cloud ID (MCID) e a Analytics ID (MCAID) do visitante. Sua solicitação e resposta podem ser semelhantes aos exemplos a seguir.

//Call the ID service
var visitor = Visitor.getInstance("Insert Experience Cloud organization ID here", { ... });

// Add an optional array to specify which IDs you want to return.
visitor.getVisitorValues(visitorIdsCallback, [visitor.FIELDS.MCMID, visitor.FIELDS.MCAID]);

A resposta de amostra personalizada retorna somente as IDs especificadas na solicitação.

//Formatted IDs in JSON response
{
    MCMID: 'mid-1234',
    MCAID: 'aid-4321'
}

Parâmetros de resposta definidos

A tabela a seguir lista e define os parâmetros de resposta. Esses são todos os valores no visitor.FIELDS enum. Observe que esse método retornará uma string vazia se não houver valores para uma variável específica.

Valor Descrição

MCAAMB

Metadados criptografados do Audience Manager conhecido como “a bolha”.

MCAAMLH

A ID da região de coleta de dados. Este é um identificador numérico para a localização geográfica de um data center de serviço de ID específico.

Consulte IDs de região, locais e nomes de host do DCS e getLocationHint.

MCAID

A Analytics ID do visitante.

MCMID

A Experience Cloud ID do visitante.

Consulte Cookies e o serviço de identidade da Experience Cloud.

MCOPTOUT

Um sinalizador que indica se um visitante recusou a coleta de dados.

Os valores incluem:

  • 'isoptedout-true': um visitante recusou a coleta de dados.
  • 'isoptedout-false': um visitante não recusou a coleta de dados.

Nesta página