Ir para o conteúdo

Detalhes de Conexão do Adobe Analytics

Introdução

Versão do conector

Esta documentação é baseada na versão 21.0.8383 do conector.

Começando

Suporte à versão do Adobe Analytics

O conector utiliza a API AdobeAnalytics para permitir o acesso ao AdobeAnalytics.

Estabelecendo uma Conexão

Conectando-se ao Adobe Analytics

GlobalCompanyId

GlobalCompanyId é uma propriedade de conexão opcional. Se deixado em branco, o driver tenta detectá-lo automaticamente. Se você deseja especificar manualmente o ID global da empresa, pode encontrá-lo na URL de solicitação para o endpoint users/me na interface do Swagger. Depois de fazer login na IU do Swagger, expanda o endpoint de usuários e, em seguida, clique no botão GET users/me. Clique nos botões Experimentar e Executar. Anote o ID da empresa global mostrado na URL de solicitação imediatamente antes do endpoint users/me.

ID do Conjunto de Relatórios

RSID é uma propriedade de conexão opcional. Se não for definido, o driver tentará detectá-lo automaticamente. Use esta propriedade se desejar especificar manualmente o conjunto de relatórios. Para obter uma lista completa de seus conjuntos de relatórios junto com seus identificadores ao lado do nome, navegue até Admin -> Suítes de relatórios.

Depois de definir as propriedades de conexão OAuth, você está pronto para se conectar ao Adobe Analytics

Autenticação no Adobe Analytics

O Adobe Analytics usa o padrão de autenticação OAuth. Você pode autenticar com integração OAuth ou integração de conta de serviço.

Autenticar com Integração OAuth

Observação: Defina o AuthScheme para OAuth para autenticar com este método.

Para autenticar usando OAuth, você pode criar um aplicativo para obter o OAuthClientId, OAuthClientSecret, e CallbackURL propriedades de conexão ou use as Credenciais incorporadas. Consulte Usando autenticação OAuth para obter um guia de autenticação.

Autenticar com Integração de Conta de Serviço

Observação: Defina o AuthScheme para OAuthJWT para autenticar com este método.

As contas de serviço têm autenticação silenciosa, sem autenticação do usuário no navegador.
Você precisa criar um aplicativo neste fluxo. Consulte Criando um aplicativo OAuth personalizado para criar e autorizar um aplicativo. Você pode se conectar aos dados do Adobe Analytics que a conta de serviço tem permissão para acessar.

Depois de definir as seguintes propriedades de conexão, você está pronto para se conectar:

  • InitiateOAuth: Defina como GETANDREFRESH.
  • OAuthClientId: Defina o ID do cliente nas configurações do aplicativo.
  • OAuthClientSecret: Defina o segredo do cliente nas configurações do aplicativo.
  • OAuthJWTCertType: Defina como "PUBLIC_KEY_FILE".
  • OAuthJWTCert: Defina o caminho para o arquivo .key que você gerou.
  • OAuthJWTCertPassword: Defina a senha do arquivo .key.
  • OAuthJWTSubject: O assunto, seu ID de conta técnica da integração do Adobe I/O Console, no formato: id@techacct.adobe.com.
  • OAuthJWTIssuer: O emissor, sua ID da organização da integração do Adobe I/O Console, no formato org_ident@AdobeOrg. Identifica sua organização que foi configurada para acessar a API Adobe I/O.

Quando você conecta, o conector conclui o fluxo OAuth para uma conta de serviço.

  1. Cria e assina o JWT com o conjunto de declarações exigido pelo conector.
  2. Troca o JWT pelo token de acesso.
  3. Salva valores OAuth em OAuthSettingsLocation para ser persistido nas conexões.
  4. Envia o JWT para um novo token de acesso quando o token expira.

Usando Autenticação OAuth

OAuth requer que o usuário autenticado interaja com o Adobe Analytics usando o navegador. O conector facilita isso de várias maneiras, conforme descrito abaixo.

Credenciais Incorporadas

Consulte Credenciais incorporadas para se conectar com as credenciais incorporadas do conector e pule a criação de um aplicativo OAuth personalizado.

Credenciais Personalizadas

Você precisará registrar um aplicativo para obter o OAuthClientId e OAuthClientSecret.

Quando Criar um Aplicativo OAuth Personalizado
Criando um Aplicativo OAuth Personalizado

Consulte Criando um aplicativo OAuth personalizado para um procedimento.

Credenciais Incorporadas

Autenticar Usando as Credenciais OAuth Incorporadas
Autenticação de Desktop com o Aplicativo OAuth Incorporado

Você pode se conectar sem definir nenhuma propriedade de conexão para suas credenciais de usuário. Depois de definir o seguinte, você está pronto para se conectar:

  • InitiateOAuth: Defina como GETANDREFRESH. Você pode usar InitiateOAuth para evitar repetir a troca de OAuth e configurar manualmente o OAuthAccessToken.

Quando você conecta, o conector abre o endpoint OAuth em seu navegador padrão. Faça login e conceda permissões ao aplicativo. O conector então conclui o processo OAuth.

  1. Extrai o token de acesso da URL de retorno de chamada e autentica as solicitações.
  2. Obtém um novo token de acesso quando o antigo expira.
  3. Salva valores OAuth em OAuthSettingsLocation para ser persistido nas conexões.

Credenciais Personalizadas

Quando Usar um Aplicativo OAuth Personalizado

Você deve criar um aplicativo OAuth personalizado para se conectar ao Adobe Analytics.

Autenticação de Desktop com um Aplicativo OAuth Personalizado

Siga as etapas abaixo para autenticar com as credenciais de um aplicativo OAuth personalizado. Consulte Criando um aplicativo OAuth personalizado.

Obtenha e Atualize o Token de Acesso OAuth

Depois de definir o seguinte, você está pronto para se conectar:

  • OAuthClientId: Defina isso para o ID do cliente atribuído quando você registrou seu aplicativo.
  • OAuthClientSecret: Defina isso para o segredo do cliente atribuído quando você registrou seu aplicativo.
  • CallbackURL: Defina isso para o URI de redirecionamento definido quando você registrou seu aplicativo. Por exemplo: https://localhost:3333
  • InitiateOAuth: Defina como GETANDREFRESH. Você pode usar InitiateOAuth para evitar repetir a troca de OAuth e configurar manualmente o OAuthAccessToken.

Quando você conecta, o conector abre o endpoint OAuth em seu navegador padrão. Faça login e conceda permissões ao aplicativo. O conector então conclui o processo OAuth:

  1. O processo é finalizado com o token de acesso retornado da API do Adobe Analytics.
  2. Atualiza o token de acesso quando ele expira.
  3. Salva valores OAuth em OAuthSettingsLocation para ser persistido nas conexões.

Máquinas Sem Cabeça

Usando OAuth em uma Máquina Sem Cabeça

Para criar fontes de dados do Adobe Analytics em servidores headless ou outras máquinas nas quais o conector não pode abrir um navegador, você precisa autenticar de outra máquina. A autenticação é um processo de duas etapas.

  1. Ao invés de instalar o conector em outra máquina, você pode seguir os passos abaixo para obter o OAuthVerifier valor. Ou você pode instalar o conector em outra máquina e transferir os valores de autenticação OAuth, depois de autenticar por meio do fluxo normal baseado em navegador.
  2. Em seguida, você pode configurar o conector para atualizar automaticamente o token de acesso da máquina sem periféricos.

Você pode seguir o fluxo de autenticação OAuth headless usando as credenciais OAuth para seu aplicativo OAuth personalizado.

Usando as Credenciais para um Aplicativo OAuth Personalizado

Crie um aplicativo OAuth personalizado

Talvez você queira criar um aplicativo OAuth personalizado para alterar as informações exibidas quando os usuários fazem logon no Adobe Analytics para conceder permissões ao conector.

Consulte Criando um aplicativo OAuth personalizado para um procedimento. Você pode seguir os procedimentos abaixo para autenticar e conectar-se aos dados.

Obtenha um código verificador

Defina as seguintes propriedades na máquina sem periféricos:

  • InitiateOAuth: Defina como DESLIGADO.
  • OAuthClientId: Defina isso como o ID do cliente nas configurações do aplicativo.
  • OAuthClientSecret: Defina isso como o segredo do cliente nas configurações do aplicativo.

Você pode seguir as etapas abaixo para autenticar em outra máquina e obter o OAuthVerifier propriedade de conexão.

  1. Chame o GetOAuthAuthorizationURL procedimento armazenado* com o parâmetro de entrada CallbackURL definido para o URI de redirecionamento exato que você especificou nas configurações do aplicativo.
  2. Abra o URL retornado em um navegador. Faça login e conceda permissões ao conector. Você será redirecionado para o URL de retorno de chamada, que contém o código do verificador.
  3. Salve o valor do código do verificador. Você definirá isso no OAuthVerifier propriedade de conexão.

Na máquina sem periféricos, defina as seguintes propriedades de conexão para obter os valores de autenticação OAuth:

  • OAuthClientId: Defina isso como a chave do consumidor nas configurações do aplicativo.
  • OAuthClientSecret: Defina isso como o segredo do consumidor nas configurações do aplicativo.
  • OAuthVerifier: Defina isso para o código do verificador.
  • OAuthSettingsLocation: Defina para manter os valores de autenticação OAuth criptografados no arquivo especificado.
  • InitiateOAuth: Configure para ATUALIZAR.

Depois que o arquivo de configurações OAuth for gerado, defina as seguintes propriedades para se conectar aos dados:

  • OAuthClientId: Defina isso como a chave do consumidor nas configurações do aplicativo.
  • OAuthClientSecret: Defina isso como o segredo do consumidor nas configurações do aplicativo.
  • OAuthSettingsLocation: Defina isso para o arquivo que contém os valores de autenticação OAuth criptografados. Certifique-se de que este arquivo forneça permissões de leitura e gravação ao provedor para ativar a atualização automática do token de acesso.
  • InitiateOAuth: Configure para ATUALIZAR.

Configurações de transferência OAuth

Siga as etapas abaixo para instalar o conector em outra máquina, autenticar e depois transferir os valores OAuth resultantes.

Em uma segunda máquina, instale o conector e conecte-se com o seguinte conjunto de propriedades:

  • OAuthSettingsLocation: Defina isso como um arquivo de texto gravável.
  • InitiateOAuth: Defina como GETANDREFRESH.
  • OAuthClientId: Defina isso para o ID do cliente atribuído quando você registrou seu aplicativo.
  • OAuthClientSecret: Defina isso como o segredo do cliente atribuído quando você registrou seu aplicativo.
  • CallbackURL: Defina isso para o URI de redirecionamento que você especificou nas configurações do aplicativo.

Teste a conexão para autenticar. Os valores de autenticação resultantes são gravados, criptografados, no caminho especificado por OAuthSettingsLocation. Depois de testar a conexão com sucesso, copie o arquivo de configurações OAuth para sua máquina sem periféricos. Na máquina sem periféricos, defina as seguintes propriedades de conexão para se conectar aos dados:

  • InitiateOAuth: Configure para ATUALIZAR.
  • OAuthClientId: Defina isso como a chave do consumidor nas configurações do aplicativo.
  • OAuthClientSecret: Defina isso como o segredo do consumidor nas configurações do aplicativo.
  • OAuthSettingsLocation: Defina isso como o caminho para o arquivo de configurações OAuth. Certifique-se de que este arquivo forneça permissões de leitura e gravação ao conector para habilitar a atualização automática do token de acesso.

Criando um Aplicativo OAuth Personalizado

Você deve criar um aplicativo OAuth personalizado para se conectar ao Adobe Analytics.

Crie um Aplicativo para Integração com OAuth

Siga as etapas abaixo para criar um aplicativo personalizado e obter as propriedades de conexão em um fluxo de autenticação OAuth específico.

  • Navegue até o seguinte URL: <https://console.adobe.io/home>.
  • Clique no Create new project botão.
  • Selecione os Add API opção.
  • Selecione Adobe Analytics, clique Next e, em seguida, selecione OAuth e depois clique em Next de novo.
  • Selecione os Web e preencha os URIs de redirecionamento. Para um aplicativo de desktop, você pode usar um URL de host local, como https://localhost:33333. Para um aplicativo da web, forneça o URL da página para redirecionar em seu site.
  • Clique Save configured API.

Seu cliente agora está criado. Observe que seu cliente tem um ID de cliente (chave de API ) e um segredo do cliente. Eles serão necessários para obter seu código de autenticação e gerar tokens de acesso.

Criar um Aplicativo para Integração de Conta de Serviço

Siga as etapas abaixo para criar um aplicativo personalizado e obter as propriedades de conexão em um fluxo de autenticação de conta de serviço específico.

  • Navegue até o seguinte URL: <https://console.adobe.io/home>.
  • Clique no Create new project botão.
  • Selecione os Add API opção.
  • Selecione Adobe Analytics, clique Next e, em seguida, selecione Service Account (JWT) e depois clique em Next de novo.
  • Escolha entre Generate a key pair ou Upload your public key. Se você optar por Generate a key pair, salve o arquivo config.zip localmente, pois ele contém o certificado necessário para concluir a conexão. Clique Next depois que a chave é criada ou carregada.
  • Creating Your Own Public Key Certificate
    • MacOS and Linux
      Abra um terminal e execute o seguinte comando:
      openssl req -x509 -sha256 -nodes -days 365 -newkey rsa:2048 -keyout private.key -out certificate_pub.crt
    • Windows
      Baixe um cliente OpenSSL como o OpenSSL Light para gerar certificados públicos. As etapas a seguir serão para OpenSSL Light
      Abra uma janela de linha de comando e execute os seguintes comandos:
      1) cd "C:\Arquivos de Programas\OpenSSL-Win64\bin"
      2) .\openssl.exe req -x509 -sha256 -nodes -days 365 -newkey rsa:2048 -keyout private.key -out certificate_pub.crt
  • Selecione um ou mais perfis de produto (em perfis de produto você pode definir as permissões do app.) e clique em Save configured API.

Seu cliente agora está criado. Observe que seu cliente tem ID do cliente (chave de API ), segredo do cliente, ID da organização e ID da conta técnica. Eles serão necessários para obter o token JWT e gerar tokens de acesso.

Características Avançadas

Esta seção detalha uma seleção de recursos avançados do conector Adobe Analytics.

Visualizações definidas pelo usuário

O conector permite definir tabelas virtuais, denominadas visões definidas pelo usuário, cujo conteúdo é decidido por uma consultar pré-configurada. Essas exibições são úteis quando você não pode controlar diretamente as consultas enviadas aos drivers. Consulte Visualizações definidas pelo usuário para obter uma visão geral da criação e configuração de exibições personalizadas.

Configuração SSL

Use Configuração SSL para ajustar como o conector lida com as negociações de certificado TLS/SSL. Você pode escolher entre vários formatos de certificado; Veja o SSLServerCert propriedade em "Opções de cadeia de conexão" para obter mais informações.

Procurador

Para configurar o conector usando configurações de proxy do Agente Privado, selecione os Use Proxy Settings caixa de seleção na tela de configuração da conexão.

Visualizações Definidas pelo Usuário

O Jitterbit Connector for Adobe Analytics permite definir uma tabela virtual cujo conteúdo é decidido por uma consultar pré-configurada. Elas são chamadas de Visualizações Definidas pelo Usuário, que são úteis em situações onde você não pode controlar diretamente a consultar que está sendo emitida para o driver, por exemplo, ao usar o driver do Jitterbit. As Visualizações Definidas pelo Usuário podem ser usadas para definir predicados que são sempre aplicados. Se você especificar predicados adicionais na consultar para a visualização, eles serão combinados com a consultar já definida como parte da visualização.

Há duas maneiras de criar exibições definidas pelo usuário:

  • Crie um arquivo de configuração em formato JSON definindo as visualizações desejadas.
  • declarações DDL.

Definindo Visualizações Usando um Arquivo de Configuração

As visualizações definidas pelo usuário são definidas em um arquivo de configuração formatado em JSON chamado UserDefinedViews.json. O conector detecta automaticamente as visualizações especificadas neste arquivo.

Você também pode ter várias definições de exibição e controlá-las usando o UserDefinedViews propriedade de conexão. Quando você usa essa propriedade, apenas as exibições especificadas são vistas pelo conector.

Este arquivo de configuração de exibição definida pelo usuário é formatado da seguinte forma:

  • Cada elemento raiz define o nome de uma visualização.
  • Cada elemento raiz contém um elemento filho, chamado query, que contém a consultar SQL personalizada para a exibição.

Por exemplo:

{
    "MyView": {
        "query": "SELECT * FROM SampleTable_1 WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

Use o UserDefinedViews propriedade de conexão para especificar a localização do seu arquivo de configuração JSON. Por exemplo:

"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"

Esquema para Exibições Definidas pelo Usuário

As visualizações definidas pelo usuário são expostas no UserViews esquema por padrão. Isso é feito para evitar que o nome da exibição entre em conflito com uma entidade real no modelo de dados. Você pode alterar o nome do esquema usado para UserViews definindo o UserViewsSchemaName propriedade.

Trabalhando com Exibições Definidas pelo Usuário

Por exemplo, uma instrução SQL com uma Visualização Definida pelo Usuário chamada UserViews.RCustomers lista apenas clientes em Raleigh:

SELECT * FROM Customers WHERE City = 'Raleigh';

Exemplo de consultar ao driver:

SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';

Resultando na consultar efetiva à fonte:

SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';

Esse é um exemplo muito simples de uma consultar a uma exibição definida pelo usuário que é efetivamente uma combinação da consultar de exibição e da definição de exibição. É possível compor essas consultas em padrões muito mais complexos. Todas as operações SQL são permitidas em ambas as consultas e são combinadas quando apropriado.

Configuração SSL

Personalizando a Configuração SSL

Por padrão, o conector tenta negociar SSL/TLS verificando o certificado do servidor em relação ao armazenamento de certificados confiáveis do sistema.

Para especificar outro certificado, consulte o SSLServerCert propriedade para os formatos disponíveis para fazê-lo.

Modelo de Dados

O Jitterbit Connector for Adobe Analytics modela objetos do Adobe Analytics como tabelas e exibições relacionais. As seções a seguir mostram os objetos de API disponíveis e fornecem mais informações sobre a execução de SQL para APIs do Adobe Analytics.

Procedimentos armazenados

NOTE: Procedimentos armazenados não são suportados atualmente. Veja a nota para detalhes.

Procedimentos armazenados são interfaces semelhantes a funções para a fonte de dados. Eles podem ser usados para acessar recursos adicionais da API do Adobe Analytics.

Visualizações

Os relatórios são mostrados como visualizações, tabelas que não podem ser modificadas. Ao contrário das exibições de banco de dados tradicionais, no entanto, não é muito útil selecionar todas as métricas e dimensões em uma determinada tabela. A data é a dimensão padrão para cada relatório, portanto, a consultar:

SELECT * FROM MyReport

se tornará:

SELECT Date, {all the metrics here} FROM MyReport

Mas se a consultar tiver critérios, as dimensões padrão serão as dimensões usadas nos critérios, como:

SELECT * FROM MyReport WHERE Country = 'England'

se tornará:

SELECT Country, {all the metrics here} FROM MyReport WHERE Country = 'England'

Além disso, a API do Adobe Analytics limita o número de dimensões para as quais você pode solicitar dados por chamada de API REST a uma. Isso significa que a única maneira de o provedor gerar relatórios com várias dimensões é dividindo as dimensões.
Vamos dar um exemplo de consultar:

SELECT Country, City, Visits FROM MyReport
  • Primeiramente, o provedor solicita todos os valores da primeira dimensão, País, suponha que sejam: Inglaterra e Alemanha.
  • Em segundo lugar, o provedor tenta quebrar a Inglaterra com a dimensão City, e fica, vamos supor: London, Liverpool.
  • Por fim, quebra Alemanha com City e fica com: Berlin, Frankfurt.

Se tivéssemos uma terceira dimensão, o provedor dividiria todas as cidades com a terceira dimensão (o que significa que faria uma solicitação por cidade).

Agora, imagine um relatório quadridimensional onde as dimensões possuem muitos valores. A geração desse relatório exigiria muitas chamadas de API.
No entanto, a API do Adobe Analytics nos permite fornecer alguns filtros que podem reduzir consideravelmente o tempo de execução da consultar.

A API do Adobe Analytics usa os seguintes operadores lógicos: 'AND', 'OR', 'NOT'
e também usa os seguintes operadores: 'MATCH', 'CONTAINS', 'BEGINS-WITH' e 'ENDS-WITH', o que significa que critérios como os abaixo serão tratados do lado do servidor:

... WHERE Dimension = 'Value'
... WHERE Dimension LIKE '%value%'
... WHERE Dimension1 LIKE '%value' AND Dimension2 = 'Value2'
... WHERE Dimension LIKE 'value%'
... WHERE Dimension1 = 'Value1' AND Dimension2 = 'Value2'
... WHERE Dimension = 'Value1' OR Dimension = 'Value2' OR Dimension = 'Value3'
... WHERE Dimension IN ('Value1', 'Value2', 'Value3', 'Value4')
... WHERE (Dimension1 = 'value1' OR Dimension1 = 'Value2') AND (Dimension2 = 'value3' OR Dimension2 = 'value4')

É altamente recomendável usar o maior número possível de filtros, caso contrário, consultas com muitas dimensões podem levar muito tempo.

Definindo Relatórios Personalizados

Para criar uma visualização de relatório em uma consultar, você pode usar o CreateReport procedimento armazenado. O CriarRelatório procedimento armazenado* fornece uma maneira fácil de gerar novas definições de exibição com uma combinação personalizada de Dimensões e Métricas. Chamá-lo criará um novo arquivo de esquema que você pode consultar como qualquer outra visualização.

O procedimento armazenado* usa um nome de visualização, uma lista separada por vírgulas de nomes de métricas, uma lista separada por vírgulas de IDs de métricas, uma lista separada por vírgulas de nomes de dimensão, uma lista separada por vírgulas de IDs de dimensão e uma pasta de saída como entradas. Você precisará definir o Location propriedade de conexão com a pasta que contém os novos arquivos de script para acessá-los; o Location pode ser definido em vez da pasta de saída.
Você pode obter os IDs de métricas/dimensões consultando exibições de métricas/dimensões.

SELECT Id, Name FROM Dimensions
SELECT Id, Name FROM Metrics

Por exemplo, para usar um novo esquema junto com os esquemas padrão, defina o Location para a subpasta db na pasta de instalação e faça a seguinte chamada:

EXEC CreateReport Dimensions = 'Country, City', Metrics = 'PageViews, Visits', TableName = 'MyCustomReport'

O conector transfere o máximo possível do processamento da instrução SELECT para as APIs do Adobe Analytics e processa o restante da consultar na memória. Ver SupportEnhancedSQL para obter mais informações sobre como o conector contorna as limitações da API com processamento na memória do lado do cliente.

Visualizações

As exibições são compostas por colunas e pseudocolunas. As exibições são semelhantes às tabelas na forma como os dados são representados; no entanto, as exibições não oferecem suporte a atualizações. Entidades que são representadas como exibições são normalmente entidades somente leitura. Frequentemente, um procedimento armazenado* está disponível para atualizar os dados se tal funcionalidade for aplicável à fonte de dados.

As consultas podem ser executadas em uma exibição como se fosse uma tabela normal, e os dados retornados são semelhantes nesse aspecto. Para saber mais sobre tabelas e procedimentos armazenados, navegue até as entradas correspondentes neste documento de ajuda.

Conector Jitterbit para Exibições do Adobe Analytics

Nome Descrição
AdsReport Gere relatórios de dados sobre os anúncios do seu site.
CalculatedMetrics Consulte as métricas calculadas disponíveis no AdobeAnalytics.
CollectionSuites Consulte os conjuntos de coleções disponíveis no AdobeAnalytics.
Dimensions Consulte as dimensões disponíveis no AdobeAnalytics.
Metrics Consulte as métricas disponíveis no AdobeAnalytics.
OrdersReport Gere relatórios de dados para pedidos feitos em seu site.
ProductsReport Gere relatórios de dados sobre seus produtos.
Segments Consulte os segmentos disponíveis no AdobeAnalytics.
SiteReport Gere relatórios de dados sobre o tráfego do seu site.
Users Consulte os usuários disponíveis no AdobeAnalytics.

Relatório de Anúncios

Gere relatórios de dados sobre os anúncios do seu site.

Ver Informações Específicas

Consulte a explicação na seção "Modelo de dados" para saber como criar consultas ideais. A seguir estão alguns casos de uso para este relatório:

SELECT Country, City, AdClicks, AdImpressions, ClickThroughs FROM AdsReport
SELECT Page, AdClicks, AdImpressions, ClickThroughs FROM AdsReport
SELECT Date, Revenue FROM AdsReport

Você pode ativar a execução do lado do cliente definindo SupportEnhancedSQL para verdadeiro, caso em que qualquer filtro que o Adobe Analytics não manuseie será tratado no lado do cliente.

Colunas
Nome Tipo IsDimension ÉMétrico Dimensão padrão Descrição
Country String Verdadeiro Nome do país.
City String Verdadeiro Nome da cidade.
Page String Verdadeiro Nome da página em que o anúncio estava.
Date Date Verdadeiro Verdadeiro A data e hora dos dados fornecidos.
PageViews Int Verdadeiro Número de visualizações de página.
AdClicks Int Verdadeiro Número de cliques em anúncios.
AdImpressions Int Verdadeiro Número de adimpressões.
ClickThroughs Int Verdadeiro Número de cliques.
Revenue Decimal Verdadeiro Receita obtida com os anúncios.
Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Nome Tipo Descrição
StartDate Datetime Use isso para filtrar relatórios pela data de início do relatório.
EndDate Datetime Use isso para filtrar relatórios pela data final do relatório.
SegmentId String Use isso para filtrar relatórios por um segmento específico.

Métricas Calculadas

Consulte as métricas calculadas disponíveis no AdobeAnalytics.

Colunas
Nome Tipo IsDimension ÉMétrico Dimensão padrão Descrição
Id [KEY] String Identificador exclusivo da métrica calculada.
Name String O nome da métrica calculada.
ReportSuiteName String O nome do conjunto de relatórios em que a métrica calculada está.
Description String Uma descrição para a métrica calculada.
Created Datetime A data e hora em que a métrica calculada foi criada.
Modified Datetime A data e hora em que a métrica calculada foi modificada.
Type String O tipo da métrica calculada. Por exemplo int, decimal, porcentagem etc.
OwnerId String Identificador exclusivo do usuário que criou a métrica calculada.
OwnerName String Nome do usuário que criou a métrica calculada.
Category String A categoria da métrica calculada.
SiteTitle String O título do site.
Polarity String Toma dois valores: positivo e negativo. Determina se é positivo ou não se a métrica aumentar.
Precision Integer A precisão da métrica calculada.
Template String Atributo adicional usado para identificar modelos quando IncludeType=templates.
Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Nome Tipo Descrição
IncludeType String Por padrão, as respostas sem esse parâmetro incluem apenas métricas calculadas pertencentes ao usuário. Os seguintes valores são possíveis: 1) all: Retorna todas as métricas calculadas vinculadas a esta empresa. 2) shared: Retorna métricas calculadas compartilhadas com o usuário. 3) templates: Retorna todos os templates de métrica calculados.

CollectionSuítes

Consulte os conjuntos de coleções disponíveis no AdobeAnalytics.

Colunas
Nome Tipo IsDimension ÉMétrico Dimensão padrão Descrição
Rsid [KEY] String Identificador exclusivo do conjunto de coleta.
Name String O nome do conjunto de coleta.
ParentRsid String Identificador exclusivo do pai deste conjunto de coleção.
Currency String Moeda padrão usada neste pacote de coleta.
Type String O tipo do conjunto de coleta. Por exemplo, conjunto de relatórios.
Timezone String O fuso horário do conjunto de coleta.

Dimensões

Consulte as dimensões disponíveis no AdobeAnalytics.

Colunas
Nome Tipo IsDimension ÉMétrico Dimensão padrão Descrição
Id [KEY] String Identificador exclusivo da dimensão.
RSID String Identificador exclusivo do conjunto de relatórios em que a dimensão está.
Title String O título da dimensão.
Name String O nome da dimensão.
Type String O tipo da dimensão. Por exemplo string, int, enum etc.
Description String Uma descrição da dimensão.
Category String A categoria da dimensão.
Pathable Boolean Se a dimensão é permeável ou não.
Segmentable Boolean Se a dimensão é ou não segmentável.
ReportType String O tipo dos relatórios nos quais essa dimensão é válida.
Support String O tipo dos relatórios nos quais essa dimensão é suportada.

Métricas

Consulte as métricas disponíveis no AdobeAnalytics.

Colunas
Nome Tipo IsDimension ÉMétrico Dimensão padrão Descrição
Id [KEY] String Identificador exclusivo da métrica.
RSID String Identificador exclusivo do conjunto de relatórios em que a métrica está.
Title String O título da métrica.
Name String O nome da métrica.
Type String O tipo da métrica, por exemplo int, percent, moeda, etc.
Description String Uma descrição para a métrica.
Category String A categoria da métrica.
Calculated Boolean Se essa métrica é ou não uma métrica calculada.
Segmentable Boolean Se essa métrica é ou não segmentável.
Polarity String Toma dois valores: positivo e negativo. Determina se é positivo ou não se a métrica aumentar.
Precision Integer A precisão da métrica.

Relatório de Pedidos

Gere relatórios de dados para pedidos feitos em seu site.

Ver Informações Específicas

Consulte a explicação na seção "Modelo de dados" para saber como criar consultas ideais. A seguir estão alguns casos de uso para este relatório:

SELECT Date, CartViews, CartAdditions, CartRemovals FROM OrdersReport
SELECT Date, Orders, OrdersPerVisitor FROM OrdersReport
SELECT Date, Revenue FROM OrdersReport

Você pode ativar a execução do lado do cliente definindo SupportEnhancedSQL para verdadeiro, caso em que qualquer filtro que o Adobe Analytics não manuseie será tratado no lado do cliente.

Colunas
Nome Tipo IsDimension ÉMétrico Dimensão padrão Descrição
Date Date Verdadeiro Verdadeiro A data e hora dos dados fornecidos.
Carts Int Verdadeiro Número de carrinhos.
CartAdditions Int Verdadeiro Número de adições ao carrinho.
CartRemovals Int Verdadeiro Número de carrinhos removidos.
CartViews Int Verdadeiro Número de visualizações do carrinho.
Orders Int Verdadeiro Quantidade de pedidos realizados.
ConversionRate Int Verdadeiro Porcentagem de pedidos convertidos em compra.
OrdersPerVisitor Int Verdadeiro Número de pedidos por visitante.
Revenue Decimal Verdadeiro Receita obtida com as vendas.
RevenuePerOrder Decimal Verdadeiro Receita média por cada pedido.
Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Nome Tipo Descrição
StartDate Datetime Use isso para filtrar relatórios pela data de início do relatório.
EndDate Datetime Use isso para filtrar relatórios pela data final do relatório.
SegmentId String Use isso para filtrar relatórios por um segmento específico.

Relatório de Produtos

Gere relatórios de dados sobre seus produtos.

Ver Informações Específicas

Consulte a explicação na seção "Modelo de dados" para saber como criar consultas ideais. A seguir estão alguns casos de uso para este relatório:

SELECT Product, Date, ProductViews, Units FROM ProductsReport
SELECT Product, Orders, Checkouts FROM ProductsReport
SELECT Product, Date, Revenue FROM ProductsReport

Você pode ativar a execução do lado do cliente definindo SupportEnhancedSQL para verdadeiro, caso em que qualquer filtro que o Adobe Analytics não manuseie é tratado no lado do cliente.

Colunas
Nome Tipo IsDimension ÉMétrico Dimensão padrão Descrição
Product String Verdadeiro Nome do produto.
Date Date Verdadeiro Verdadeiro A data e hora dos dados fornecidos.
ProductViews Int Verdadeiro Número de visualizações que um produto recebeu.
CartAdditions Int Verdadeiro Número de vezes que o produto foi adicionado em um carrinho.
Checkouts Int Verdadeiro Número de checkouts.
Orders Int Verdadeiro Número de encomendas.
Units Int Verdadeiro Número de unidades.
Revenue Decimal Verdadeiro Receita obtida com a venda de produtos.
Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Nome Tipo Descrição
StartDate Datetime Use isso para filtrar relatórios pela data de início do relatório.
EndDate Datetime Use isso para filtrar relatórios pela data final do relatório.
SegmentId String Use isso para filtrar relatórios por um segmento específico.

Segmentos

Consulte os segmentos disponíveis no AdobeAnalytics.

Colunas
Nome Tipo IsDimension ÉMétrico Dimensão padrão Descrição
Id [KEY] String Identificador exclusivo do segmento.
Name String O nome do segmento.
ReportSuiteName String O nome do conjunto de relatórios em que o segmento foi criado.
Description String Uma descrição para o segmento.
Created Datetime A data e hora em que o segmento foi criado.
Modified Datetime A data e hora em que o segmento foi modificado pela última vez.
OwnerId String O identificador exclusivo do usuário que criou o segmento.
OwnerName String O nome do usuário que criou o segmento.
Version String A versão do segmento.
Type String Uma lista separada por vírgulas de tipos de segmento. Os valores permitidos são: shared, templates, curatedItem.
SiteTitle String O título do site.

SiteReport

Gere relatórios de dados sobre o tráfego do seu site.

Ver Informações Específicas

Consulte a explicação na seção "Modelo de dados" para saber como criar consultas ideais. A seguir estão alguns casos de uso para este relatório:
De onde vem a maior parte do tráfego? (país/cidade)

SELECT Country, City, PageViews, Visits FROM SiteReport

A que horas do dia o site é mais movimentado?

SELECT HourOfDay, PageViews, Visits FROM SiteReport

Quais mecanismos de pesquisa nossos usuários costumam usar para nos encontrar?

SELECT SearchEngine, Visits, UniqueVisitors FROM SiteReport

Quem está indicando usuários para nos visitar?

SELECT Referrer, Visits, UniqueVisitors FROM SiteReport

As pessoas vêm para ficar ou costumam pular?

SELECT Date, Bounces, BounceRate FROM SiteReport

Qual é a página mais visualizada?

SELECT Page, PageViews, Visits, UniqueVisitors FROM SiteReport

Você pode ativar a execução do lado do cliente definindo SupportEnhancedSQL para verdadeiro, caso em que qualquer filtro que o Adobe Analytics não manuseie será tratado no lado do cliente.

Colunas
Nome Tipo IsDimension ÉMétrico Dimensão padrão Descrição
Date Date Verdadeiro Verdadeiro A data e hora da primeira entrada de log de uma sessão.
HourOfDay String Verdadeiro A hora do dia da primeira entrada de log de uma sessão.
Country String Verdadeiro Agrupa o tráfego da web pelo país onde o cliente estava.
City String Verdadeiro Agrupa o tráfego da web pela cidade onde o cliente estava.
SearchEngine String Verdadeiro O nome de domínio de segundo nível do primeiro site (que é um mecanismo de pesquisa) que encaminhou um visitante ao site durante uma sessão (conforme fornecido pelo navegador do visitante).
Browser String Verdadeiro O tipo de agente do usuário usado pelo visitante, incluindo o número da versão (por exemplo, MSIE 6.0).
OperatingSystems String Verdadeiro Agrupa o tráfego da web pelo sistema operacional usado pelo cliente. Os sistemas operacionais móveis e de desktop aparecem neste relatório.
Page String Verdadeiro O nome de cada página visitada durante uma sessão. Inicialmente, o nome de cada página é igual ao URI, mas pode ser alterado para facilitar a interpretação.
Referrer String Verdadeiro O nome de domínio de segundo nível do site que primeiro encaminhou uma sessão para o site (conforme fornecido pelo navegador do visitante).
PageViews Integer Verdadeiro O número de visualizações de página. Uma visualização de página é uma solicitação para uma página definida (o acesso a imagens e outros tipos de conteúdo filtrado não são contabilizados).
Visits Integer Verdadeiro O número de visitas.
UniqueVisitors Integer Verdadeiro O número de visitantes únicos.
Bounces Integer Verdadeiro O número de saltos. Uma rejeição é uma visita que consiste em uma única chamada do servidor.
BounceRate Integer Verdadeiro A porcentagem de visitas que contêm um único hit.
SinglePageVisits Integer Verdadeiro O número de visitas a uma única página.
TimeSpentPerVisit Integer Verdadeiro A quantidade média de tempo que os visitantes interagem com um item de dimensão específico durante cada visita.
TimeSpentPerVisitor Integer Verdadeiro A quantidade média de tempo que os visitantes interagem com um item de dimensão específico ao longo da vida útil do visitante (duração do cookie).
TotalSecondsSpent Integer Verdadeiro Representa a quantidade total de tempo que os visitantes interagem com um item de dimensão específico.
Revenue Decimal Verdadeiro O valor total em dólares para a soma do pedido de cada produto.
Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Nome Tipo Descrição
StartDate Datetime Use isso para filtrar relatórios pela data de início do relatório.
EndDate Datetime Use isso para filtrar relatórios pela data final do relatório.
SegmentId String Use isso para filtrar relatórios por um segmento específico.

Usuários

Consulte os usuários disponíveis no AdobeAnalytics.

Colunas
Nome Tipo IsDimension ÉMétrico Dimensão padrão Descrição
LoginId [KEY] String Identificador único do usuário.
ImsUserId String O ID do usuário do IMS. Isso é usado apenas para usuários internos, como autores, revisores, administradores, desenvolvedores, etc.
CompanyId String Identificador único da empresa.
CreateDate Timestamp A data em que o usuário foi criado.
Disabled Boolean Se a conta deste usuário está desativada ou não.
Email String O e-mail do usuário.
FirstName String O primeiro nome do usuário.
LastName String O sobrenome do usuário.
FullName String O nome completo do usuário.
LastAccess Timestamp Quando o usuário acessou sua conta pela última vez.
LastLogin Timestamp Quando o usuário fez login pela última vez.
Login String Nome de acesso.
PhoneNumber String O número de telefone do usuário.
Title String O título do usuário.

Procedimentos Armazenados

Procedimentos armazenados* estão disponíveis para complementar os dados disponíveis no Modelo de Dados. Pode ser necessário atualizar os dados disponíveis em uma exibição usando um procedimento armazenado* porque os dados não fornecem atualizações bidirecionais diretas, semelhantes a tabelas. Nessas situações, a recuperação dos dados é feita usando a visualização ou tabela apropriada, enquanto a atualização é feita chamando um procedimento armazenado. Procedimentos armazenados* pega uma lista de parâmetros e retorna um conjunto de dados que contém a coleção de tuplas que constituem a resposta.

Conector Jitterbit para Procedimentos Armazenados do Adobe Analytics

Nome Descrição
CreateReport Cria um relatório personalizado fornecendo dimensões e métricas.
GetOAuthAccessToken Obtém um token de autenticação do AdobeAnalytics.
GetOAuthAuthorizationURL Obtém a URL de autorização que deve ser aberta separadamente pelo usuário para conceder acesso ao seu aplicativo. Necessário apenas ao desenvolver aplicativos da Web. Você solicitará o OAuthAccessToken deste URL.
RefreshOAuthAccessToken O Adobe Analytics não oferece suporte ao token de atualização. Portanto, este procedimento armazenado* chamará o procedimento GetOAuthAccessToken internamente, para iniciar o fluxo OAuth desde o início.

Criar Relatório

Cria um relatório personalizado fornecendo dimensões e métricas.

Procedimento Armazenado* Informações Específicas

Para criar uma visualização de relatório em uma consultar, você pode usar o CreateReport procedimento armazenado. O CriarRelatório procedimento armazenado* fornece uma maneira fácil de gerar novas definições de exibição com uma combinação personalizada de Dimensões e Métricas. Chamá-lo criará um novo arquivo de esquema que você pode consultar como qualquer outra exibição.

O procedimento armazenado* usa um nome de visualização, uma lista separada por vírgulas de nomes de métricas, uma lista separada por vírgulas de IDs de métricas, uma lista separada por vírgulas de nomes de dimensão, uma lista separada por vírgulas de IDs de dimensão e uma pasta de saída como entradas. Você precisará definir o Location propriedade de conexão com a pasta que contém os novos arquivos de script para acessá-los; o Location pode ser definido em vez da pasta de saída.
Você pode obter os IDs de métricas/dimensões consultando exibições de métricas/dimensões.

SELECT Id, Name FROM Dimensions
SELECT Id, Name FROM Metrics

Por exemplo, para usar um novo esquema junto com os esquemas padrão, defina o Location para a subpasta db na pasta de instalação e faça a seguinte chamada:

EXEC CreateReport Dimensions = 'Country, City', DimensionIds = 'variables/geocountry, variables/geocity', Metrics = 'PageViews, Visits', MetricIds = 'metrics/pageviews, metrics/visits', TableName = 'MyCustomReport'

Dimensões e métricas devem ter seus respectivos IDs especificados nas entradas DimensionIds e MetricIds.

Entrada
Nome Tipo Obrigatório Descrição
TableName String Verdade O nome da nova tabela.
Description String Falso Uma descrição opcional para a tabela.
OutputFolder String Falso O caminho para o qual enviar o novo arquivo de esquema. O valor da propriedade da string de conexão Location será usado por padrão. Você precisará definir a propriedade de conexão Location para o local de seus arquivos de esquema.
DimensionIds String Verdade Uma lista separada por vírgulas de IDs de dimensões.
MetricIds String Verdade Uma lista separada por vírgulas de IDs de métricas.
Colunas do conjunto de resultados
Nome Tipo Descrição
Success String Se o esquema foi criado com sucesso ou não.
SchemaFile String O arquivo de esquema gerado.

GetOAuthAccessToken

Obtém um token de autenticação do AdobeAnalytics.

Entrada
Nome Tipo Obrigatório Descrição
AuthMode String Falso O tipo de modo de autenticação a ser usado. Selecione App para obter tokens de autenticação por meio de um aplicativo de desktop. Selecione Web para obter tokens de autenticação por meio de um aplicativo Web. Os valores permitidos são APP, WEB. O valor padrão é APP.
Scopes String Falso Uma lista separada por vírgulas de permissões a serem solicitadas ao usuário. Verifique a API do AdobeAnalytics para obter uma lista de permissões disponíveis. O valor padrão é openid, AdobeID, read_organizations, adicionais_info.job_function, adicionais_info.projectedProductContext.
CallbackUrl String Falso A URL para a qual o usuário será redirecionado após autorizar seu aplicativo. Esse valor deve corresponder à URL de redirecionamento que você especificou nas configurações do aplicativo AdobeAnalytics. Necessário apenas quando o parâmetro Authmode for Web.
Verifier String Falso O verificador retornou do AdobeAnalytics depois que o usuário autorizou seu aplicativo a ter acesso aos seus dados. Esse valor será retornado como um parâmetro para a URL de retorno de chamada.
State String Falso Indica qualquer estado que pode ser útil para sua aplicação após o recebimento da resposta. Seu aplicativo recebe o mesmo valor que enviou, pois esse parâmetro faz uma viagem de ida e volta ao servidor de autorização do AdobeAnalytics. Os usos incluem redirecionar o usuário para o recurso correto em seu site, nonces e mitigações de falsificação de solicitação entre sites.
Colunas do conjunto de resultados
Nome Tipo Descrição
OAuthAccessToken String O token de acesso usado para comunicação com o AdobeAnalytics.
OAuthRefreshToken String O token de atualização OAuth. É o mesmo que o token de acesso no caso do AdobeAnalytics.
ExpiresIn String O tempo de vida restante no token de acesso. Um -1 denota que não irá expirar.

GetOAuthAuthorizationURL

Obtém a URL de autorização que deve ser aberta separadamente pelo usuário para conceder acesso ao seu aplicativo. Necessário apenas ao desenvolver aplicativos da Web. Você solicitará o OAuthAccessToken deste URL.

Entrada
Nome Tipo Obrigatório Descrição
CallbackUrl String Falso A URL para a qual o usuário será redirecionado após autorizar seu aplicativo. Esse valor deve corresponder ao URL de redirecionamento nas configurações do aplicativo AdobeAnalytics.
Scopes String Falso Uma lista separada por vírgulas de escopos a serem solicitados ao usuário. Verifique a documentação da API AdobeAnalytics para obter uma lista de permissões disponíveis. O valor padrão é openid, AdobeID, read_organizations, adicionais_info.job_function, adicionais_info.projectedProductContext.
State String Falso Indica qualquer estado que pode ser útil para sua aplicação após o recebimento da resposta. Seu aplicativo recebe o mesmo valor que enviou, pois esse parâmetro faz uma viagem de ida e volta ao servidor de autorização do AdobeAnalytics. Os usos incluem redirecionar o usuário para o recurso correto em seu site, nonces e mitigações de falsificação de solicitação entre sites.
Colunas do conjunto de resultados
Nome Tipo Descrição
URL String O URL de autorização, inserido em um navegador da Web para obter o token do verificador e autorizar seu aplicativo.

RefreshOAuthAccessToken

O Adobe Analytics não oferece suporte ao token de atualização. Portanto, este procedimento armazenado* chamará o procedimento GetOAuthAccessToken internamente, para iniciar o fluxo OAuth desde o início.

Entrada
Nome Tipo Obrigatório Descrição
OAuthRefreshToken String Falso Defina isso para algum valor de teste. Não fará diferença, pois esse procedimento iniciará o fluxo OAuth desde o início. O valor padrão é teste.
Colunas do conjunto de resultados
Nome Tipo Descrição
OAuthAccessToken String O token de autenticação retornado do AdobeAnalytics. Isso pode ser usado em chamadas subseqüentes para outras operações para este serviço específico.
ExpiresIn String O tempo de vida restante no token de acesso.

Tabelas do sistema

Você pode consultar as tabelas do sistema descritas nesta seção para acessar informações de esquema, informações sobre a funcionalidade da fonte de dados e estatísticas de operação em lote.

Tabelas de esquema

As tabelas a seguir retornam metadados de banco de dados para o Adobe Analytics:

Tabelas de fonte de dados

As tabelas a seguir retornam informações sobre como se conectar e consultar a fonte de dados:

  • sys_connection_props: Retorna informações sobre as propriedades de conexão disponíveis.
  • sys_sqlinfo: Descreve as consultas SELECT que o conector pode descarregar para a fonte de dados.

Consultar tabelas de informações

A tabela a seguir retorna estatísticas de consultar para consultas de modificação de dados:

  • sys_identity: Retorna informações sobre operações em lote ou atualizações únicas.

sys_catalogs

Lista os bancos de dados disponíveis.

A consultar a seguir recupera todos os bancos de dados determinados pela string de conexão:

SELECT * FROM sys_catalogs
Colunas
Nome Tipo Descrição
CatalogName String O nome do banco de dados.

sys_schemas

Lista os esquemas disponíveis.

A consultar a seguir recupera todos os esquemas disponíveis:

SELECT * FROM sys_schemas
Colunas
Nome Tipo Descrição
CatalogName String O nome do banco de dados.
SchemaName String O nome do esquema.

sys_tables

Lista as tabelas disponíveis.

A consultar a seguir recupera as tabelas e exibições disponíveis:

SELECT * FROM sys_tables
Colunas
Nome Tipo Descrição
CatalogName String O banco de dados que contém a tabela ou exibição.
SchemaName String O esquema que contém a tabela ou exibição.
TableName String O nome da tabela ou exibição.
TableType String O tipo de tabela (tabela ou exibição).
Description String Uma descrição da tabela ou exibição.
IsUpdateable Boolean Se a tabela pode ser atualizada.

sys_tablecolumns

Descreve as colunas das tabelas e exibições disponíveis.

A consultar a seguir retorna as colunas e os tipos de dados da tabela SampleTable_1:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='SampleTable_1' 
Colunas
Nome Tipo Descrição
CatalogName String O nome do banco de dados que contém a tabela ou exibição.
SchemaName String O esquema que contém a tabela ou exibição.
TableName String O nome da tabela ou exibição que contém a coluna.
ColumnName String O nome da coluna.
DataTypeName String O nome do tipo de dados.
DataType Int32 Um número inteiro indicando o tipo de dados. Esse valor é determinado no tempo de execução com base no ambiente.
Length Int32 O tamanho de armazenamento da coluna.
DisplaySize Int32 A largura máxima normal da coluna designada em caracteres.
NumericPrecision Int32 O número máximo de dígitos em dados numéricos. O comprimento da coluna em caracteres para caracteres e dados de data e hora.
NumericScale Int32 A escala da coluna ou o número de dígitos à direita do ponto decimal.
IsNullable Boolean Se a coluna pode conter null.
Description String Uma breve descrição da coluna.
Ordinal Int32 O número de sequência da coluna.
IsAutoIncrement String Se o valor da coluna é atribuído em incrementos fixos.
IsGeneratedColumn String Se a coluna é gerada.
IsHidden Boolean Se a coluna está oculta.
IsArray Boolean Se a coluna é uma matriz.

sys_procedures

Lista os procedimentos armazenados disponíveis.

A consultar a seguir recupera os procedimentos armazenados disponíveis:

SELECT * FROM sys_procedures
Colunas
Nome Tipo Descrição
CatalogName String O banco de dados que contém o procedimento armazenado.
SchemaName String O esquema que contém o procedimento armazenado.
ProcedureName String O nome do procedimento armazenado.
Description String Uma descrição do procedimento armazenado.
ProcedureType String O tipo do procedimento, como PROCEDURE ou FUNCTION.

sys_procedureparameters

Descreve procedimento armazenado* parâmetros.

A consultar a seguir retorna informações sobre todos os parâmetros de entrada para o procedimento armazenado SampleProcedure:

SELECT * FROM sys_procedureparameters WHERE ProcedureName='SampleProcedure' AND Direction=1 OR Direction=2
Colunas
Nome Tipo Descrição
CatalogName String O nome do banco de dados que contém o procedimento armazenado.
SchemaName String O nome do esquema que contém o procedimento armazenado.
ProcedureName String O nome do procedimento armazenado* contendo o parâmetro.
ColumnName String O nome do procedimento armazenado* parâmetro.
Direction Int32 Um número inteiro correspondente ao tipo do parâmetro: entrada (1), entrada/saída (2) ou saída (4). parâmetros de tipo de entrada/saída podem ser parâmetros de entrada e saída.
DataTypeName String O nome do tipo de dados.
DataType Int32 Um número inteiro indicando o tipo de dados. Esse valor é determinado no tempo de execução com base no ambiente.
Length Int32 O número de caracteres permitido para dados de caractere. O número de dígitos permitidos para dados numéricos.
NumericPrecision Int32 A precisão máxima para dados numéricos. O comprimento da coluna em caracteres para caracteres e dados de data e hora.
NumericScale Int32 O número de dígitos à direita do ponto decimal em dados numéricos.
IsNullable Boolean Se o parâmetro pode conter null.
IsRequired Boolean Se o parâmetro é necessário para a execução do procedimento.
IsArray Boolean Se o parâmetro é uma matriz.
Description String A descrição do parâmetro.
Ordinal Int32 O índice do parâmetro.

sys_keycolumns

Descreve as chaves primárias e estrangeiras. A consultar a seguir recupera a chave primária da tabela SampleTable_1:

SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='SampleTable_1'
Colunas
Nome Tipo Descrição
CatalogName String O nome do banco de dados que contém a chave.
SchemaName String O nome do esquema que contém a chave.
TableName String O nome da tabela que contém a chave.
ColumnName String O nome da coluna chave.
IsKey Boolean Se a coluna é uma chave primária na tabela referenciada no campo TableName.
IsForeignKey Boolean Se a coluna é uma chave estrangeira referenciada no campo TableName.
PrimaryKeyName String O nome da chave primária.
ForeignKeyName String O nome da chave estrangeira.
ReferencedCatalogName String O banco de dados que contém a chave primária.
ReferencedSchemaName String O esquema que contém a chave primária.
ReferencedTableName String A tabela que contém a chave primária.
ReferencedColumnName String O nome da coluna da chave primária.

sys_foreignkeys

Descreve as chaves estrangeiras. A consultar a seguir recupera todas as chaves estrangeiras que se referem a outras tabelas:

SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
Colunas
Nome Tipo Descrição
CatalogName String O nome do banco de dados que contém a chave.
SchemaName String O nome do esquema que contém a chave.
TableName String O nome da tabela que contém a chave.
ColumnName String O nome da coluna chave.
PrimaryKeyName String O nome da chave primária.
ForeignKeyName String O nome da chave estrangeira.
ReferencedCatalogName String O banco de dados que contém a chave primária.
ReferencedSchemaName String O esquema que contém a chave primária.
ReferencedTableName String A tabela que contém a chave primária.
ReferencedColumnName String O nome da coluna da chave primária.
ForeignKeyType String Designa se a chave estrangeira é uma chave de importação (aponta para outras tabelas) ou de exportação (referenciada de outras tabelas).

sys_indexes

Descreve os índices disponíveis. Ao filtrar por índices, você pode escrever consultas mais seletivas com tempos de resposta de consultar mais rápidos.

A consultar a seguir recupera todos os índices que não são chaves primárias:

SELECT * FROM sys_indexes WHERE IsPrimary='false'
Colunas
Nome Tipo Descrição
CatalogName String O nome do banco de dados que contém o índice.
SchemaName String O nome do esquema que contém o índice.
TableName String O nome da tabela que contém o índice.
IndexName String O nome do índice.
ColumnName String O nome da coluna associada ao índice.
IsUnique Boolean True se o índice for exclusivo. Falso caso contrário.
IsPrimary Boolean Verdadeiro se o índice for uma chave primária. Falso caso contrário.
Type Int16 Um valor inteiro correspondente ao tipo de índice: estatística (0), agrupado (1), hash (2) ou outro (3).
SortOrder String A ordem de classificação: A para crescente ou D para decrescente.
OrdinalPosition Int16 O número de sequência da coluna no índice.

sys_connection_props

Retorna informações sobre as propriedades de conexão disponíveis e as definidas na string de conexão.

Ao consultar esta tabela, a string de conexão de configuração deve ser usada:

jdbc:cdata:adobeanalytics:config:

Esta string de conexão permite que você consultar esta tabela sem uma conexão válida.

A consultar a seguir recupera todas as propriedades de conexão que foram definidas na string de conexão ou definidas por meio de um valor padrão:

SELECT * FROM sys_connection_props WHERE Value <> ''
Colunas
Nome Tipo Descrição
Name String O nome da propriedade de conexão.
ShortDescription String Uma breve descrição.
Type String O tipo de dados da propriedade de conexão.
Default String O valor padrão, se não houver um definido explicitamente.
Values String Uma lista separada por vírgulas de valores possíveis. Um erro de validação é lançado se outro valor for especificado.
Value String O valor que você definiu ou um padrão pré-configurado.
Required Boolean Se a propriedade é necessária para se conectar.
Category String A categoria da propriedade de conexão.
IsSessionProperty String Se a propriedade é uma propriedade de sessão, usada para salvar informações sobre a conexão atual.
Sensitivity String O nível de sensibilidade da propriedade. Isso informa se a propriedade está ofuscada nos formulários de registro e autenticação.
PropertyName String Uma forma truncada em camel case do nome da propriedade de conexão.
Ordinal Int32 O índice do parâmetro.
CatOrdinal Int32 O índice da categoria do parâmetro.
Hierarchy String Mostra as propriedades dependentes associadas que precisam ser definidas juntamente com esta.
Visible Boolean Informa se a propriedade está visível na UI da conexão.
ETC String Diversas informações diversas sobre o imóvel.

sys_sqlinfo

Descreve o processamento da consultar SELECT que o conector pode transferir para a fonte de dados.

Processamento colaborativo de consultas

Ao trabalhar com fontes de dados que não suportam SQL-92, você pode consultar a exibição sys_sqlinfo para determinar os recursos de consultar das APIs subjacentes, expressas na sintaxe SQL. O conector transfere o máximo possível do processamento da instrução SELECT para o servidor e, em seguida, processa o restante da consultar na memória.

Descobrindo os recursos SELECT da fonte de dados

Abaixo está um exemplo de conjunto de dados de recursos SQL. O conjunto de resultados a seguir indica a funcionalidade SELECT que o conector pode descarregar para a fonte de dados ou processar o lado do cliente. Sua fonte de dados pode suportar sintaxe SQL adicional. Alguns aspectos da funcionalidade SELECT são retornados em uma lista separada por vírgulas, se suportados; caso contrário, a coluna contém NO.

Nome Descrição Valores Possíveis
AGGREGATE_FUNCTIONS Funções de agregação suportadas. AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT Se a função COUNT é suportada. YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR O caractere de abertura usado para escapar de um identificador. [
IDENTIFIER_QUOTE_CLOSE_CHAR O caractere de fechamento usado para escapar de um identificador. ]
SUPPORTED_OPERATORS Uma lista de operadores SQL com suporte. =, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY Se GROUP BY é compatível e, em caso afirmativo, o grau de suporte. NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
STRING_FUNCTIONS Funções de string suportadas. LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONS Funções numéricas suportadas. ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONS Funções de data/hora suportadas. NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLES Indica tabelas ignoradas durante a replicação.
REPLICATION_TIMECHECK_COLUMNS Uma matriz de string contendo uma lista de colunas que serão usadas para verificar (na ordem especificada) para usar como uma coluna modificada durante a replicação.
IDENTIFIER_PATTERN Valor de string que indica qual string é válida para um identificador.
SUPPORT_TRANSACTION Indica se o provedor oferece suporte a transações como confirmação e reversão. YES, NO
DIALECT Indica o dialeto SQL a ser usado.
KEY_PROPERTIES Indica as propriedades que identificam o banco de dados uniforme.
SUPPORTS_MULTIPLE_SCHEMAS Indica se vários esquemas podem existir para o provedor. YES, NO
SUPPORTS_MULTIPLE_CATALOGS Indica se vários catálogos podem existir para o provedor. YES, NO
DATASYNCVERSION A versão do Data Sync necessária para acessar este driver. Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY A categoria Data Sync deste driver. Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL Se a funcionalidade SQL aprimorada além do que é oferecido pela API é suportada. TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS Se as operações em lote são suportadas. YES, NO
SQL_CAP Todos os recursos SQL suportados para este driver. SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS Um valor de string especifica o cacheOptions preferencial.
ENABLE_EF_ADVANCED_QUERY Indica se o driver oferece suporte direto a consultas avançadas provenientes do Entity Framework. Caso contrário, as consultas serão tratadas no lado do cliente. YES, NO
PSEUDO_COLUMNS Uma matriz de cadeia de caracteres que indica as pseudocolunas disponíveis.
MERGE_ALWAYS Se o valor for verdadeiro, o modo de mesclagem será executado à força no Data Sync. TRUE, FALSE
REPLICATION_MIN_DATE_QUERY Uma consultar de seleção para retornar a data e hora de início da replicação.
REPLICATION_MIN_FUNCTION Permite que um provedor especifique o nome da fórmula a ser usado para executar um min do lado do servidor.
REPLICATION_START_DATE Permite que um provedor especifique uma data de início de replicação.
REPLICATION_MAX_DATE_QUERY Uma consultar de seleção para retornar a data e hora de término da replicação.
REPLICATION_MAX_FUNCTION Permite que um provedor especifique o nome da fórmula a ser usado para executar um máximo do lado do servidor.
IGNORE_INTERVALS_ON_INITIAL_REPLICATE Uma lista de tabelas que ignorará a divisão da replicação em blocos na replicação inicial.
CHECKCACHE_USE_PARENTID Indica se a instrução CheckCache deve ser executada na coluna de chave pai. TRUE, FALSE
CREATE_SCHEMA_PROCEDURES Indica procedimentos armazenados* que pode ser usado para gerar arquivos de esquema.

A consultar a seguir recupera os operadores que podem ser usados na cláusula WHERE:

SELECT * FROM sys_sqlinfo WHERE Name='SUPPORTED_OPERATORS'

Observe que tabelas individuais podem ter diferentes limitações ou requisitos na cláusula WHERE; consulte o Modelo de Dados para obter mais informações.

Colunas
Nome Tipo Descrição
NAME String Um componente da sintaxe SQL ou um recurso que pode ser processado no servidor.
VALUE String Detalhes sobre a sintaxe SQL ou SQL suportada.

sys_identity

Retorna informações sobre tentativas de modificação.

A consultar a seguir recupera os IDs das linhas modificadas em uma operação em lote:

SELECT * FROM sys_identity
Colunas
Nome Tipo Descrição
Id String O ID gerado pelo banco de dados retornado de uma operação de modificação de dados.
Batch String Um identificador para o lote. 1 para uma única operação.
Operation String O resultado da operação no lote: INSERTED, UPDATED ou DELETED.
Message String SUCCESS ou uma mensagem de erro se a atualização no lote falhou.

Propriedades de configurações avançadas

As propriedades de configurações avançadas são as várias opções que podem ser usadas para estabelecer uma conexão. Esta seção fornece uma lista completa das opções que você pode configurar. Clique nos links para mais detalhes.

Autenticação

Propriedade Descrição
AuthScheme O tipo de autenticação a ser usado ao conectar-se ao Adobe Analytics.
GlobalCompanyId O identificador da sua empresa. Se não for definido, o driver tentará detectá-lo automaticamente.
RSID Seu identificador do conjunto de relatórios. Se não for definido, o driver tentará detectá-lo automaticamente.

OAuth

Propriedade Descrição
InitiateOAuth Configure esta propriedade para iniciar o processo para obter ou atualizar o token de acesso OAuth ao se conectar.
OAuthClientId O ID do cliente atribuído quando você registra seu aplicativo com um servidor de autorização OAuth.
OAuthClientSecret O segredo do cliente atribuído quando você registra seu aplicativo com um servidor de autorização OAuth.
OAuthAccessToken O token de acesso para conexão usando OAuth.
CallbackURL O URL de retorno de chamada OAuth ao qual retornar durante a autenticação. Esse valor deve corresponder ao URL de retorno especificado nas configurações do aplicativo.
OAuthVerifier O código do verificador retornado da URL de autorização OAuth.
OAuthRefreshToken O token de atualização OAuth para o token de acesso OAuth correspondente.
OAuthExpiresIn O tempo de vida em segundos do OAuth AccessToken.
OAuthTokenTimestamp O registro de data e hora da época do Unix em milissegundos quando o token de acesso atual foi criado.

JWT OAuth

Propriedade Descrição
OAuthJWTCert A loja de certificados JWT.
OAuthJWTCertType O tipo de armazenamento de chaves que contém o certificado JWT.
OAuthJWTCertPassword A senha para o certificado OAuth JWT.
OAuthJWTCertSubject O assunto do certificado OAuth JWT.
OAuthJWTIssuer O emissor do Java Web Token.
OAuthJWTSubject O assunto do usuário para o qual o aplicativo está solicitando acesso delegado.

SSL

Propriedade Descrição
SSLServerCert O certificado a ser aceito do servidor ao conectar usando TLS/SSL.

Esquema

Propriedade Descrição
Location Um caminho para o diretório que contém os arquivos de esquema que definem tabelas, exibições e procedimentos armazenados.
BrowsableSchemas Essa propriedade restringe os esquemas relatados a um subconjunto dos esquemas disponíveis. Por exemplo, BrowsableSchemas=SchemaA, SchemaB, SchemaC.
Tables Esta propriedade restringe as tabelas reportadas a um subconjunto das tabelas disponíveis. Por exemplo, Tables=TableA, TableB, TableC.
Views Restringe as exibições relatadas a um subconjunto das tabelas disponíveis. Por exemplo, Views=ViewA, ViewB, ViewC.

Diversos

Propriedade Descrição
MaxRows Limita o número de linhas retornadas quando nenhuma agregação ou agrupamento é usado na consultar. Isso ajuda a evitar problemas de desempenho em tempo de design.
Other Essas propriedades ocultas são usadas apenas em casos de uso específicos.
Pagesize O número máximo de resultados a serem retornados por página do Adobe Analytics.
PseudoColumns Esta propriedade indica se deve ou não incluir pseudocolunas como colunas na tabela.
Timeout O valor em segundos até que o erro de timeout seja lançado, cancelando a operação.

Autenticação

Esta seção fornece uma lista completa de propriedades de autenticação que você pode configurar.

Propriedade Descrição
AuthScheme O tipo de autenticação a ser usado ao conectar-se ao Adobe Analytics.
GlobalCompanyId O identificador da sua empresa. Se não for definido, o driver tentará detectá-lo automaticamente.
RSID Seu identificador do conjunto de relatórios. Se não for definido, o driver tentará detectá-lo automaticamente.

AuthScheme

O tipo de autenticação a ser usado ao conectar-se ao Adobe Analytics.

Valores possíveis

Auto, OAuth, OAuthJWT

Tipo de dados

string

Valor padrão

"Auto"

Observações
  • Auto: permite que o driver decida automaticamente com base nas outras propriedades de conexão que você definiu.
  • OAuth: Defina para executar a autenticação OAuth usando uma conta de usuário padrão.
  • OAuthJWT: defina para executar a autenticação OAuth usando uma conta de serviço OAuth.

GlobalCompanyId

O identificador da sua empresa. Se não for definido, o driver tentará detectá-lo automaticamente.

Tipo de dados

string

Valor padrão

""

Observações

O identificador da sua empresa. Se não for definido, o driver tentará detectá-lo automaticamente.

RSID

Seu identificador do conjunto de relatórios. Se não for definido, o driver tentará detectá-lo automaticamente.

Tipo de dados

string

Valor padrão

""

Observações

Seu identificador do conjunto de relatórios. Se não for definido, o driver tentará detectá-lo automaticamente.

OAuth

Esta seção fornece uma lista completa de propriedades OAuth que você pode configurar.

Propriedade Descrição
InitiateOAuth Configure esta propriedade para iniciar o processo para obter ou atualizar o token de acesso OAuth ao se conectar.
OAuthClientId O ID do cliente atribuído quando você registra seu aplicativo com um servidor de autorização OAuth.
OAuthClientSecret O segredo do cliente atribuído quando você registra seu aplicativo com um servidor de autorização OAuth.
OAuthAccessToken O token de acesso para conexão usando OAuth.
CallbackURL O URL de retorno de chamada OAuth ao qual retornar durante a autenticação. Esse valor deve corresponder ao URL de retorno especificado nas configurações do aplicativo.
OAuthVerifier O código do verificador retornado da URL de autorização OAuth.
OAuthRefreshToken O token de atualização OAuth para o token de acesso OAuth correspondente.
OAuthExpiresIn O tempo de vida em segundos do OAuth AccessToken.
OAuthTokenTimestamp O registro de data e hora da época do Unix em milissegundos quando o token de acesso atual foi criado.

InitiateOAuth

Configure esta propriedade para iniciar o processo para obter ou atualizar o token de acesso OAuth ao se conectar.

Valores Possíveis

OFF, GETANDREFRESH, REFRESH

Tipo de dados

string

Valor padrão

"OFF"

Observações

As seguintes opções estão disponíveis:

  1. OFF: Indica que o fluxo OAuth será tratado inteiramente pelo usuário. Um OAuthAccessToken será necessário para autenticação.
  2. GETANDREFRESH: Indica que todo o fluxo OAuth será tratado pelo conector. Se nenhum token existir atualmente, ele será obtido solicitando ao usuário por meio do navegador. Se existir um token, ele será atualizado quando aplicável.
  3. REFRESH: Indica que o conector tratará apenas da atualização do OAuthAccessToken. O usuário nunca será solicitado pelo conector a autenticar por meio do navegador. O usuário deve manipular a obtenção do OAuthAccessToken e OAuthRefreshToken inicialmente.

OAuthClientId

O ID do cliente atribuído quando você registra seu aplicativo com um servidor de autorização OAuth.

Tipo de dados

string

Valor padrão

""

Observações

Como parte do registro de um aplicativo OAuth, você receberá o OAuthClientId valor, às vezes também chamado de chave do consumidor, e um segredo do cliente, o OAuthClientSecret.

OAuthClientSecret

O segredo do cliente atribuído quando você registra seu aplicativo com um servidor de autorização OAuth.

Tipo de dados

string

Valor padrão

""

Observações

Como parte do registro de um aplicativo OAuth, você receberá o OAuthClientId, também chamada de chave do consumidor. Você também receberá um segredo do cliente, também chamado de segredo do consumidor. Defina o segredo do cliente no OAuthClientSecret propriedade.

OAuthAccessToken

O token de acesso para conexão usando OAuth.

Tipo de dados

string

Valor padrão

""

Observações

O OAuthAccessToken propriedade é usada para conectar usando OAuth. O OAuthAccessToken é recuperado do servidor OAuth como parte do processo de autenticação. Ele tem um tempo limite dependente do servidor e pode ser reutilizado entre as solicitações.

O token de acesso é usado no lugar do seu nome de usuário e senha. O token de acesso protege suas credenciais, mantendo-as no servidor.

CallbackURL

O URL de retorno de chamada OAuth para o qual retornar durante a autenticação. Esse valor deve corresponder ao URL de retorno de chamada especificado nas configurações do aplicativo.

Tipo de dados

string

Valor Padrão

"http://localhost:33333"

Observações

Durante o processo de autenticação, o servidor de autorização OAuth redireciona o usuário para esta URL. Esse valor deve corresponder ao URL de retorno especificado nas configurações do aplicativo.

OAuthVerifier

O código do verificador retornado da URL de autorização OAuth.

Tipo de dados

string

Valor padrão

""

Observações

O código do verificador retornado da URL de autorização OAuth. Isso pode ser usado em sistemas em que um navegador não pode ser iniciado, como sistemas headless.

Autenticação em máquinas sem cabeça

Consulte para obter o OAuthVerifier valor.

Defina OAuthSettingsLocation juntamente com OAuthVerifier. Quando você conecta, o conector troca o OAuthVerifier para os tokens de autenticação OAuth e os salva, criptografados, no arquivo especificado. Definir InitiateOAuth para GETANDREFRESH automatizar a troca.

Depois que o arquivo de configurações OAuth for gerado, você poderá remover OAuthVerifier nas propriedades de conexão e conecte-se com OAuthSettingsLocation definir.

Para atualizar automaticamente os valores do token OAuth, defina OAuthSettingsLocation e adicionalmente defina InitiateOAuth para ATUALIZAR.

OAuthRefreshToken

O token de atualização OAuth para o token de acesso OAuth correspondente.

Tipo de dados

string

Valor padrão

""

Observações

O OAuthRefreshToken a propriedade é usada para atualizar o OAuthAccessToken ao usar a autenticação OAuth.

OAuthExpiresIn

O tempo de vida em segundos do OAuth AccessToken.

Tipo de dados

string

Valor padrão

""

Observações

Emparelhe com OAuthTokenTimestamp para determinar quando o AccessToken expirará.

OAuthTokenTimestamp

O registro de data e hora da época do Unix em milissegundos quando o token de acesso atual foi criado.

Tipo de dados

string

Valor padrão

""

Observações

Emparelhe com OAuthExpiresIn para determinar quando o AccessToken expirará.

JWT OAuth

Esta seção fornece uma lista completa das propriedades JWT OAuth que você pode configurar.

Propriedade Descrição
OAuthJWTCert A loja de certificados JWT.
OAuthJWTCertType O tipo de armazenamento de chaves que contém o certificado JWT.
OAuthJWTCertPassword A senha para o certificado OAuth JWT.
OAuthJWTCertSubject O assunto do certificado OAuth JWT.
OAuthJWTIssuer O emissor do Java Web Token.
OAuthJWTSubject O assunto do usuário para o qual o aplicativo está solicitando acesso delegado.

OAuthJWTCert

A loja de certificados JWT.

Tipo de dados

string

Valor padrão

""

Observações

O nome do armazenamento de certificados para o certificado do cliente.

O OAuthJWTCertType campo especifica o tipo de armazenamento de certificado especificado por OAuthJWTCert. Se o armazenamento estiver protegido por senha, especifique a senha em OAuthJWTCertPassword.

OAuthJWTCert é usado em conjunto com o OAuthJWTCertSubject para especificar os certificados do cliente. Se OAuthJWTCert tem um valor e OAuthJWTCertSubject for definido, uma pesquisa por um certificado será iniciada. Consulte OAuthJWTCertSubject para obter detalhes.

As designações de armazenamentos de certificados dependem da plataforma.

A seguir estão as designações dos armazenamentos de certificados de Usuário e Máquina mais comuns no Windows:

Propriedade Descrição
MY Um armazenamento de certificados que contém certificados pessoais com suas chaves privadas associadas.
CA Certificados de autoridade certificadora.
ROOT Certificados raiz.
SPC Certificados de editor de software.

Em Java, o armazenamento de certificados normalmente é um arquivo contendo certificados e chaves privadas opcionais.

Quando o tipo de armazenamento de certificado for PFXFile, essa propriedade deverá ser configurada para o nome do arquivo. Quando o tipo é PFXBlob, a propriedade deve ser configurada para o conteúdo binário de um arquivo PFX (ou seja, armazenamento de certificados PKCS12).

OAuthJWTCertType

O tipo de armazenamento de chaves que contém o certificado JWT.

Valores possíveis

USER, MACHINE, PFXFILE, PFXBLOB, JKSFILE, JKSBLOB, PEMKEY_FILE, PEMKEY_BLOB, PUBLIC_KEY_FILE, PUBLIC_KEY_BLOB, SSHPUBLIC_KEY_FILE, SSHPUBLIC_KEY_BLOB, P7BFILE, PPKFILE, XMLFILE, XMLBLOB

Tipo de dados

string

Valor padrão

"PEMKEY_FILE"

Observações

Esta propriedade pode assumir um dos seguintes valores:

Propriedade Descrição
USER Para Windows, isso especifica que o armazenamento de certificados é um armazenamento de certificados pertencente ao usuário atual. Nota: Este tipo de loja não está disponível em Java.
MACHINE Para Windows, isso especifica que o armazenamento de certificados é um armazenamento de máquina. Nota: este tipo de loja não está disponível em Java.
PFXFILE O armazenamento de certificados é o nome de um arquivo PFX (PKCS12) que contém certificados.
PFXBLOB O armazenamento de certificados é uma string (codificada em base 64) que representa um armazenamento de certificados no formato PFX (PKCS12).
JKSFILE O armazenamento de certificados é o nome de um arquivo de armazenamento de chaves Java (JKS) que contém certificados. Nota: este tipo de loja só está disponível em Java.
JKSBLOB O armazenamento de certificados é uma sequência (codificada em base 64) que representa um armazenamento de certificados no formato Java key store (JKS). Nota: este tipo de loja só está disponível em Java.
PEMKEY_FILE O armazenamento de certificados é o nome de um arquivo codificado por PEM que contém uma chave privada e um certificado opcional.
PEMKEY_BLOB O armazenamento de certificados é uma string (codificada em base64) que contém uma chave privada e um certificado opcional.
PUBLIC_KEY_FILE O armazenamento de certificados é o nome de um arquivo que contém um certificado de chave pública codificado por PEM ou DER.
PUBLIC_KEY_BLOB O armazenamento de certificados é uma string (codificada em base 64) que contém um certificado de chave pública codificado em PEM ou DER.
SSHPUBLIC_KEY_FILE O armazenamento de certificados é o nome de um arquivo que contém uma chave pública de estilo SSH.
SSHPUBLIC_KEY_BLOB O armazenamento de certificados é uma string (codificada em base 64) que contém uma chave pública de estilo SSH.
P7BFILE O armazenamento de certificados é o nome de um arquivo PKCS7 contendo certificados.
PPKFILE O armazenamento de certificados é o nome de um arquivo que contém um PPK (PuTTY Private Key).
XMLFILE O armazenamento de certificados é o nome de um arquivo que contém um certificado no formato XML.
XMLBLOB O armazenamento de certificados é uma string que contém um certificado no formato XML.

OAuthJWTCertPassword

A senha para o certificado OAuth JWT.

Tipo de dados

string

Valor padrão

""

Observações

Se o armazenamento de certificados for de um tipo que requer uma senha, essa propriedade será usada para especificar essa senha para abrir o armazenamento de certificados.

OAuthJWTCertSubject

O assunto do certificado OAuth JWT.

Tipo de dados

string

Valor padrão

"\*"

Observações

Ao carregar um certificado, o assunto é usado para localizar o certificado na loja.

Se uma correspondência exata não for encontrada, a loja é pesquisada em busca de assuntos que contenham o valor da propriedade.

Se uma correspondência ainda não for encontrada, a propriedade será definida como uma string vazia e nenhum certificado será selecionado.

O valor especial "*" seleciona o primeiro certificado no armazenamento de certificados.

O assunto do certificado é uma lista separada por vírgulas de campos e valores de nomes distintos. Por exemplo, "CN=www.server.com, OU=test, C=US, E=support@jitterbit.com". Os campos comuns e seus significados são exibidos abaixo.

Campo Significado
CN Nome comum. Geralmente, é um nome de hospedar como www.server.com.
O Organização
OU Unidade Organizacional
L Localidade
S Estado
C País
E Endereço E-mail

Se um valor de campo contiver uma vírgula, ela deverá ser colocada entre aspas.

OAuthJWTIssuer

O emissor do Java Web Token.

Tipo de dados

string

Valor padrão

""

Observações

O emissor do Java Web Token. Normalmente, é o ID do cliente ou o endereço E-mail do aplicativo OAuth.

OAuthJWTSubject

O assunto do usuário para o qual o aplicativo está solicitando acesso delegado.

Tipo de dados

string

Valor padrão

""

Observações

O assunto do usuário para o qual o aplicativo está solicitando acesso delegado. Normalmente, o nome da conta do usuário ou endereço e-mail.

SSL

Esta seção fornece uma lista completa de propriedades SSL que você pode configurar.

Propriedade Descrição
SSLServerCert O certificado a ser aceito do servidor ao conectar usando TLS/SSL.

SSLServerCert

O certificado a ser aceito do servidor ao conectar usando TLS/SSL.

Tipo de dados

string

Valor padrão

""

Observações

Se estiver usando uma conexão TLS/SSL, esta propriedade pode ser usada para especificar o certificado TLS/SSL a ser aceito do servidor. Qualquer outro certificado que não seja confiável para a máquina é rejeitado.

Esta propriedade pode assumir as seguintes formas:

Descrição Exemplo
Um certificado PEM completo (exemplo abreviado para concisão) -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
Um caminho para um arquivo local contendo o certificado C:\cert.cer
A chave pública (exemplo abreviado para concisão) -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
O Thumbprint MD5 (os valores hexadecimais também podem ser separados por espaço ou dois-pontos) ecadbdda5a1529c58a1e9e09828d70e4
A impressão digital SHA1 (os valores hexadecimais também podem ser separados por espaço ou dois-pontos) 34a929226ae0819f2ec14b4a3d904f801cbb150d

Se não for especificado, qualquer certificado confiável pela máquina será aceito.

Os certificados são validados como confiáveis pela máquina com base no armazenamento confiável do sistema. O armazenamento confiável usado é o valor 'javax.net.ssl.trustStore' especificado para o sistema. Se nenhum valor for especificado para esta propriedade, o armazenamento confiável padrão do Java será usado (por exemplo, JAVA_HOME\lib\security\cacerts).

Use '*' para indicar a aceitação de todos os certificados. Observe que isso não é recomendado devido a questões de segurança.

Esquema

Esta seção fornece uma lista completa de propriedades de esquema que você pode configurar.

Propriedade Descrição
Location Um caminho para o diretório que contém os arquivos de esquema que definem tabelas, exibições e procedimentos armazenados.
BrowsableSchemas Essa propriedade restringe os esquemas relatados a um subconjunto dos esquemas disponíveis. Por exemplo, BrowsableSchemas=SchemaA, SchemaB, SchemaC.
Tables Esta propriedade restringe as tabelas reportadas a um subconjunto das tabelas disponíveis. Por exemplo, Tables=TableA, TableB, TableC.
Views Restringe as exibições relatadas a um subconjunto das tabelas disponíveis. Por exemplo, Views=ViewA, ViewB, ViewC.

Localização

Um caminho para o diretório que contém os arquivos de esquema que definem tabelas, exibições e procedimentos armazenados.

Tipo de dados

string

Valor padrão

"%APPDATA%\\\AdobeAnalytics Data Provider\\Schema"

Observações

O caminho para um diretório que contém os arquivos de esquema para o conector (arquivos .rsd para tabelas e exibições, arquivos .rsb para procedimentos armazenados). A localização da pasta pode ser um caminho relativo a partir da localização do executável. O Location a propriedade só é necessária se você quiser personalizar definições (por exemplo, alterar um nome de coluna, ignorar uma coluna e assim por diante) ou estender o modelo de dados com novas tabelas, exibições ou procedimentos armazenados.

Se não for especificado, o local padrão é "%APPDATA%\\AdobeAnalytics Data Provider\Schema" com %APPDATA% sendo definido para o diretório de configuração do usuário:

Plataforma %APPDATA%
Windows O valor da variável de ambiente APPDATA
Mac ~/Biblioteca/Suporte de aplicativos
Linux ~/.config

BrowsableSchemas

Essa propriedade restringe os esquemas relatados a um subconjunto dos esquemas disponíveis. Por exemplo, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Tipo de dados

string

Valor padrão

""

Observações

Listar os esquemas de bancos de dados pode ser caro. Fornecer uma lista de esquemas na string de conexão melhora o desempenho.

Tabelas

Esta propriedade restringe as tabelas reportadas a um subconjunto das tabelas disponíveis. Por exemplo, Tabelas=TabelaA,TabelaB,TabelaC.

Tipo de dados

string

Valor padrão

""

Observações

Listar as tabelas de alguns bancos de dados pode ser caro. Fornecer uma lista de tabelas na string de conexão melhora o desempenho do conector.

Essa propriedade também pode ser usada como uma alternativa para listar automaticamente as exibições se você já souber com quais deseja trabalhar e, caso contrário, haveria muitos para trabalhar.

Especifique as tabelas que deseja em uma lista separada por vírgulas. Cada tabela deve ser um identificador SQL válido com quaisquer caracteres especiais escapados usando colchetes, aspas duplas ou acentos graves. Por exemplo, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Observe que, ao conectar-se a uma fonte de dados com vários esquemas ou catálogos, você precisará fornecer o nome totalmente qualificado da tabela nesta propriedade, como no último exemplo aqui, para evitar ambigüidade entre tabelas que existem em vários catálogos ou esquemas.

Visualizações

Restringe as visualizações relatadas a um subconjunto das tabelas disponíveis. Por exemplo, Views=ViewA,ViewB,ViewC.

Tipo de dados

string

Valor padrão

""

Observações

Listar as exibições de alguns bancos de dados pode ser caro. Fornecer uma lista de exibições na string de conexão melhora o desempenho do conector.

Essa propriedade também pode ser usada como uma alternativa para listar automaticamente as exibições se você já souber com quais deseja trabalhar e, caso contrário, haveria muitos para trabalhar.

Especifique as exibições desejadas em uma lista separada por vírgulas. Cada exibição deve ser um identificador SQL válido com quaisquer caracteres especiais escapados usando colchetes, aspas duplas ou acentos graves. Por exemplo, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Observe que, ao conectar-se a uma fonte de dados com vários esquemas ou catálogos, você precisará fornecer o nome totalmente qualificado da tabela nesta propriedade, como no último exemplo aqui, para evitar ambigüidade entre tabelas que existem em vários catálogos ou esquemas.

Diversos

Esta seção fornece uma lista completa de diversas propriedades que você pode configurar.

Propriedade Descrição
MaxRows Limita o número de linhas retornadas quando nenhuma agregação ou agrupamento é usado na consultar. Isso ajuda a evitar problemas de desempenho em tempo de design.
Other Essas propriedades ocultas são usadas apenas em casos de uso específicos.
Pagesize O número máximo de resultados a serem retornados por página do Adobe Analytics.
PseudoColumns Esta propriedade indica se deve ou não incluir pseudocolunas como colunas na tabela.
Timeout O valor em segundos até que o erro de timeout seja lançado, cancelando a operação.

MaxRows

Limita o número de linhas retornadas quando nenhuma agregação ou agrupamento é usado na consultar. Isso ajuda a evitar problemas de desempenho em tempo de design.

Tipo de dados

int

Valor padrão

-1

Observações

Limita o número de linhas retornadas quando nenhuma agregação ou agrupamento é usado na consultar. Isso ajuda a evitar problemas de desempenho em tempo de design.

Outro

Essas propriedades ocultas são usadas apenas em casos de uso específicos.

Tipo de dados

string

Valor padrão

""

Observações

As propriedades listadas abaixo estão disponíveis para casos de uso específicos. Casos de uso de driver normal e funcionalidade não devem exigir essas propriedades.

Especifique várias propriedades em uma lista separada por ponto e vírgula.

Integração e Formatação
Propriedade Descrição
DefaultColumnSize Define o comprimento padrão dos campos de string quando a fonte de dados não fornece o comprimento da coluna nos metadados. O valor padrão é 2000. Voltar para o início
ConvertDateTimeToGMT Determina se os valores de data e hora devem ser convertidos em GMT, em vez da hora local da máquina.
RecordToFile=filename Registra a transferência de dados do soquete subjacente para o arquivo especificado.

Tamanho da página

O número máximo de resultados a serem retornados por página do Adobe Analytics.

Tipo de dados

int

Valor padrão

50

Observações

O Pagesize propriedade afeta o número máximo de resultados a serem retornados por página do Adobe Analytics. Definir um valor mais alto pode resultar em melhor desempenho ao custo de memória adicional alocada por página consumida.

PseudoColumns

Esta propriedade indica se deve ou não incluir pseudocolunas como colunas na tabela.

Tipo de dados

string

Valor padrão

""

Observações

Essa configuração é particularmente útil no Entity Framework, que não permite definir um valor para uma pseudocoluna, a menos que seja uma coluna de tabela. O valor dessa configuração de conexão está no formato "Table1=Column1, Table1=Column2, Table2=Column3". Você pode usar o caractere "*" para incluir todas as tabelas e todas as colunas; por exemplo, "*=*".

Tempo limite

O valor em segundos até que o erro de timeout seja lançado, cancelando a operação.

Tipo de dados

int

Valor padrão

60

Observações

Se Timeout = 0, as operações não expiram. As operações são executadas até serem concluídas com êxito ou até encontrarem uma condição de erro.

Se Timeout expira e a operação ainda não está concluída, o conector lança uma exceção.