Detalhes da Conexão do YouTube Analytics
Introdução
Versão do conector
Esta documentação é baseada na versão 22.0.8510 do conector.
Começando
Suporte à versão do YouTube Analytics
O conector usa a versão 2 da API do YouTube Analytics.
Estabelecendo uma Conexão
Conectando-se ao YouTube Analytics
Forneça as seguintes propriedades de conexão antes de adicionar as propriedades de autenticação.
ChannelId
: Definido como o ID de um canal do YouTube. Se não for especificado, os dados serão retornados para o canal do usuário autenticado.ContentOwnerId
: Defina se você deseja gerar relatórios do proprietário do conteúdo.
Autenticação no YouTube Analytics
Todas as conexões com o YouTube Analytics são autenticadas usando OAuth. O conector oferece suporte ao uso de contas de usuário, contas de serviço e contas de instância do GCP para autenticação.
Contas de Usuário
AuthScheme
deve ser definido como OAuth
em todos os fluxos da conta do usuário. Para aplicativos de desktop, o aplicativo incorporado do conector é a maneira mais simples de autenticação. O único requisito adicional é definir InitiateOAuth
para GETANDREFRESH
.
Quando o driver iniciar, ele abrirá um navegador e o YouTube Analytics solicitará suas informações de login. O conector usará as credenciais que você fornecer para acessar seus dados do YouTube Analytics. Essas credenciais serão salvas e atualizadas automaticamente conforme necessário. Para aplicativos de desktop, o aplicativo padrão do conector é a maneira mais simples de autenticação. O único requisito adicional é definir InitiateOAuth
para GETANDREFRESH
.
Quando o driver iniciar, ele abrirá um navegador e o YouTube Analytics solicitará suas informações de login. O conector usará as credenciais fornecidas por você para acessar seus dados do YouTube Analytics. Essas credenciais serão salvas e atualizadas automaticamente conforme necessário.
Contas de Serviço
Para autenticar usando uma conta de serviço, você deve criar uma nova conta de serviço e ter uma cópia do certificado de contas.
Para um arquivo JSON, você precisará definir estas propriedades:
AuthScheme
: Obrigatório. Defina isso comoOAuthJWT
.InitiateOAuth
: Obrigatório. Defina isso comoGETANDREFRESH
.OAuthJWTCertType
: Obrigatório. Defina isso comoGOOGLEJSON
.OAuthJWTCert
: Obrigatório. Defina isso como o caminho para o arquivo .json fornecido pelo Google.OAuthJWTSubject
: Opcional. Defina esse valor apenas se a conta de serviço fizer parte de um domínio G Suite e você quiser habilitar a delegação. O valor desta propriedade deve ser o endereço e-mail do usuário cujos dados você deseja acessar.
Para um arquivo PFX, você precisará definir estas propriedades:
AuthScheme
: Obrigatório. Defina isso comoOAuthJWT
.InitiateOAuth
: Obrigatório. Defina isso comoGETANDREFRESH
.OAuthJWTCertType
: Obrigatório. Defina isso comoPFXFILE
.OAuthJWTCert
: Obrigatório. Defina isso como o caminho para o arquivo .pfx fornecido pelo Google.OAuthJWTCertPassword
: Opcional. Defina isso como a senha do arquivo .pfx. Na maioria dos casos, isso precisará ser fornecido, pois o Google criptografa os certificados PFX.OAuthJWTCertSubject
: Opcional. Defina isso apenas se você estiver usando umOAuthJWTCertType
que armazena vários certificados. Não deve ser definido para certificados PFX gerados pelo Google.OAuthJWTIssuer
: Obrigatório. Defina isso como o endereço e-mail da conta de serviço. Este endereço geralmente incluirá o domínioiam.gserviceaccount.com
.OAuthJWTSubject
: Opcional. Defina esse valor apenas se a conta de serviço fizer parte de um domínio G Suite e você quiser habilitar a delegação. O valor desta propriedade deve ser o endereço e-mail do usuário cujos dados você deseja acessar.
Se você ainda não tiver uma conta de serviço, poderá criar uma seguindo o procedimento em Criando um aplicativo personalizado do Microsoft Entra ID.
Contas de Instância do GCP
Ao executar em uma máquina virtual GCP, o conector pode autenticar usando uma conta de serviço vinculada à máquina virtual. Para usar este modo, defina AuthScheme
para GCPInstanceAccount
.
Usando Autenticação OAuth
Use o padrão de autenticação OAuth para se conectar ao YouTube Analytics. Você pode autenticar com uma conta de usuário ou uma conta de serviço. O conector facilita isso conforme descrito abaixo.
Contas de Usuário
O fluxo da conta do usuário exige que o usuário autenticado interaja com o YouTube Analytics por meio do navegador.
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
Em vez de se conectar com as credenciais incorporadas do conector, você pode registrar um aplicativo para obter o OAuthClientId
e OAuthClientSecret
.
Quando Criar um Aplicativo OAuth Personalizado
A criação de um aplicativo OAuth personalizado é opcional, pois o conector já está registrado no YouTube Analytics e você pode se conectar com suas credenciais incorporadas. Talvez você queira criar um aplicativo OAuth personalizado para alterar as informações exibidas quando os usuários fazem login no endpoint OAuth do YouTube Analytics para conceder permissões ao conector.
Usando uma Conta de Serviço para Se Conectar ao YouTube Analytics
As contas de serviço têm autenticação silenciosa, sem autenticação do usuário no navegador. Você também pode usar uma conta de serviço para delegar escopos de acesso em toda a empresa ao conector.
Você precisa criar um aplicativo OAuth neste fluxo. Você pode se conectar aos dados do YouTube Analytics que a conta de serviço tem permissão para acessar. Consulte Credenciais personalizadas para obter um guia de autenticação.
Criando um Aplicativo OAuth Personalizado
Consulte Criando um aplicativo OAuth personalizado para um procedimento.
Credenciais Incorporadas
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 oOAuthAccessToken
.ChannelId
: Defina para o ID de um canal do YouTube. Se não for especificado, os dados serão retornados para o canal do usuário autenticado.ContentOwnerId
: Defina para o ID do proprietário do conteúdo se desejar gerar relatórios do proprietário do conteúdo.
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.
- Extrai o token de acesso do URL de retorno de chamada e autentica as solicitações.
- Obtém um novo token de acesso quando o antigo expira.
- Salva valores OAuth em
OAuthSettingsLocation
para ser persistido nas conexões.
Credenciais Personalizadas
Você pode usar um aplicativo OAuth personalizado para autenticar com uma conta de serviço ou uma conta de usuário. Consulte Usando autenticação OAuth Para maiores informações.
Contas de Usuário
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.InitiateOAuth
: Defina como GETANDREFRESH. Você pode usar InitiateOAuth para evitar repetir a troca de OAuth e configurar manualmente oOAuthAccessToken
.ChannelId
: Defina para o ID de um canal do YouTube. Se não for especificado, os dados serão retornados para o canal do usuário autenticado.ContentOwnerId
: Defina se deseja gerar relatórios de proprietário de conteúdo.
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:
- Extrai o token de acesso da URL de retorno de chamada e autentica as solicitações.
- Atualiza o token de acesso quando ele expira.
- Salva valores OAuth em
OAuthSettingsLocation
para ser persistido nas conexões.
Contas de Serviço
As contas de serviço têm autenticação silenciosa, sem autenticação do usuário no navegador. Você também pode usar uma conta de serviço para delegar escopos de acesso em toda a empresa ao conector.
Você precisa criar um aplicativo OAuth neste fluxo. Consulte Criando um aplicativo OAuth personalizado para criar e autorizar um aplicativo. Você pode se conectar aos dados do YouTube 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 isso como o ID do cliente nas configurações do aplicativo.OAuthClientSecret
: Defina isso como o segredo do cliente nas configurações do aplicativo.OAuthJWTCertType
: Defina isso como "PEMKEY_FILE".OAuthJWTCert
: Defina isso como o caminho para o arquivo .pem que você gerou.OAuthJWTCertPassword
: Defina isso como a senha do arquivo .pem.OAuthJWTCertSubject
: Defina como "*" para escolher o primeiro certificado no armazenamento de certificados.OAuthJWTSubject
: Defina como o endereço e-mail do usuário para quem o aplicativo está solicitando acesso delegado. Observe que o acesso delegado deve ser concedido por um administrador.ChannelId
: Defina para o ID de um canal do YouTube. Se não for especificado, os dados serão retornados para o canal do usuário autenticado.ContentOwnerId
: Defina se deseja gerar relatórios de proprietário de conteúdo.
Quando você conecta, o conector conclui o fluxo OAuth para uma conta de serviço.
- Cria e assina o JWT com o conjunto de declarações exigido pelo conector.
- Troca o JWT pelo token de acesso.
- Salva valores OAuth em
OAuthSettingsLocation
para ser persistido nas conexões. - Envia o JWT para um novo token de acesso quando o token expira.
Máquinas Sem Cabeça
Usando OAuth em uma Máquina Sem Cabeça
As seções a seguir mostram como autenticar um servidor headless ou outra máquina na qual o conector não pode abrir um navegador. Você pode autenticar com uma conta de usuário ou com uma conta de serviço.
Contas de Usuário
Para autenticar com uma conta de usuário, você precisa autenticar de outra máquina. A autenticação é um processo de duas etapas.
- 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. - 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 incorporadas do conector ou usando as credenciais OAuth para seu aplicativo OAuth personalizado.
Usando as Credenciais OAuth Incorporadas
Obtenha um código verificador
Siga as etapas abaixo para autenticar em outra máquina e obter o OAuthVerifier
propriedade da conexão:
- Clique no link a seguir para abrir o endpoint OAuth do YouTube Analytics em seu navegador.
- Efetue 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.
- 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.
OAuthVerifier
: Defina isso para o código do verificador.InitiateOAuth
: Configure para ATUALIZAR.OAuthSettingsLocation
: Defina para manter os valores de autenticação OAuth criptografados no arquivo especificado.
Depois que o arquivo de configurações OAuth for gerado, defina as seguintes propriedades para se conectar aos dados:
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 conector para habilitar a atualização automática do token de acesso.InitiateOAuth
: Configure para ATUALIZAR.ChannelId
: Defina para o ID de um canal do YouTube. Se não for especificado, os dados serão retornados para o canal do usuário autenticado.ContentOwnerId
: Defina para o ID do proprietário do conteúdo se desejar gerar relatórios do proprietário do conteúdo.
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.
Teste a conexão para autenticar no navegador. 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:
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.ChannelId
: Defina para o ID de um canal do YouTube. Se não for especificado, os dados serão retornados para o canal do usuário autenticado.ContentOwnerId
: Defina para o ID do proprietário do conteúdo se desejar gerar relatórios do proprietário do conteúdo.
Usando as Credenciais para um Aplicativo OAuth Personalizado
Crie um aplicativo OAuth personalizado
A criação de um aplicativo OAuth customizado é opcional no fluxo OAuth headless; você pode ignorar a criação de um aplicativo conectando-se com as credenciais OAuth incorporadas do conector. Talvez você queira criar um aplicativo OAuth personalizado para alterar as informações exibidas quando os usuários fazem login no YouTube 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.
- 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.
- 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.
- 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
: Defina como REFRESH.
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.ChannelId
: Defina para o ID de um canal do YouTube. Se não for especificado, os dados serão retornados para o canal do usuário autenticado.ContentOwnerId
: Defina para o ID do proprietário do conteúdo se desejar gerar relatórios do proprietário do conteúdo.
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.
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.ChannelId
: Defina para o ID de um canal do YouTube. Se não for especificado, os dados serão retornados para o canal do usuário autenticado.ContentOwnerId
: Defina para o ID do proprietário do conteúdo se desejar gerar relatórios do proprietário do conteúdo.
Contas de Serviço
As contas de serviço têm autenticação silenciosa, sem autenticação do usuário no navegador. Você também pode usar uma conta de serviço para delegar escopos de acesso em toda a empresa ao conector.
Você precisa criar um aplicativo OAuth neste fluxo. Consulte Criando um aplicativo OAuth personalizado para criar e autorizar um aplicativo. Você pode se conectar aos dados do YouTube 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 isso como o ID do cliente nas configurações do aplicativo.OAuthClientSecret
: Defina isso como o segredo do cliente nas configurações do aplicativo.OAuthJWTCertType
: Defina isso como "PEMKEY_FILE".OAuthJWTCert
: Defina isso como o caminho para o arquivo .pem que você gerou.OAuthJWTCertPassword
: Defina isso como a senha do arquivo .pem.OAuthJWTCertSubject
: Defina como "*" para escolher o primeiro certificado no armazenamento de certificados.OAuthJWTSubject
: Defina isso para sua ID corporativa se seu tipo de entidade estiver definido como "corporativo" ou sua ID de usuário do aplicativo se seu tipo de entidade estiver definido como "usuário".ChannelId
: Defina para o ID de um canal do YouTube. Se não for especificado, os dados serão retornados para o canal do usuário autenticado.ContentOwnerId
: Defina para o ID do proprietário do conteúdo se desejar gerar relatórios do proprietário do conteúdo.
Quando você conecta, o conector conclui o fluxo OAuth para uma conta de serviço.
- Cria e assina o JWT com o conjunto de declarações exigido pelo conector.
- Troca o JWT pelo token de acesso.
- Salva valores OAuth em
OAuthSettingsLocation
para ser persistido nas conexões. - Envia o JWT para um novo token de acesso quando o token expira.
Criando um Aplicativo OAuth Personalizado
Você pode usar um aplicativo OAuth personalizado para autenticar uma conta de serviço ou uma conta de usuário. Consulte Usando autenticação OAuth Para maiores informações.
Crie um Aplicativo OAuth para Autenticação de Conta de Usuário
Siga o procedimento abaixo para registrar um aplicativo e obter o OAuthClientId
e OAuthClientSecret
.
Crie um Aplicativo OAuth Personalizado: Área de Trabalho
- Faça login no Google API Console e abra um projeto. Selecione o API Manager no menu principal.
- No fluxo de consentimento do usuário, clique em Credenciais -> Criar credenciais -> ID do cliente OAuth. Clique em Outro. Depois de criar o aplicativo, o
OAuthClientId
eOAuthClientSecret
Estão exibidas. - Clique em Biblioteca -> API do YouTube Analytics -> Ativar API.
Crie um Aplicativo OAuth para Autenticação de Conta de Serviço
Siga as etapas abaixo para criar um aplicativo OAuth e gerar uma chave privada. Em seguida, você autorizará a conta de serviço.
- Faça login no Google API Console e abra um projeto. Selecione o API Manager no menu principal.
- Clique em Criar credenciais -> Chave da conta de serviço.
- No menu Conta de serviço, selecione Nova conta de serviço ou selecione uma conta de serviço existente.
- Se estiver criando uma nova conta de serviço, selecione adicionalmente uma ou mais funções. Você pode atribuir funções primitivas no nível do projeto na seção IAM e Admin; outras funções permitem que você personalize ainda mais o acesso às APIs do Google.
- Na seção Tipo de chave, selecione o tipo de chave P12.
- Crie o aplicativo para baixar o par de chaves. A senha da chave privada é exibida: Defina isso em
OAuthJWTCertPassword
. - Na seção de contas de serviço, clique em Gerenciar contas de serviço e defina
OAuthJWTIssuer
para o endereço e-mail exibido no campo ID da conta de serviço. - Clique em Biblioteca -> API do YouTube Analytics -> Ativar API.
Recuperando Dados do YouTube Analytics
Os dados do YouTube Analytics são organizados em várias métricas (Viewers, ViewerPercentage, AgeGroup etc.), que podem ser consultadas em várias dimensões (Day, DeviceType etc.). Existem muitas combinações válidas de métricas e dimensões. O conector mostra algumas das combinações mais usadas como exibições relacionais para facilidade de uso.
Além disso, o conector permite consultar todas as combinações válidas, mesmo aquelas não incluídas nas visualizações predefinidas. Você pode usar o CreateCustomSchema procedimento armazenado* para criar uma exibição em uma consultar. Consulte Modelo de Dados para saber como combinar métricas e dimensões em consultas e esquemas. Abaixo está um guia para começar com as exibições padrão.
Selecionando Dimensões e Medidas
A dimensão e as métricas são claramente definidas para cada tabela e podem ser vistas no Modelo de Dados: Basta selecionar as métricas e as dimensões nas quais você está interessado. Por exemplo, os principais vídeos de um canal por mais minutos assistidos em um país específico podem ser selecionados da seguinte forma:
SELECT Video, Views, EstimatedMinutesWatched, AverageViewDuration, AverageViewPercentage FROM TopVideos WHERE Country='AL'
Executando Consultas SELECT *
Ao contrário da maioria das tabelas de banco de dados, não é muito útil selecionar todas as métricas e dimensões em uma determinada tabela. O conector, portanto, interpreta a consultar SELECT * para significar que um conjunto padrão de métricas e dimensões é solicitado. Isso inclui consultas que selecionam explicitamente todas as colunas. Consulte a documentação da exibição individual em Modelo de dados para ver quais campos são o padrão para cada esquema.
Recursos avançados
Esta seção detalha uma seleção de recursos avançados do conector do YouTube Analytics.
Visualizações definidas pelo usuário
O conector permite definir tabelas virtuais, denominadas visualizaçõ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.
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.
Processamento de consulta
O conector transfere o máximo possível do processamento da instrução SELECT para o YouTube Analytics e, em seguida, processa o restante da consultar na memória (do lado do cliente).
Consulte Processamento de consultas Para maiores informações.
Exibições definidas pelo usuário
O Jitterbit Connector for YouTube 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 exibiçã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 Groups 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"
Definindo exibições usando instruções DDL
O conector também é capaz de criar e alterar o esquema por meio de instruções DDL, como CREATE LOCAL VIEW, ALTER LOCAL VIEW e DROP LOCAL VIEW.
Crie uma visualização
Para criar uma nova visualização usando instruções DDL, forneça o nome da visualização e a consultar da seguinte forma:
CREATE LOCAL VIEW [MyViewName] AS SELECT * FROM Customers LIMIT 20;
Se não existir nenhum arquivo JSON, o código acima criará um. A exibição é então criada no arquivo de configuração JSON e agora pode ser descoberta. O local do arquivo JSON é especificado pelo UserDefinedViews
propriedade de conexão.
Alterar uma visualização
Para alterar uma exibição existente, forneça o nome de uma exibição existente ao lado da nova consultar que você gostaria de usar:
ALTER LOCAL VIEW [MyViewName] AS SELECT * FROM Customers WHERE TimeModified > '3/1/2020';
A exibição é atualizada no arquivo de configuração JSON.
Solte uma visualização
Para descartar uma exibição existente, forneça o nome de um esquema existente ao lado da nova consultar que você gostaria de usar.
DROP LOCAL VIEW [MyViewName]
Isso remove a visualização do arquivo de configuração JSON. Não pode mais ser consultado.
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 visualizaçõ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 bem mais complexos. Todas as operações SQL são permitidas em ambas as consultas e são combinadas quando apropriado.
Modelo de Dados
O conector Jitterbit para YouTube Analytics modela entidades do YouTube Analytics em tabelas relacionais, exibições e procedimentos armazenados. O YouTube Analytics permite que dimensões e métricas sejam consultadas em um grande número de arranjos. Algumas exibições de amostra são fornecidas com base em relatórios comuns do YouTube Analytics. No entanto, você também pode criar suas próprias exibições personalizadas com base em qualquer combinação de dimensões e métricas necessárias.
A criação de esquemas de exibição, bem como as limitações e os requisitos da API, estão documentados nesta seção.
Mesas
Você pode acessar Grupos e Itens de Grupo como Tabelas.
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 YouTube 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. O provedor, portanto, interpreta a consultar SELECT * para significar que um conjunto padrão de métricas e dimensões é solicitado. Isso inclui consultas que selecionam explicitamente todas as colunas.
Além disso, a API do YouTube Analytics limita o número e as combinações de colunas que podem ser projetadas sobre os dados ou usadas para restringir os resultados retornados. Você pode encontrar essas limitações e os campos padrão para cada esquema em Visualizações. Consulte também essas seções ao definir sua própria exibição.
Definindo exibições personalizadas
Para criar uma exibição em uma consultar, você pode usar o CreateCustomSchema procedimento armazenado. O CreateCustomSchema 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 exibição, uma lista separada por vírgulas de métricas, uma lista separada por vírgulas de dimensões 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.
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 CreateCustomSchema Dimensions='Day,DeviceType', Metrics='Views,EstimatedMinutesWatched', TableName='DailyDeviceReports'
Tabelas
O conector modela os dados no YouTube Analytics em uma lista de tabelas que podem ser consultadas usando instruções SQL padrão.
Geralmente, consultar tabelas do YouTube Analytics é o mesmo que consultar uma tabela em um banco de dados relacional. Às vezes, há casos especiais, por exemplo, incluir uma determinada coluna na cláusula WHERE pode ser necessário para obter dados para determinadas colunas na tabela. Isso geralmente é necessário para situações em que uma solicitação separada deve ser feita para cada linha para obter determinadas colunas. Esses tipos de situações estão claramente documentados na parte superior da página da tabela vinculada abaixo.
Conector Jitterbit para tabelas do YouTube Analytics
Nome | Descrição |
---|---|
GroupItems | Crie, exclua e consultar Itens que compõem um Grupo. |
Groups | Crie, atualize, exclua e consultar grupos do YouTube Analytics. |
GroupItems
Crie, exclua e consultar Itens que compõem um Grupo.
Informações específicas da tabela
Selecione
A consultar a seguir retorna os itens que compõem os grupos do YouTube Analytics:
SELECT * FROM GroupItems
A consultar a seguir retorna os itens que compõem um grupo específico do YouTube Analytics:
SELECT * FROM GroupItems WHERE GroupId='239_65GrkKS6kRL'
Além disso, OnBehalfOfContentOwner pode opcionalmente ser usado na cláusula WHERE.
Inserir
GroupId e Resource_Id são necessários para inserir um Item em um Grupo.
INSERT INTO GroupItems (GroupId, Resource_Id) VALUES ('fjgeeljgio54','dkhgjio5sfff')
Colunas
Nome | Tipo | Somente leitura | Descrição |
---|---|---|---|
Id [KEY] | String | Verdadeiro | O ID que o YouTube usa para identificar exclusivamente o canal, vídeo, lista de reprodução ou recurso incluído no grupo. Observe que esse ID refere-se especificamente à inclusão dessa entidade em um determinado grupo e é diferente do ID do canal, ID do vídeo, ID da lista de reprodução ou ID do recurso que identifica exclusivamente a própria entidade. |
Kind | String | Falso | Identifica o tipo do item do grupo. O valor será youtube#groupItem. |
Etag | String | Falso | A Etag deste item. |
GroupId | String | Falso | O ID que o YouTube usa para identificar exclusivamente o grupo que contém o item. |
Resource_Kind | String | Falso | O tipo do item do grupo. Os valores permitidos são youtube#channel, youtube#playlist, youtube#video, youtubePartner#asset. |
Resource_Id | String | Falso | O canal, vídeo, lista de reprodução ou ID do recurso que o YouTube usa para identificar exclusivamente o item do grupo. |
OnBehalfOfContentOwner | String | Falso | Este parâmetro destina-se exclusivamente a parceiros de conteúdo do YouTube que possuem e gerenciam muitos canais diferentes do YouTube. O parâmetro OnBehalfOfContentOwner indica que as credenciais de autorização na solicitação identificam um usuário do YouTube que está agindo em nome do proprietário do conteúdo especificado no valor do parâmetro. |
Grupos
Crie, atualize, exclua e consultar grupos do YouTube Analytics.
Informações específicas da tabela
Um grupo é uma coleção personalizada de até 200 canais, vídeos, listas de reprodução ou ativos. Todos os Itens em um Grupo devem representar o mesmo tipo de entidade. Por exemplo, você não pode criar um grupo que contenha 100 vídeos e 100 listas de reprodução. Um grupo analítico pode conter apenas entidades que você carregou ou reivindicou ou que estão vinculadas a um canal que você administra. Como resultado, os proprietários de conteúdo podem criar grupos de vídeos, listas de reprodução, canais ou ativos. Os proprietários de canais podem criar grupos de vídeos e listas de reprodução.
Selecione
As seguintes colunas podem ser usadas na cláusula WHERE: OnBehalfOfContentOwner e Mine.
Inserir
ContentDetails_ItemType é necessário para inserir um grupo.
INSERT INTO Groups (Snippet_Title, ContentDetails_ItemType) VALUES ('test2', 'youtube#channel')
Colunas
Nome | Tipo | Somente leitura | Descrição |
---|---|---|---|
Id [KEY] | String | Falso | O ID que o YouTube usa para identificar exclusivamente o grupo. |
Kind | String | Falso | Identifica o tipo de entidade do YouTube Analytics. O valor será youtube#group. |
Etag | String | Falso | A Etag deste recurso. |
Snippet_PublishedAt | DateTime | Verdadeiro | A data e a hora em que o grupo foi criado. |
Snippet_Title | String | Falso | O nome do grupo. O valor deve ser uma string não vazia. |
ContentDetails_ItemCount | String | Falso | O número de itens no grupo. |
ContentDetails_ItemType | String | Falso | O tipo de entidades que o grupo contém. Os valores permitidos são youtube#channel, youtube#playlist, youtube#video, youtubePartner#asset. |
Mine | String | Falso | Defina como true para recuperar todos os grupos pertencentes ao usuário autenticado. |
PageToken | String | Falso | O parâmetro PageToken identifica uma página específica no conjunto de resultados que deve ser retornada. |
OnBehalfOfContentOwner | String | Falso | Este parâmetro destina-se exclusivamente a parceiros de conteúdo do YouTube que possuem e gerenciam muitos canais diferentes do YouTube. O parâmetro OnBehalfOfContentOwner indica que as credenciais de autorização na solicitação identificam um usuário do YouTube que está agindo em nome do proprietário do conteúdo especificado no valor do parâmetro. |
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.
Visualizações dinâmicas, como consultas expostas como visualizações e visualizações para procurar combinações específicas de itens de trabalho project_team são suportadas.
Conector Jitterbit para visualizações do YouTube Analytics
Nome | Descrição |
---|---|
Activities | Consultar atividades do YouTube. Um recurso de atividade contém informações sobre uma ação que um determinado canal ou usuário realizou no YouTube. |
AdPerformanceReports | Consultar relatórios de desempenho de anúncios. Os Relatórios de desempenho de anúncios fornecem métricas baseadas em impressões para anúncios executados durante reproduções de vídeo. Essas métricas representam cada impressão de anúncio e cada reprodução de vídeo pode render várias impressões. |
Captions | Consultar legendas do YouTube. Um recurso Caption representa uma faixa de legenda do YouTube. |
Channels | Consultar canais do YouTube. |
ChannelSections | Consulte as seções do canal do YouTube. Uma ChannelSection contém informações sobre um conjunto de vídeos que um canal escolheu apresentar. |
Comments | Consultar comentários do YouTube. |
CommentThreads | Consulte tópicos de comentários do YouTube. Um registro CommentThread contém informações sobre um tópico de comentários do YouTube, um comentário de nível superior e respostas, se houver, a esse comentário. |
Demographics | Consulte os dados demográficos do YouTubeAnalytics agrupados por faixa etária e sexo. |
Devices | Consulte estatísticas de dispositivos ou sistemas operacionais do YouTubeAnalytics. Essa tabela permite agregar estatísticas de exibição com base na maneira como os espectadores acessaram o conteúdo do seu vídeo. Por exemplo, você pode identificar o número de visualizações que ocorreram em dispositivos móveis ou consoles de jogos. |
EngagementReports | Consulte as informações dos Relatórios de engajamento. Por exemplo, quantas vezes um usuário compartilhou um vídeo. |
Languages | Consulta YouTube i18nLanguages. Um recurso i18nLanguage identifica um idioma de aplicativo compatível com o site do YouTube. O idioma do aplicativo também pode ser chamado de idioma da interface do usuário. |
PlayListItems | Consulta YouTube PlayListItems. Um recurso PlayListItem identifica outra entidade do YouTube, como um vídeo, incluído em uma PlayList. Além disso, o registro PlayListItem contém detalhes sobre como essa entidade é usada nessa PlayList. |
PlayLists | Consulte listas de reprodução do YouTube. Uma PlayList é uma coleção de vídeos que podem ser visualizados sequencialmente e compartilhados com outros usuários. |
Regions | Consulta YouTube i18nRegions. Um recurso i18nRegion identifica uma área geográfica que um usuário do YouTube pode selecionar como a região de conteúdo preferencial. A região de conteúdo também pode ser chamada de localidade de conteúdo. |
Subscriptions | Consultar assinaturas de usuários do YouTube. Uma assinatura notifica um usuário quando novos vídeos são adicionados a um canal ou quando outro usuário executa uma das várias ações no YouTube, como enviar um vídeo, avaliar um vídeo ou comentar um vídeo. |
TimeBasedReports | Consulte informações baseadas em tempo sobre visualizações, inscritos, etc. Por exemplo, quantos novos inscritos foram obtidos em um horário específico. |
TopVideos | Consulte os TopVideos de um canal ou as TopPlaylists se você for um proprietário de conteúdo. Você também pode usar esta exibição para consultar detalhes de reprodução e filtros geográficos. |
TrafficSources | Consulta TrafficSources. As estatísticas são baseadas na maneira como os espectadores acessaram seu conteúdo de vídeo e lista de reprodução. |
VideoAbuseReportReasons | Consulte YouTube VideoAbuseReportReasons. Um recurso VideoAbuseReportReason contém informações sobre o motivo pelo qual um vídeo seria sinalizado por conter conteúdo abusivo. |
VideoCategories | Consultar categorias de vídeo do YouTube. Um recurso VideoCategory identifica uma categoria que foi ou pode ser associada a vídeos enviados. |
Videos | Consultar vídeos do YouTube. |
Atividades
Consultar atividades do YouTube. Um recurso de atividade contém informações sobre uma ação que um determinado canal ou usuário realizou no YouTube.
Informações específicas da tabela
Selecione
O YouTube Analytics permite que apenas um subconjunto de colunas seja usado como critério de filtro. Você pode especificar exatamente uma das seguintes colunas: ChannelId ou Home. Além disso, as colunas extras opcionais com suporte são PublishedAt e Region.
Todas as colunas suportam o operador '='. PublishedAt também suporta '>', '>=', '<' e '<='.
Por padrão, se nenhum filtro for especificado, o driver retornará as atividades geradas pelo usuário autenticado.
SELECT * FROM Activities WHERE Home = true LIMIT 2
SELECT * FROM Activities WHERE ChannelId = "abc123" AND PublishedAt < '2016-01-01T10:00:00Z'
Colunas
Nome | Tipo | Dimensão | Métrica Padrão | Dimensão padrão | Descrição |
---|---|---|---|---|---|
Id [KEY] | String | O ID que o YouTube usa para identificar exclusivamente a atividade. | |||
PublishedAt | Datetime | A data e a hora em que a atividade ocorreu. O valor está no formato ISO 8601 (AAAA-MM-DDThhss.sZ). | |||
ChannelId | String | O ID que o YouTube usa para identificar exclusivamente o canal associado à atividade. | |||
Title | String | O título do recurso associado principalmente à atividade. | |||
Description | String | A descrição do recurso associado principalmente à atividade. | |||
ChannelTitle | String | Título do canal para o canal responsável por esta atividade. | |||
Type | String | O tipo de atividade que o recurso descreve. Valores válidos: channelItem, comment (não retornado no momento), favorito, like, playlistItem, recomendação, social, assinatura e upload. | |||
GroupId | String | O ID do grupo associado à atividade. | |||
ThumbnailsDefaultUrl | String | A URL da miniatura da imagem padrão. | |||
UploadVideoId | String | O ID que o YouTube usa para identificar exclusivamente o vídeo enviado. | |||
LikeResourceIdKind | String | O tipo de recurso que recebeu uma avaliação positiva (curtir). | |||
LikeResourceIdVideoId | String | O ID que o YouTube usa para identificar exclusivamente o vídeo, se o recurso avaliado for um vídeo. Esta coluna só estará presente se ResourceIdKind for youtube#video. | |||
FavoriteResourceIdKind | String | O tipo de entidade do YouTube marcada como favorita. | |||
FavoriteResourceIdVideoId | String | O ID que o YouTube usa para identificar exclusivamente o vídeo favorito. | |||
CommentResourceIdKind | String | O comentário sobre o recurso da API. | |||
CommentResourceIdVideoId | String | O ID que o YouTube usa para identificar exclusivamente o vídeo associado a um comentário. | |||
CommentResourceIdChannelId | String | O ID que o YouTube usa para identificar exclusivamente o canal associado a um comentário. | |||
SubscriptionResourceIdKind | String | O tipo da assinatura. Uma assinatura é um canal no qual um usuário se inscreveu. | |||
SubscriptionResourceIdChannelId | String | O ID que o YouTube usa para identificar exclusivamente o canal no qual o usuário se inscreveu. | |||
PlaylistItemResourceIdKind | String | O tipo do item da lista de reprodução. | |||
PlaylistItemResourceIdVideoId | String | O ID que o YouTube usa para identificar exclusivamente o vídeo que foi adicionado à lista de reprodução. | |||
PlaylistItemPlaylistId | String | O valor que o YouTube usa para identificar exclusivamente a lista de reprodução. | |||
PlaylistItemPlaylistItemId | String | O valor que o YouTube usa para identificar exclusivamente o item na lista de reprodução. | |||
RecommendationResourceIdKind | String | O tipo da recomendação. | |||
RecommendationResourceIdVideoId | String | O ID que o YouTube usa para identificar exclusivamente o vídeo, se o recurso recomendado for um vídeo. | |||
RecommendationResourceIdChannelId | String | O ID que o YouTube usa para identificar exclusivamente o canal, se o recurso recomendado for um canal. | |||
RecommendationReason | String | O motivo pelo qual a entidade do YouTube foi recomendada ao usuário. Valores válidos para esta coluna: não especificado, videoFavorited, videoLiked e videoWatched. | |||
RecommendationSeedResourceIdKind | String | O tipo de entidade do YouTube que causou a recomendação. | |||
RecommendationSeedResourceIdVideoId | String | O ID que o YouTube usa para identificar exclusivamente o vídeo, caso a recomendação tenha sido causada por um determinado vídeo. | |||
RecommendationSeedResourceIdChannelId | String | O ID que o YouTube usa para identificar exclusivamente o canal, caso a recomendação tenha sido causada por um canal específico. | |||
RecommendationSeedResourceIdPlaylistId | String | O ID que o YouTube usa para identificar exclusivamente a lista de reprodução, se a recomendação for causada por uma lista de reprodução específica. | |||
SocialType | String | O nome da postagem na rede social. Valores válidos para esta coluna: facebook, googlePlus, twitter e não especificado. | |||
SocialResourceIdKind | String | O tipo de postagem na rede social. | |||
SocialResourceIdVideoId | String | O ID que o YouTube usa para identificar exclusivamente o vídeo apresentado em uma postagem de rede social, se a postagem se referir a um vídeo. | |||
SocialResourceIdChannelId | String | O ID que o YouTube usa para identificar exclusivamente o canal apresentado em uma postagem de rede social, se a postagem se referir a um canal. | |||
SocialResourceIdPlaylistId | String | O ID que o YouTube usa para identificar exclusivamente a lista de reprodução apresentada em uma postagem na rede social. | |||
SocialAuthor | String | O autor da postagem na rede social. | |||
SocialReferenceUrl | String | A URL da postagem na rede social. | |||
SocialImageUrl | String | Uma imagem do autor do post. | |||
ChannelItemResourceId | String | O ID da entidade do YouTube que foi adicionada ao canal. |
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 |
---|---|---|
Region | String | Instrui a API a filtrar por região. O valor do parâmetro é um código de país ISO 3166-1 alfa-2. |
AdPerformanceReports
Consultar relatórios de desempenho de anúncios. Os Relatórios de desempenho de anúncios fornecem métricas baseadas em impressões para anúncios executados durante reproduções de vídeo. Essas métricas representam cada impressão de anúncio e cada reprodução de vídeo pode render várias impressões.
Informações específicas da tabela
Selecione
Obtenha receita bruta para um vídeo em um país específico agrupado por tipo de anúncio e dia:
SELECT Country, AdType, Day, GrossRevenue, StartDate, EndDate FROM AdPerformanceReports WHERE video='vid123' AND continent = '019'
Selecionar Regras
Relatórios de desempenho de anúncios para proprietários de conteúdo:
| Dimensões | Obrigatório | adType | | -------------- | -------------------------------- | | Optional
| dia | | Métricas | Use 1 ou mais | receita bruta, impressões de anúncios, cpm | | Filtro | Use exatamente um | vídeo, grupo ou uma combinação suportada de uploaderType e ClaimStatus | | Use 0 or one
| país, continente, subcontinente |
Colunas
Nome | Tipo | Dimensão | Métrica Padrão | Dimensão padrão | Descrição |
---|---|---|---|---|---|
Video | String | Verdadeiro | O ID de um vídeo do YouTube. | ||
Group | String | Verdadeiro | (somente filtro) O ID de um grupo do YouTube Analytics. | ||
Country | String | O país associado às métricas na linha do relatório. O valor da dimensão é um código de país ISO-3166-1 de duas letras, como EUA, CN (China) ou FR (França). O código de país ZZ é usado para relatar métricas para as quais o YouTube não conseguiu identificar o país associado. | |||
Continent | String | (somente filtro) Um código de região estatística das Nações Unidas (ONU). Os valores permitidos são 002 África, 019 Américas (América do Norte, América Latina, América do Sul e Caribe), 142 Ásia, 150 Europa, 009 Oceania. Esta dimensão só pode ser usada para filtrar dados. | |||
SubContinent | String | (somente filtro) Um código de região estatística da ONU que identifica uma sub-região geográfica. | |||
AdType | String | Verdadeiro | A dimensão AdType é usada em relatórios de desempenho de anúncios e agrega as métricas solicitadas com base nos tipos de anúncios executados durante as reproduções de vídeo: leilãoDisplay, leilãoInstream, leilãoTrueviewInslate, leilãoTrueviewInstream, leilãoUnknown, reservadoClickToPlay, reservadoDisplay, reservadoInstream, reservadoInstreamSelect, reservadoMasthead, reservadoUnknown. | ||
Day | String | Verdadeiro | Quando você usa essa dimensão, os dados do relatório são agregados diariamente e cada linha contém dados de um dia. | ||
ClaimedStatus | String | (usado apenas em relatórios de proprietários de conteúdo) Essa dimensão permite indicar que um conjunto de resultados deve conter apenas métricas para conteúdo reivindicado. O valor permitido é reivindicado. | |||
UploaderType | String | (usado apenas em relatórios de proprietários de conteúdo) Essa dimensão permite indicar se um conjunto de resultados deve conter métricas para conteúdo enviado pelo proprietário do conteúdo especificado ou conteúdo enviado por terceiros, como vídeos enviados por usuários. Os valores permitidos são self e thirdParty. | |||
GrossRevenue | Decimal | Falso | A receita bruta estimada, em USD, de toda a publicidade vendida pelo Google ou por parceiros da DoubleClick para o período e a região selecionados. A receita bruta está sujeita a ajustes no final do mês e não inclui publicidade veiculada por parceiros. A receita bruta não deve ser confundida com ganhos ou receita líquida, que considera sua parcela de propriedade e acordos de compartilhamento de receita. | ||
Cpm | Decimal | Falso | A receita bruta estimada por mil impressões de anúncios. | ||
AdImpressions | Double | Falso | O número de impressões de anúncios verificadas exibidas. | ||
StartDate | Date | Data de início para buscar dados do Analytics. | |||
EndDate | Date | Data de término para buscar dados do Analytics. |
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 |
---|---|---|
Segments | String | Segmenta os dados retornados para sua solicitação. Um SegmentId ou um segmento personalizado. |
Legendas
Consultar legendas do YouTube. Um recurso Caption representa uma faixa de legenda do YouTube.
Informações específicas da tabela
Selecione
O YouTube Analytics permite que apenas um subconjunto de colunas seja usado como critério de filtro. A coluna VideoId deve ser especificada. Colunas extras opcionais suportadas são ID e OnBehalfOfContentOwner.
Todas as colunas suportam o operador '='.
SELECT * FROM Captions WHERE VideoId = '123456789'
Colunas
Nome | Tipo | Dimensão | Métrica Padrão | Dimensão padrão | Descrição |
---|---|---|---|---|---|
Id [KEY] | String | O ID que o YouTube usa para identificar exclusivamente a faixa de legenda. | |||
VideoId | String | O ID que o YouTube usa para identificar exclusivamente o vídeo associado à faixa de legenda. | |||
LastUpdated | Datetime | A data e a hora em que a faixa de legenda foi atualizada pela última vez. O valor é especificado no formato ISO 8601 (AAAA-MM-DDThhss.sZ). | |||
TrackKind | String | O tipo da faixa de legenda. Valores válidos para esta coluna: ASR (uma faixa de legenda gerada usando o reconhecimento automático de fala); Forçado (uma faixa de legenda que é reproduzida quando nenhuma outra faixa é selecionada no player. Por exemplo, um vídeo que mostra alienígenas falando em um idioma estrangeiro pode ter uma faixa de legenda forçada para mostrar apenas legendas para o idioma estrangeiro); standard (uma faixa de legenda regular. Este é o valor padrão). | |||
Language | String | O idioma da faixa de legenda. O valor da coluna é uma tag de idioma BCP-47. | |||
Name | String | O nome da faixa de legenda. O nome deve ficar visível para o usuário como uma opção durante a reprodução. | |||
AudioTrackType | String | O tipo de faixa de áudio associada à faixa de legenda. Valores válidos para esta coluna: comentário (a faixa de legenda corresponde a uma faixa de áudio alternativa que inclui comentários, como comentários do diretor); descritivo (a faixa de legenda corresponde a uma faixa de áudio alternativa que inclui áudio descritivo adicional); primário (a trilha de legenda corresponde à trilha de áudio primária do vídeo, que é a trilha de áudio normalmente associada ao vídeo); desconhecido (este é o valor padrão). | |||
IsCC | Boolean | Indica se a faixa contém legendas ocultas para surdos e deficientes auditivos. O valor padrão é falso. | |||
IsLarge | Boolean | Indica se a faixa de legenda usa texto grande para deficientes visuais. O valor padrão é falso. | |||
IsEasyReader | Boolean | Indica se a faixa de legenda está formatada para facilitar a leitura, o que significa que está no nível da terceira série para alunos de idiomas. O valor padrão é falso. | |||
IsDraft | Boolean | Indica se a faixa de legenda é um rascunho. Se o valor for true, a trilha não estará visível publicamente. O valor padrão é falso. | |||
IsAutoSynced | Boolean | Indica se o YouTube sincronizou a faixa de legenda com a faixa de áudio do vídeo. O valor será true se uma sincronização tiver sido solicitada explicitamente quando a faixa de legenda for carregada. Se o valor for falso, o YouTube usará os códigos de tempo na faixa de legenda carregada para determinar quando exibir as legendas. | |||
Status | String | O status da faixa de legenda. Valores válidos para esta coluna: falha, veiculação, sincronização. | |||
FailureReason | String | O motivo pelo qual o YouTube não conseguiu processar a faixa de legenda. Valores válidos: processingFailed (o YouTube falhou ao processar a faixa de legenda carregada); unknownFormat (o formato da faixa de legenda não foi reconhecido); unsupportedFormat (o formato da faixa de legenda não é suportado). |
Canais
Consultar canais do YouTube.
Informações específicas da tabela
Selecione
Por padrão, SupportEnhancedSQL
é definido como verdadeiro e o seguinte será transmitido ao YouTube Analytics, se presente. Outros filtros serão executados no lado do cliente. Se SupportEnhancedSQL
for definido como falso, apenas os seguintes filtros serão respeitados.
Por padrão, se nenhum filtro for especificado, o driver retornará todos os canais pertencentes ao usuário autenticado.
O YouTube Analytics permite que apenas um subconjunto de colunas seja usado como critério de filtro. Os canais podem ser filtrados pelo Id. Colunas extras opcionais suportadas são Language e ChannelId.
Uma pesquisa em todos os canais no YouTube Analytics pode ser acionada especificando um ou mais SearchTerms, ChannelId, Region, SafeSearch, Rating ou Relevance para pesquisar todos os canais.
Todas as colunas suportam o operador '='. 'PublishedAt' também suporta '>', '>=', '<' e '<='.
Ordenar por é compatível com as colunas Classificação, Relevância e Título.
SELECT * FROM Channels WHERE Id = 'abc123'
SELECT * FROM Channels WHERE ChannelId = 'abc123' AND SearchTerms = 'music|movies-horror' ORDER BY Rating LIMIT 10
Observação: A ordem não é suportada ao especificar uma das colunas usadas para pesquisar canais, como SearchTerms.
Colunas
Nome | Tipo | Dimensão | Métrica Padrão | Dimensão padrão | Descrição |
---|---|---|---|---|---|
Id [KEY] | String | O ID que o YouTube usa para identificar exclusivamente o canal. | |||
Title | String | O título do canal. | |||
Description | String | A descrição do canal. O valor da coluna tem um comprimento máximo de 1000 caracteres. | |||
CustomUrl | String | O URL personalizado do canal. | |||
PublishedAt | Datetime | A data e a hora em que o canal foi criado. O valor é especificado no formato ISO 8601 (AAAA-MM-DDThhss.sZ). | |||
ThumbnailsDefaultUrl | String | A URL da miniatura da imagem padrão. | |||
DefaultLanguage | String | Esta coluna é confidencial para testadores confiáveis. | |||
LiveBroadcastContent | String | Uma indicação se um recurso de vídeo ou canal tem conteúdo de transmissão ao vivo. | |||
LocalizedTitle | String | Esta coluna é confidencial para testadores confiáveis. O título do vídeo localizado. | |||
LocalizedDescription | String | Esta coluna é confidencial para testadores confiáveis. A descrição do vídeo localizada. | |||
Country | String | O país ao qual o canal está associado. | |||
ViewCount | Long | O número de vezes que o canal foi visualizado. | |||
SubscriberCount | Long | O número de inscritos que o canal possui. Este valor é arredondado para três algarismos significativos. | |||
HiddenSubscriberCount | Boolean | Indica se a contagem de inscritos do canal é visível publicamente. | |||
VideoCount | Long | O número de vídeos enviados para o canal. | |||
RelatedPlaylistsLikes | String | O ID da lista de reprodução que contém os vídeos curtidos do canal. | |||
RelatedPlaylistsUploads | String | O ID da lista de reprodução que contém os vídeos enviados do canal. | |||
PrivacyStatus | String | Status de privacidade do canal. Valores válidos para esta coluna: privado, público, não listado. | |||
IsLinked | Boolean | Indica se os dados do canal identificam um usuário que já está vinculado a um nome de usuário do YouTube ou a uma conta do Google+. Um usuário que possui um desses links já possui uma identidade pública do YouTube, o que é pré-requisito para várias ações, como o upload de vídeos. | |||
LongUploadsStatus | String | Indica se o canal está qualificado para enviar vídeos com mais de 15 minutos de duração. Esta coluna só é retornada se o proprietário do canal autorizou a solicitação da API. Consulte a Central de Ajuda do YouTube para obter mais informações sobre esse recurso. | |||
MadeForKids | Boolean | Esse valor indica se o canal é designado como direcionado para crianças e contém o status atual de 'criado para crianças' do canal. | |||
Keywords | String | Palavras-chave associadas ao seu canal. O valor é uma lista de strings separadas por espaços. | |||
TrackingAnalyticsAccountId | String | O ID de uma conta do Google Analytics que você deseja usar para rastrear e medir o tráfego para seu canal. | |||
ModerateComments | Boolean | Esta configuração determina se os comentários enviados pelo usuário deixados na página do canal precisam ser aprovados pelo proprietário do canal para serem visíveis publicamente. O valor padrão é falso. | |||
SearchTerms | String | O parâmetro SearchTerms especifica o termo de consultar a ser pesquisado. |
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 |
---|---|---|
ForUsername | String | O nome de usuário associado ao canal. |
Language | String | Recupere metadados de recursos localizados para um idioma de aplicativo específico compatível com o site do YouTube. |
Language | String | Recupere metadados de recursos localizados para um idioma de aplicativo específico compatível com o site do YouTube. |
ManagedByMe | String | Este parâmetro destina-se exclusivamente a parceiros de conteúdo do YouTube. Defina o valor desse parâmetro como true para instruir a API a retornar apenas canais gerenciados pelo proprietário do conteúdo especificado pelo parâmetro onBehalfOfContentOwner. O usuário deve ser autenticado como uma conta CMS vinculada ao proprietário do conteúdo especificado e onBehalfOfContentOwner deve ser fornecido. |
OnBehalfOfContentOwner | String | Este parâmetro destina-se exclusivamente a parceiros de conteúdo do YouTube. O parâmetro onBehalfOfContentOwner indica que as credenciais de autorização da solicitação identificam um usuário do YouTube CMS que está agindo em nome do proprietário do conteúdo especificado no valor do parâmetro. Este parâmetro destina-se a parceiros de conteúdo do YouTube que possuem e gerenciam muitos canais diferentes do YouTube. Ele permite que os proprietários de conteúdo se autentiquem uma vez e obtenham acesso a todos os seus dados de vídeo e canal, sem precisar fornecer credenciais de autenticação para cada canal individual. A conta do CMS com a qual o usuário se autentica deve estar vinculada ao proprietário do conteúdo do YouTube especificado. |
ChannelId | String | O ID que o YouTube usa para identificar exclusivamente um canal. |
Region | String | O país associado ao canal. |
SafeSearch | String | Indica se os resultados da pesquisa devem incluir conteúdo restrito, bem como conteúdo padrão. Valores aceitáveis: moderado, nenhum ou estrito. |
Rating | String | Os recursos são classificados da classificação mais alta para a mais baixa. |
Relevance | String | Os recursos são classificados com base em sua relevância para a consultar de pesquisa. Este é o valor padrão para este parâmetro. |
ChannelSections
Consulte as seções do canal do YouTube. Uma ChannelSection contém informações sobre um conjunto de vídeos que um canal escolheu apresentar.
Informações específicas da tabela
Selecione
O YouTube Analytics permite que apenas um subconjunto de colunas seja usado como critério de filtro. Você pode especificar exatamente uma das seguintes colunas: ChannelId ou Id. Colunas extras opcionais com suporte são Language e OnBehalfOfContentOwner.
Todas as colunas suportam o operador '='.
Por padrão, se nenhum ID de canal for especificado, o driver retornará as seções de canal para o canal pertencente ao usuário autenticado.
SELECT * FROM ChannelSections WHERE ChannelId = '123456789'
Colunas
Nome | Tipo | Dimensão | Métrica Padrão | Dimensão padrão | Descrição |
---|---|---|---|---|---|
Id [KEY] | String | O ID que o YouTube usa para identificar exclusivamente a seção do canal. | |||
Type | String | O tipo da seção do canal. | |||
ChannelId | String | O ID que o YouTube usa para identificar exclusivamente o canal. | |||
Title | String | O título da seção. | |||
Position | Integer | A posição da seção na página do canal. | |||
PlaylistsAggregate | String | Uma lista de um ou mais IDs de lista de reprodução apresentados em uma seção de canal. Você deve especificar uma lista de IDs de playlist se o tipo de ChannelSection for singlePlaylist ou multiplePlaylists, e esta coluna não deve ser especificada para outros tipos de seções. Se o tipo for singlePlaylist, esta lista deve especificar exatamente um ID de lista de reprodução. | |||
ChannelsAggregate | String | Uma lista de um ou mais IDs de canal que são apresentados em uma seção de canal. Você deve especificar uma lista de IDs de canais se o Tipo de ChannelSection for multipleChannels e esta coluna não deve ser especificada para outros tipos de seções. Você não pode incluir seu próprio canal na lista. |
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 |
---|---|---|
Language | String | Recupere metadados de recursos localizados para um idioma de aplicativo específico compatível com o site do YouTube. |
OnBehalfOfContentOwner | String | Este parâmetro destina-se exclusivamente a parceiros de conteúdo do YouTube. |
Comentários
Consultar comentários do YouTube.
Informações específicas da tabela
Selecione
O YouTube Analytics permite que apenas um subconjunto de colunas seja usado como critério de filtro. Você deve especificar exatamente uma das seguintes colunas: ID ou ParentId. Colunas extras opcionais suportadas são TextFormat.
Todas as colunas suportam o operador '='.
SELECT * FROM Comments WHERE ID = '123456789'
Colunas
Nome | Tipo | Dimensão | Métrica Padrão | Dimensão padrão | Descrição |
---|---|---|---|---|---|
Id [KEY] | String | O ID que o YouTube usa para identificar exclusivamente o comentário. | |||
ChannelId | String | O ID do canal do YouTube associado ao comentário. Se o comentário for um comentário de vídeo, essa coluna identifica o canal do vídeo e a coluna VideoId identifica o vídeo. Se o comentário for um comentário de canal, essa coluna identificará o canal sobre o qual o comentário é. | |||
VideoId | String | O ID do vídeo ao qual o comentário se refere. | |||
TextDisplay | String | O texto do comentário. O texto pode ser recuperado em texto simples ou HTML. A pseudocoluna TextFormat especifica o formato de texto desejado. | |||
TextOriginal | String | O texto bruto original do comentário conforme foi publicado inicialmente ou atualizado pela última vez. O texto original só é devolvido se estiver acessível ao usuário autenticado, o que só é garantido se o usuário for o autor do comentário. | |||
ParentId | String | A ID exclusiva do comentário pai. Este valor de coluna só é definido se o comentário foi enviado como uma resposta a outro comentário. | |||
AuthorDisplayName | String | O nome de exibição do usuário que postou o comentário. | |||
AuthorProfileImageUrl | String | A URL do avatar do usuário que postou o comentário. | |||
AuthorChannelUrl | String | A URL do canal do YouTube do autor do comentário, se disponível. | |||
AuthorChannelIdValue | String | O ID do canal do YouTube do autor do comentário, se disponível. | |||
AuthorGoogleplusProfileUrl | String | O URL do perfil do Google+ do autor do comentário, se disponível. | |||
CanRate | Boolean | Essa configuração indica se o visualizador atual pode avaliar o comentário. | |||
ViewerRating | String | A classificação que o visualizador deu a este comentário. Valores válidos para esta coluna: como, nenhum. Observe que esta coluna atualmente não identifica classificações de antipatia. O valor da coluna é como se o visualizador tivesse avaliado o comentário positivamente. O valor é nenhum em todos os outros casos, incluindo o usuário que deu ao comentário uma classificação negativa ou não avaliou o comentário. | |||
LikeCount | Integer | O número total de curtidas (avaliações positivas) que o comentário recebeu. | |||
ModerationStatus | String | O status de moderação do comentário. Esse valor só é retornado se a solicitação da API for autorizada pelo proprietário do canal ou do vídeo em que foram feitos os comentários solicitados. Além disso, observe que esse valor não é definido se a consultar for filtrada na coluna ID. Valores válidos: holdForReview, provávelSpam, publicado, rejeitado. | |||
PublishedAt | Datetime | A data e a hora em que o comentário foi originalmente publicado. O valor é especificado no formato ISO 8601 (AAAA-MM-DDThhss.sZ). | |||
UpdatedAt | Datetime | A data e a hora em que o comentário foi atualizado pela última vez. O valor é especificado no formato ISO 8601 (AAAA-MM-DDThhss.sZ). |
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 |
---|---|---|
TextFormat | String | Este parâmetro indica se a API deve retornar comentários formatados como HTML ou como texto sem formatação. |
Threads de comentários
Consulte tópicos de comentários do YouTube. Um registro CommentThread contém informações sobre um tópico de comentários do YouTube, um comentário de nível superior e respostas, se houver, a esse comentário.
Informações específicas da tabela
Selecione
O YouTube Analytics permite que apenas um subconjunto de colunas seja usado como critério de filtro. Você deve especificar exatamente uma das seguintes colunas: AllThreadsRelatedToChannelId, ChannelId, Id ou VideoId.
Colunas extras opcionais suportadas são ModerationStatus, SearchTerms e TextFormat. Todas as colunas suportam o operador '='.
Order é compatível com CommentThreads. Relevância são as colunas de pedidos com suporte.
SELECT * FROM CommentThreads WHERE VideoId = 'abcdef123456' ORDER BY Relevance DESC LIMIT 10
Observação: A ordem não é suportada para uso em conjunto com o parâmetro ID.
Colunas
Nome | Tipo | Dimensão | Métrica Padrão | Dimensão padrão | Descrição |
---|---|---|---|---|---|
Id [KEY] | String | O ID que o YouTube usa para identificar exclusivamente o tópico de comentários. | |||
ChannelId | String | O canal do YouTube associado aos comentários no tópico. A coluna VideoId identifica o vídeo. Se os comentários forem sobre um vídeo, o valor identifica o canal que carregou o vídeo. Se os comentários se referirem ao próprio canal, a coluna VideoId não terá valor. | |||
VideoId | String | O ID do vídeo ao qual os comentários se referem, se houver. Se esta coluna não estiver presente ou não tiver um valor, o tópico se aplica ao canal e não a um vídeo específico. | |||
TopCommentId | String | A ID do comentário de nível superior do encadeamento. | |||
PublishedAt | Datetime | A data de publicação do comentário de nível superior do encadeamento. | |||
UpdatedAt | Datetime | A data da última atualização do comentário de nível superior do encadeamento. | |||
TopCommentChannelId | String | A ID do canal associado ao comentário de nível superior do encadeamento. | |||
TopCommentVideoId | String | O ID do vídeo associado ao comentário de nível superior do tópico. | |||
TopCommentTextDisplay | String | O texto de exibição do comentário de nível superior do thread. | |||
TopCommentTextOriginal | String | O texto original do comentário de nível superior do encadeamento. | |||
TopCommentParentId | String | A ID do pai do comentário de nível superior do encadeamento. | |||
TopCommentAuthorDisplayName | String | O nome de exibição do autor do comentário de nível superior do encadeamento. | |||
TopCommentAuthorChannelIdValue | String | A ID do canal do autor do comentário de nível superior do encadeamento. | |||
TopCommentCanRate | Boolean | Se o usuário atual pode classificar o comentário de nível superior do tópico. | |||
TopCommentViewerRating | String | A classificação do visualizador do comentário de nível superior do tópico. | |||
TopCommentLikeCount | Integer | A contagem de curtidas do comentário de nível superior do tópico. | |||
TopCommentModerationStatus | String | O status de moderação do comentário de nível superior do tópico. | |||
CanReply | Boolean | Essa configuração indica se o visualizador atual pode responder ao tópico. | |||
TotalReplyCount | Integer | O número total de respostas que foram enviadas em resposta ao comentário de nível superior. | |||
IsPublic | Boolean | Essa configuração indica se o tópico, incluindo todos os seus comentários e respostas aos comentários, está visível para todos os usuários do YouTube. | |||
CommentsAggregate | String | Uma lista de uma ou mais respostas ao comentário de nível superior. |
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 |
---|---|---|
AllThreadsRelatedToChannelId | String | Instrui a API a retornar todos os encadeamentos de comentários associados ao canal especificado. |
ModerationStatus | String | Defina esse parâmetro para limitar os encadeamentos de comentários retornados a um estado de moderação específico. |
TextFormat | String | Defina o valor desse parâmetro como HTML ou texto simples. |
Dados demográficos
Consulte os dados demográficos do YouTubeAnalytics agrupados por faixa etária e sexo.
Informações específicas da tabela
Selecione
Estatísticas agregadas de exibição de vídeos com base na faixa etária e sexo dos espectadores:
SELECT * FROM Demographics
Reduza os dados demográficos para apenas um vídeo:
SELECT * FROM Demographics WHERE Video = 'video_Id'
Estatísticas de visualização agregadas para listas de reprodução com base na faixa etária e sexo dos espectadores:
SELECT * FROM Demographics WHERE IsCurated=true
Selecionar Regras
Você pode usar as tabelas a seguir para criar outras consultas aos vídeos principais.
Dados demográficos para vídeos:
| Dimensões | Use 1 ou mais | faixa etária, gênero, vídeo | | --------------- | ------------------------------------------------ | | Use 0 or more
| liveOrOnDemand, subscritoStatus, youtubeProduct | | Métricas | Use 1 ou mais | visualizadorPorcentagem | | Filtro | Use 0 ou um | país, província, continente, subcontinente | | Use 0 or one
| vídeo, grupo | | Use 0 or more
| liveOrOnDemand, subscritoStatus, youtubeProduct |
Dados demográficos para listas de reprodução:
| Dimensões | Use 1 ou mais | Grupo etário, sexo | | --------------- | ------------------------------------------ | | Use 0 or more
| subscritoStatus, youtubeProduct | | Métricas | Obrigatório | visualizadorPorcentagem | | Filtro | Obrigatório | isCurated=true | | Use 0 or one
| país, província, continente, subcontinente | | Use 0 or one
| vídeo, grupo | | Use 0 or more
| subscritoStatus, youtubeProduct |
Dados demográficos para proprietários de conteúdo:
| Dimensões | Use 1 ou mais | Grupo etário, sexo | | --------------- | ------------------------------------------------ | | Use 0 or more
| liveOrOnDemand, subscritoStatus, youtubeProduct | | Métricas | Use 1 ou mais | visualizadorPorcentagem | | Filtro | Use exatamente um | vídeo, canal, grupo | | Use 0 or one
| país, província, continente, subcontinente | | Use 0 or more
| liveOrOnDemand, subscritoStatus, youtubeProduct |
Dados demográficos para listas de reprodução de proprietários de conteúdo:
| Dimensões | Use 1 ou mais | Grupo etário, sexo | | --------------- | ------------------------------------------ | | Use 0 or more
| subscritoStatus, youtubeProduct | | Métricas | Obrigatório | visualizadorPorcentagem | | Filtro | Obrigatório | isCurated=true | | Use 0 or one
| país, província, continente, subcontinente | | Use 0 or one
| playlist, canal, grupo | | Use 0 or more
| subscritoStatus, youtubeProduct |
Colunas
Nome | Tipo | Dimensão | Métrica Padrão | Dimensão padrão | Descrição |
---|---|---|---|---|---|
Video | String | Verdadeiro | Falso | O ID de um vídeo do YouTube. | |
Playlist | String | Verdadeiro | O ID de uma lista de reprodução do YouTube. | ||
Group | String | Verdadeiro | (somente filtro) O ID de um grupo do YouTube Analytics. | ||
Country | String | Verdadeiro | O país associado às métricas na linha do relatório. O valor da dimensão é um código de país ISO-3166-1 de duas letras, como EUA, CN (China) ou FR (França). O código de país ZZ é usado para relatar métricas para as quais o YouTube não conseguiu identificar o país associado. | ||
Province | String | Verdadeiro | O estado ou território dos EUA associado às métricas na linha do relatório. O valor da dimensão é um código ISO 3166-2 que identifica um estado dos EUA ou o Distrito de Columbia, como US-MI (Michigan) ou US-TX (Texas). O código de província US-ZZ é usado para relatar métricas para as quais o YouTube não conseguiu identificar o estado dos EUA associado. Se a coluna Província for especificada, País deverá ser definido como EUA na cláusula WHERE. | ||
Continent | String | Verdadeiro | (somente filtro) Um código de região estatística das Nações Unidas (ONU). A API suporta os seguintes valores: 002 África, 019 Américas (América do Norte, América Latina, América do Sul e Caribe), 142 Ásia, 150 Europa, 009 Oceania. | ||
SubContinent | String | Verdadeiro | (somente filtro) Um código de região estatística da ONU que identifica uma sub-região geográfica. | ||
LiveOrOnDemand | String | Verdadeiro | Essa dimensão indica se as métricas de atividade do usuário na linha de dados estão associadas a exibições de uma transmissão ao vivo. Os dados dessa dimensão estão disponíveis para datas a partir de 1º de abril de 2014. Os valores permitidos são LIVE, ON_DEMAND. | ||
SubscribedStatus | String | Verdadeiro | Essa dimensão indica se as métricas de atividade do usuário na linha de dados estão associadas a espectadores que se inscreveram no canal de vídeo ou lista de reprodução. Os valores permitidos são SUBSCRIBED e UNSCRIBED. Observe que o valor da dimensão é preciso a partir do momento em que a atividade do usuário ocorre. | ||
YouTubeProduct | String | Verdadeiro | Essa dimensão identifica o serviço do YouTube no qual ocorreu a atividade do usuário. Os dados dessa dimensão estão disponíveis desde 18 de julho de 2015. Os valores permitidos são CORE, GAMING, KIDS, UNKNOWN. | ||
IsCurated | Boolean | Verdadeiro | Este filtro indica que a solicitação está recuperando dados sobre exibições de vídeo que ocorreram no contexto de uma lista de reprodução. Esse filtro é necessário para qualquer relatório de lista de reprodução e seu valor deve ser definido como 1. Voltar para o início | ||
ClaimedStatus | String | Verdadeiro | (usado apenas em relatórios de proprietários de conteúdo) Essa dimensão permite indicar que um conjunto de resultados conterá apenas métricas para conteúdo reivindicado. O valor permitido é reivindicado. | ||
UploaderType | String | Verdadeiro | (usado apenas em relatórios de proprietários de conteúdo) Essa dimensão permite indicar se um conjunto de resultados conterá métricas para conteúdo enviado pelo proprietário do conteúdo especificado ou conteúdo enviado por terceiros, como vídeos enviados por usuários. Os valores permitidos são self e thirdParty. | ||
AgeGroup | String | Verdadeiro | Verdadeiro | Essa dimensão identifica a faixa etária dos usuários conectados associados aos dados do relatório. Os valores permitidos são age13-17, age18-24, age25-34, age35-44, age45-54, age55-64, age65- | |
Gender | String | Verdadeiro | Falso | Essa dimensão identifica o sexo dos usuários conectados associados à consultar. Os valores permitidos são feminino, masculino e especificado pelo usuário. | |
ViewerPercentage | Double | Falso | Verdadeiro | A porcentagem de espectadores que fizeram login ao assistir ao vídeo ou à lista de reprodução. Os valores viewerPercentage neste relatório não são normalizados para diferentes valores ou combinações de valores para dimensões de detalhes de reprodução (subscribeStatus e youtubeProduct). Por exemplo, um relatório que usa a dimensãosubscribedStatus retorna dados de viewerPercentage somando até 100 por cento para exibições assinadas e dados viewerPercentage somando até 100 por cento para exibições não assinadas. (O valor total de todos os campos viewerPercentage no relatório é 200 por cento.) Você pode usar filtros para garantir que o relatório contenha apenas dados viewerPercentage para um valor (ou combinação de valores) para dimensões de detalhes de reprodução. | |
StartDate | Date | Data de início para buscar dados do Analytics. | |||
EndDate | Date | Data de término para buscar dados do Analytics. |
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 |
---|---|---|
Segments | String | Segmenta os dados retornados para sua solicitação. Um SegmentId ou um segmento personalizado. |
Dispositivos
Consulte estatísticas de dispositivos ou sistemas operacionais do YouTubeAnalytics. Essa tabela permite agregar estatísticas de exibição com base na maneira como os espectadores acessaram o conteúdo do seu vídeo. Por exemplo, você pode identificar o número de visualizações que ocorreram em dispositivos móveis ou consoles de jogos.
Informações específicas da tabela
Selecione
Por padrão, o agrupamento é feito por tipo de dispositivo:
SELECT * FROM Devices
No entanto, você pode agrupar exibições por outras dimensões, como Sistema operacional:
SELECT OperatingSystem, Views, EstimatedMinutesWatched FROM Devices
Observe que você não pode misturar o tipo de dispositivo e o sistema operacional na mesma consultar devido a limitações na API do YouTube Analytics.
Selecionar Regras
Você pode usar as tabelas a seguir para criar outras consultas para dispositivos:
Dispositivos para vídeos:
| Dimensões | Use exatamente um | tipo de dispositivo, sistema operacional | | --------------- | -------------------------------------------------- --------------- | | Use 0 or more
| dia, liveOrOnDemand, subscritoStatus, youtubeProduct | | Métricas | Use 1 ou mais | visualizações, estimadasMinutosAssistidos | | Filtro | Use 0 ou um | país, província, continente, subcontinente | | Use 0 or one
| vídeo, grupo | | Use 0 or more
| operatingSystem, liveOrOnDemand, SubscribedStatus, youtubeProduct |
Dados do dispositivo para listas de reprodução:
| Dimensões | Use exatamente um | tipo de dispositivo, sistema operacional | | --------------- | ------------------------------------------------- | | Use 0 or more
| dia, subscritoStatus, youtubeProduct | | Métricas | Use 1 ou mais | visualizações, minutos estimados assistidos, playlistStarts, viewsPerPlaylistStart, averageTimeInPlaylist | | Filtro | Obrigatório | isCurated=true | | Use 0 or one
| país, província, continente, subcontinente | | Use 0 or one
| playlist, canal, grupo | | Use 0 or more
| OperatingSystem, SubscribedStatus, youtubeProduct |
Dados do dispositivo para proprietários de conteúdo:
| Dimensões | Obrigatório | tipo de dispositivo | | --------------- | -------------------------------------------------- --------------- | | Use 0 or more
| dia, liveOrOnDemand, subscritoStatus, youtubeProduct | | Métricas | Use 1 ou mais | visualizações, estimadasMinutosAssistidos | | Filtro | Use exatamente um | vídeo, canal, grupo | | Use 0 or one
| país, província, continente, subcontinente | | Use 0 or more
| operatingSystem, liveOrOnDemand, SubscribedStatus, youtubeProduct |
Dados do dispositivo para listas de reprodução do proprietário do conteúdo:
| Dimensões | Obrigatório | tipo de dispositivo | | --------------- | ------------------------------------------------- | | Use 0 or more
| dia, subscritoStatus, youtubeProduct | | Métricas | Use 1 ou mais | visualizações, minutos estimados assistidos, playlistStarts, viewsPerPlaylistStart, averageTimeInPlaylist | | Filtros | Obrigatório | isCurated=true | | Use 0 or one
| país, província, continente, subcontinente | | Use 0 or one
| playlist, canal, grupo | | Use 0 or more
| OperatingSystem, SubscribedStatus, youtubeProduct |
Colunas
Nome | Tipo | Dimensão | Métrica Padrão | Dimensão padrão | Descrição |
---|---|---|---|---|---|
Video | String | Verdadeiro | O ID de um vídeo do YouTube. | ||
Group | String | Verdadeiro | (somente filtro) O ID de um grupo do YouTube Analytics. | ||
Channel | String | Verdadeiro | (usado apenas em relatórios de proprietários de conteúdo) O ID de um canal do YouTube. A dimensão do canal é frequentemente usada em relatórios de proprietários de conteúdo porque esses relatórios geralmente agregam dados para vários canais. | ||
Playlist | String | Verdadeiro | O ID de uma lista de reprodução do YouTube. | ||
Country | String | Verdadeiro | O país associado às métricas na linha do relatório. O valor da dimensão é um código de país ISO-3166-1 de duas letras, como EUA, CN (China) ou FR (França). O código de país ZZ é usado para relatar métricas para as quais o YouTube não conseguiu identificar o país associado. | ||
Province | String | Verdadeiro | O estado ou território dos EUA associado às métricas na linha do relatório. O valor da dimensão é um código ISO 3166-2 que identifica um estado dos EUA ou o Distrito de Columbia, como US-MI (Michigan) ou US-TX (Texas). O código de província US-ZZ é usado para relatar métricas para as quais o YouTube não conseguiu identificar o estado dos EUA associado. Se a coluna Província for especificada, País deverá ser definido como EUA na cláusula WHERE. | ||
Continent | String | Verdadeiro | (somente filtro) Um código de região estatística das Nações Unidas (ONU): 002 África, 019 Américas (América do Norte, América Latina, América do Sul e Caribe), 142 Ásia, 150 Europa, 009 Oceania. Esta dimensão só pode ser usada para filtrar dados. | ||
SubContinent | String | Verdadeiro | (somente filtro) Um código de região estatística da ONU que identifica uma sub-região geográfica. | ||
Day | String | Verdadeiro | Quando você usa essa dimensão, os dados do relatório são agregados diariamente e cada linha contém dados de um dia. | ||
LiveOrOnDemand | String | Verdadeiro | Essa dimensão indica se as métricas de atividade do usuário na linha de dados estão associadas a exibições de uma transmissão ao vivo. Os dados dessa dimensão estão disponíveis para datas a partir de 1º de abril de 2014. Os valores permitidos são LIVE, ON_DEMAND. | ||
SubscribedStatus | String | Verdadeiro | Essa dimensão indica se as métricas de atividade do usuário na linha de dados estão associadas a espectadores que se inscreveram no canal de vídeo ou lista de reprodução. Os valores permitidos são SUBSCRIBED, UNSCRIBED. Observe que o valor da dimensão é preciso a partir do momento em que a atividade do usuário ocorre. | ||
YouTubeProduct | String | Verdadeiro | Essa dimensão identifica o serviço do YouTube no qual ocorreu a atividade do usuário. Os dados dessa dimensão estão disponíveis desde 18 de julho de 2015. Os valores permitidos são CORE, GAMING, KIDS, UNKNOWN. | ||
DeviceType | String | Verdadeiro | Verdadeiro | Essa dimensão identifica o fator de forma física do dispositivo no qual ocorreu a exibição. Os valores permitidos são DESKTOP, GAME_CONSOLE, MOBILE, TABLET, TV, UNKNOWN_PLATFORM. | |
OperatingSystem | String | Verdadeiro | Falso | Esta dimensão identifica o sistema de software do dispositivo no qual ocorreu a exibição. Os valores permitidos são ANDROID, BADA, BLACKBERRY, DOCOMO, HIPTOP, IOS, LINUX, MACINTOSH, MEEGO, NINTENDO_3DS, OTHER, PLAYSTATION, PLAYSTATION_VITA, SMART_TV, SYMBIAN, WEBOS. | |
IsCurated | Boolean | Verdadeiro | Este filtro indica que a solicitação está recuperando dados sobre exibições de vídeo que ocorreram no contexto de uma lista de reprodução. Esse filtro é necessário para qualquer relatório de lista de reprodução e seu valor deve ser definido como 1. Voltar para o início | ||
ClaimedStatus | String | Verdadeiro | (usado apenas em relatórios de proprietários de conteúdo) Essa dimensão permite indicar que o conjunto de resultados conterá apenas métricas para conteúdo reivindicado. O valor permitido é reivindicado. | ||
UploaderType | String | Verdadeiro | (usado apenas em relatórios de proprietários de conteúdo) Essa dimensão permite indicar se o conjunto de resultados conterá métricas para conteúdo enviado pelo proprietário do conteúdo especificado ou conteúdo enviado por terceiros, como vídeos enviados por usuários. Os valores permitidos são self e thirdParty. | ||
Views | Double | Falso | Verdadeiro | O número de vezes que um vídeo foi visualizado. | |
EstimatedMinutesWatched | Double | Falso | Verdadeiro | O número de minutos que os usuários assistiram aos vídeos do canal, proprietário do conteúdo, vídeo ou lista de reprodução especificados. | |
PlaylistStarts | Double | Falso | Falso | O número de vezes que os espectadores iniciaram a reprodução de uma lista de reprodução. | |
ViewsPerPlaylistStart | Double | Falso | Falso | O número médio de exibições de vídeo ocorridas sempre que uma lista de reprodução foi iniciada. | |
AverageTimeInPlaylist | Double | Falso | Falso | O tempo médio estimado, em minutos, que um espectador assistiu aos vídeos em uma lista de reprodução após o início da lista de reprodução. | |
StartDate | Date | Data de início para buscar dados do Analytics. | |||
EndDate | Date | Data de término para buscar dados do Analytics. |
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 |
---|---|---|
Segments | String | Segmenta os dados retornados para sua solicitação. Um SegmentId ou um segmento personalizado. |
EngagementReports
Consulte as informações dos Relatórios de engajamento. Por exemplo, quantas vezes um usuário compartilhou um vídeo.
Informações específicas da tabela
Selecione
Por padrão, os resultados são agrupados por Dia. A consultar a seguir retorna comentários, curtidas, não curtidas, etc., agrupados por dia:
SELECT * FROM EngagementReports
Selecionar Regras
A consultar a seguir retorna a frequência com que os vídeos do canal foram compartilhados em diferentes plataformas sociais:
SELECT SharingService, Shares FROM EngagementReports
Você pode usar as tabelas a seguir para criar outras consultas aos relatórios de engajamento:
Relatórios de engajamento para vídeos:
| Dimensões | Obrigatório | sharingService | | -------------- | ---------------- | | Optional
| subscritoEstado | | Métricas | Use 1 ou mais | ações | | Filtro | Use 0 ou um | país, continente, subcontinente | | Use 0 or one
| vídeo, grupo | | Optional
| subscritoEstado |
Relatórios de engajamento para proprietários de conteúdo:
| Dimensões | Obrigatório | sharingService | | -------------- | -------------------------------- | | Optional
| subscritoEstado | | Métricas | Use 1 ou mais | ações | | Filtro | Use exatamente um | vídeo, canal, grupo | | Use 0 or one
| país, continente, subcontinente | | Optional
| subscritoEstado |
Colunas
Nome | Tipo | Dimensão | Métrica Padrão | Dimensão padrão | Descrição |
---|---|---|---|---|---|
SharingService | String | Verdadeiro | Esta dimensão identifica o serviço que foi usado para compartilhar vídeos. Os vídeos podem ser compartilhados no YouTube (ou por meio do player do YouTube) usando o botão Compartilhar. | ||
Channel | String | Verdadeiro | (usado apenas em relatórios de proprietários de conteúdo) O ID de um canal do YouTube. A dimensão do canal é frequentemente usada em relatórios de proprietários de conteúdo porque esses relatórios geralmente agregam dados para vários canais. | ||
Video | String | Verdadeiro | O ID de um vídeo do YouTube. | ||
Group | String | Verdadeiro | (somente filtro) O ID de um grupo do YouTube Analytics. | ||
Country | String | Verdadeiro | O país associado às métricas na linha do relatório. O valor da dimensão é um código de país ISO-3166-1 de duas letras, como EUA, CN (China) ou FR (França). O código de país ZZ é usado para relatar métricas para as quais o YouTube não conseguiu identificar o país associado. | ||
Continent | String | Verdadeiro | (somente filtro) Um código de região estatística das Nações Unidas (ONU): 002 África, 019 Américas (América do Norte, América Latina, América do Sul e Caribe), 142 Ásia, 150 Europa, 009 Oceania. Esta dimensão só pode ser usada para filtrar dados. | ||
SubContinent | String | Verdadeiro | (somente filtro) Um código de região estatística da ONU que identifica uma sub-região geográfica. | ||
SubscribedStatus | String | Verdadeiro | Essa dimensão indica se as métricas de atividade do usuário na linha de dados estão associadas a espectadores que se inscreveram no canal de vídeo ou lista de reprodução. Os valores possíveis são SUBSCRIBED e UNSCRIBED. Observe que o valor da dimensão é preciso a partir do momento em que a atividade do usuário ocorre. | ||
ClaimedStatus | String | Verdadeiro | (usado apenas em relatórios de proprietários de conteúdo) Essa dimensão permite indicar que um conjunto de resultados conterá apenas métricas para conteúdo reivindicado. O valor permitido é reivindicado. | ||
UploaderType | String | Verdadeiro | (usado apenas em relatórios de proprietários de conteúdo) Essa dimensão permite indicar se um conjunto de resultados conterá métricas para conteúdo enviado pelo proprietário do conteúdo especificado ou conteúdo enviado por terceiros, como vídeos enviados por usuários. Os valores permitidos são self e thirdParty. | ||
Shares | Double | Falso | Verdadeiro | O número de vezes que os usuários compartilharam um vídeo por meio do botão Compartilhar. | |
StartDate | Date | Data de início para buscar dados do Analytics. | |||
EndDate | Date | Data de término para buscar dados do Analytics. |
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 |
---|---|---|
Segments | String | Segmenta os dados retornados para sua solicitação. Um SegmentId ou um segmento personalizado. |
Idiomas
Consulta YouTube i18nLanguages. Um recurso i18nLanguage identifica um idioma de aplicativo compatível com o site do YouTube. O idioma do aplicativo também pode ser chamado de idioma da interface do usuário.
Informações específicas da tabela
Selecione
Não há filtros obrigatórios para esta tabela. Uma coluna opcional suportada é Language.
Todas as colunas suportam o operador '='.
Colunas
Nome | Tipo | Dimensão | Métrica Padrão | Dimensão padrão | Descrição |
---|---|---|---|---|---|
Id [KEY] | String | O ID que o YouTube usa para identificar exclusivamente o idioma i18n. | |||
Language | String | Um código BCP-47 que identifica exclusivamente um idioma. | |||
Name | String | O nome do idioma como está escrito nesse idioma. |
PlayListItems
Consulta YouTube PlayListItems. Um recurso PlayListItem identifica outra entidade do YouTube, como um vídeo, incluído em uma PlayList. Além disso, o registro PlayListItem contém detalhes sobre como essa entidade é usada nessa PlayList.
Informações específicas da tabela
Selecione
Você deve especificar exatamente uma das seguintes colunas na cláusula WHERE: ID ou PlayListId. Colunas extras opcionais suportadas são OnBehalfOfContentOwner e VideoId.
Todas as colunas suportam o operador '='.
SELECT * FROM PlaylistItems WHERE PlaylistId = 'abcdef123456'
Colunas
Nome | Tipo | Dimensão | Métrica Padrão | Dimensão padrão | Descrição |
---|---|---|---|---|---|
Id [KEY] | String | O ID que o YouTube usa para identificar exclusivamente o item da lista de reprodução. | |||
PublishedAt | Datetime | A data e a hora em que o item foi adicionado à lista de reprodução. O valor é especificado no formato ISO 8601 (AAAA-MM-DDThhss.sZ). | |||
ChannelId | String | O ID que o YouTube usa para identificar exclusivamente o usuário que adicionou o item à lista de reprodução. | |||
Title | String | O título do item. | |||
Description | String | A descrição do item. | |||
ThumbnailsDefaultUrl | String | A URL do item. | |||
ChannelTitle | String | O título do canal ao qual o item da lista de reprodução pertence. | |||
VideoOwnerChannelTitle | String | O título do canal que carregou este vídeo. | |||
VideoOwnerChannelId | String | O ID do canal que carregou este vídeo. | |||
PlaylistId | String | A ID que o YouTube usa para identificar exclusivamente a lista de reprodução na qual o item da lista de reprodução está. | |||
Position | String | A ordem em que o item aparece na lista de reprodução. O valor usa um índice baseado em zero, portanto, o primeiro item tem uma posição de 0, o segundo item tem uma posição de 1 e assim por diante. | |||
ResourceIdKind | String | O tipo, ou tipo, do recurso referido. | |||
ResourceIdVideoId | String | Se o valor ResourceIdKind da coluna for youtube#video, essa coluna estará presente e seu valor conterá o ID que o YouTube usa para identificar exclusivamente o vídeo na lista de reprodução. | |||
VideoId | String | O ID que o YouTube usa para identificar exclusivamente um vídeo. Para recuperar o recurso de vídeo, defina a coluna ID com esse valor. | |||
Note | String | Uma nota gerada pelo usuário para este item. | |||
VideoOwnerPublishedAt | Datetime | A data e a hora em que o vídeo foi publicado no YouTube. O valor é especificado no formato ISO 8601 (AAAA-MM-DDThhss.sZ). | |||
PrivacyStatus | String | O status de privacidade do item da lista de reprodução. |
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 |
---|---|---|
OnBehalfOfContentOwner | String | Este parâmetro destina-se exclusivamente a parceiros de conteúdo do YouTube. |
PlayLists
Consulte listas de reprodução do YouTube. Uma PlayList é uma coleção de vídeos que podem ser visualizados sequencialmente e compartilhados com outros usuários.
Informações específicas da tabela
Selecione
Por padrão, SupportEnhancedSQL
é definido como verdadeiro e o seguinte será transmitido ao YouTube Analytics, se presente. Outros filtros serão executados no lado do cliente. Se SupportEnhancedSQL
for definido como falso, apenas os seguintes filtros serão respeitados.
Por padrão, se nenhum filtro for especificado, o Jitterbit Connector for YouTube Analytics retornará todas as listas de reprodução do canal de propriedade do usuário autenticado.
O YouTube Analytics permite que apenas um subconjunto de colunas seja usado como critério de filtro. Você pode especificar exatamente uma das seguintes colunas: ChannelId ou Id. Colunas extras opcionais com suporte são PublishedAt, Language, OnBehalfOfContentOwner e OnBehalfOfContentOwnerChannel.
Uma pesquisa em todos os canais no YouTube Analytics pode ser acionada especificando um ou mais SearchTerms, ForContentOwner, Region, SafeSearch, Rating e Rating para pesquisar todas as listas de reprodução.
Todas as colunas suportam o operador '='. PublishedAt também suporta estes operadores adicionais: '>', '>=', '<' e '<='.
Ordenar por é compatível com as colunas Classificação, Relevância e Título.
SELECT * FROM PlayLists WHERE Id = 'abcdef123456'
SELECT title FROM PlayLists WHERE PublishedAt >= '2016-01-01' ORDER BY Title LIMIT 10
Observação: a ordem não é suportada ao especificar uma das colunas usadas para pesquisar listas de reprodução, como SearchTerms.
Colunas
Nome | Tipo | Dimensão | Métrica Padrão | Dimensão padrão | Descrição |
---|---|---|---|---|---|
Id [KEY] | String | O ID que o YouTube usa para identificar exclusivamente a lista de reprodução. | |||
PublishedAt | Datetime | A data e a hora em que a lista de reprodução foi criada. O valor é especificado no formato ISO 8601 (AAAA-MM-DDThhss.sZ). | |||
ChannelId | String | O ID que o YouTube usa para identificar exclusivamente o canal que publicou a lista de reprodução. | |||
Title | String | O título da lista de reprodução. | |||
Description | String | A descrição da lista de reprodução. | |||
ThumbnailsDefaultUrl | String | A URL da imagem. | |||
ChannelTitle | String | Título do canal ao qual o vídeo pertence. | |||
DefaultLanguage | String | Esta coluna é confidencial para testadores confiáveis. O idioma do texto nas colunas Título e Descrição. | |||
LocalizedTitle | String | Esta coluna é confidencial para testadores confiáveis. O título da lista de reprodução localizada. | |||
LocalizedDescription | String | Esta coluna é confidencial para testadores confiáveis. A descrição da lista de reprodução localizada. | |||
PrivacyStatus | String | O status de privacidade da lista de reprodução. Valores válidos para esta coluna: privado, público, não listado. | |||
VideoCount | Integer | O número de vídeos na lista de reprodução. | |||
EmbedHtml | String | Uma tag iframe que incorpora um player que reproduzirá a lista de reprodução. | |||
SearchTerms | String | O parâmetro SearchTerms especifica o termo de consultar a ser pesquisado. |
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 |
---|---|---|
Language | String | Um valor de hl instrui a API a recuperar metadados de recursos localizados para um idioma de aplicativo específico compatível com o YouTube. |
OnBehalfOfContentOwner | String | Este parâmetro destina-se exclusivamente a parceiros de conteúdo do YouTube. |
OnBehalfOfContentOwnerChannel | String | Especifica o ID do canal do YouTube do canal ao qual um vídeo está sendo adicionado. |
ForContentOwner | String | Restringe a pesquisa para recuperar apenas listas de reprodução pertencentes ao proprietário do conteúdo especificado pela coluna OnBehalfOfContentOwner. |
Region | String | Instrui a API a retornar resultados de pesquisa para o país especificado. |
SafeSearch | String | Indica se os resultados da pesquisa devem incluir conteúdo restrito, bem como conteúdo padrão. Valores válidos: moderado, nenhum ou estrito. |
Rating | String | Especifica que as listas de reprodução são classificadas da classificação mais alta para a mais baixa. |
Regiões
Consulta YouTube i18nRegions. Um recurso i18nRegion identifica uma área geográfica que um usuário do YouTube pode selecionar como a região de conteúdo preferencial. A região de conteúdo também pode ser chamada de localidade de conteúdo.
Informações específicas da tabela
Selecione
Não há filtros obrigatórios para esta tabela. Uma coluna opcional suportada é Idioma.
Todas as colunas suportam o operador '='.
Colunas
Nome | Tipo | Dimensão | Métrica Padrão | Dimensão padrão | Descrição |
---|---|---|---|---|---|
Id [KEY] | String | O ID que o YouTube usa para identificar exclusivamente a região i18n. | |||
Country | String | O código de país ISO de duas letras que identifica a região. | |||
Name | String | O nome da região. |
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 |
---|---|---|
Language | String | O parâmetro hl especifica o idioma que deve ser usado para valores de texto na resposta da API. O valor padrão é en_US. |
Assinaturas
Consultar assinaturas de usuários do YouTube. Uma assinatura notifica um usuário quando novos vídeos são adicionados a um canal ou quando outro usuário executa uma das várias ações no YouTube, como enviar um vídeo, avaliar um vídeo ou comentar um vídeo.
Informações específicas da tabela
Selecione
Você pode especificar exatamente uma das seguintes colunas: ChannelId, Id, MyRecentSubscribers ou MySubscribers.
As colunas extras opcionais com suporte são ForChannelId, OnBehalfOfContentOwner e OnBehalfOfContentOwnerChannel. Todas as colunas suportam o operador '='.
O pedido é compatível com Assinaturas. 'Alfabético', 'Relevância' e 'Não Lido' são as colunas de ordem com suporte.
Por padrão, se nenhum filtro for especificado, o driver retornará uma lista de canais assinados pelo usuário autenticado.
SELECT Title FROM Subscriptions WHERE ChannelId = 'abc123' ORDER BY Unread DESC
O valor padrão é SUBSCRIPTION_ORDER_RELEVANCE.
Colunas
Nome | Tipo | Dimensão | Métrica Padrão | Dimensão padrão | Descrição |
---|---|---|---|---|---|
Id [KEY] | String | O ID que o YouTube usa para identificar exclusivamente a assinatura. | |||
PublishedAt | Datetime | A data e a hora em que a assinatura foi criada. O valor é especificado no formato ISO 8601 (AAAA-MM-DDThhss.sZ). | |||
ChannelTitle | String | O título do canal ao qual a assinatura pertence. | |||
Title | String | O título da assinatura. | |||
Description | String | Os detalhes da assinatura. | |||
ResourceIdKind | String | O tipo do recurso da API. | |||
ResourceIdChannelId | String | O valor que o YouTube usa para identificar exclusivamente o canal no qual o usuário se inscreveu. | |||
ChannelId | String | O ID que o YouTube usa para identificar exclusivamente o canal do assinante. | |||
ThumbnailsDefaultUrl | String | A URL da imagem padrão. | |||
TotalItemCount | Integer | O número aproximado de itens para os quais a assinatura aponta. | |||
NewItemCount | Integer | O número de novos itens na assinatura desde a última leitura de seu conteúdo. | |||
ActivityType | String | O tipo de atividade para a qual esta assinatura se destina. Valores válidos: todos, uploads. | |||
SubscriberTitle | String | O título do canal do assinante. | |||
SubscriberDescription | String | A descrição do canal do assinante. | |||
SubscriberChannelId | String | O ID que o YouTube atribui para identificar exclusivamente o canal do assinante. | |||
SubscriberThumbnailsDefaultUrl | String | A URL da imagem padrão. |
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 |
---|---|---|
MySubscribers | String | Configure este valor deste parâmetro como true para recuperar um feed dos assinantes do usuário autenticado. |
ForChannelId | String | A coluna ForChannelId especifica uma lista separada por vírgulas de IDs de canais. |
OnBehalfOfContentOwner | String | Esta coluna destina-se exclusivamente a parceiros de conteúdo do YouTube. |
OnBehalfOfContentOwnerChannel | String | Especifica o YouTube ChannelId do canal ao qual um vídeo está sendo adicionado. |
Alphabetical | String | Ordenar alfabeticamente |
Relevance | String | Classifique por relevância. |
Unread | String | Classifique por ordem de atividade. |
TimeBasedReports
Consulte informações baseadas em tempo sobre visualizações, inscritos, etc. Por exemplo, quantos novos inscritos foram obtidos em um horário específico.
Informações específicas da tabela
Selecionar Regras
Você pode usar as tabelas a seguir para criar consultas a relatórios baseados em tempo: Relatórios baseados em tempo para vídeos:
| Dimensões | Use 0 ou mais | dia, mês, vídeo | | -------------- | ----------------- | | Métricas | Use 1 ou mais | visualizações, comentários, curtidas, desgostos, videosAddedToPlaylists, videosRemovedFromPlaylists, compartilhamentos,ratedMinutesWatched, averageViewDuration, averageViewPercentage, annotationClickThroughRate, annotationCloseRate, annotationImpressions, annotationClickableImpressions, annotationClosableImpressions, annotationClicks, annotationCloses, assinantesGanhos, assinantesPerdidos, únicos, ganhos, adEarnings, grossRevenue, redPartnerRevenue, monetizedPlaybacks, playbackBasedCpm, impressões, impressionBasedCpm | | Filtro | Use 0 ou um | país, continente, subcontinente | | Use 0 or one
| vídeo, grupo |
Relatórios baseados em tempo para regras de lista de reprodução:
| Dimensões | Use exatamente um | dia, mês | | --------------- | ------------------------------------------ | | Use 0 or more
| subscritoStatus, youtubeProduct | | Métricas | Use 1 ou mais | visualizações, minutos estimados assistidos, averageViewDuration, playlistStarts, viewsPerPlaylistStart, averageTimeInPlaylist | | Filtro | Obrigatório | isCurated=true | | Use 0 or one
| país, província, continente, subcontinente | | Use 0 or one
| playlist, canal, grupo | | Use 0 or more
| subscritoStatus, youtubeProduto |
Relatórios baseados em tempo para regras de proprietário de conteúdo:
| Dimensões | Use exatamente um | dia, mês | | -------------- | -------------------------------- | | Métricas | Use 1 ou mais | visualizações, comentários, curtidas, desgostos, videosAddedToPlaylists, videosRemovedFromPlaylists, compartilhamentos,ratedMinutesWatched, averageViewDuration, averageViewPercentage, annotationClickThroughRate, annotationCloseRate, annotationImpressions, annotationClickableImpressions, annotationClosableImpressions, annotationClicks, annotationCloses, assinantesGanhos, assinantesPerdidos, únicos, ganhos, adEarnings, grossRevenue, redPartnerRevenue, monetizedPlaybacks, playbackBasedCpm, impressões, impressionBasedCpm | | Filtro | Use exatamente um | vídeo, canal, grupo | | Use 0 or one
| país, continente, subcontinente |
Relatórios baseados em tempo para regras de lista de reprodução do proprietário do conteúdo:
| Dimensões | Use exatamente um | dia, mês | | --------------- | ------------------------------------------ | | Use 0 or more
| subscritoStatus, youtubeProduto | | Métricas | Use 1 ou mais | visualizações, minutos estimados assistidos, averageViewDuration, playlistStarts, viewsPerPlaylistStart, averageTimeInPlaylis | | Filtro | Obrigatório | isCurated=true | | Use 0 or one
| país, província, continente, subcontinente | | Use 0 or one
| playlist, canal, grupo | | Use 0 or more
| subscritoStatus, youtubeProduct |
Colunas
Nome | Tipo | Dimensão | Métrica Padrão | Dimensão padrão | Descrição |
---|---|---|---|---|---|
Channel | String | Verdadeiro | (usado apenas em relatórios de proprietários de conteúdo) O ID de um canal do YouTube. A dimensão do canal é frequentemente usada em relatórios de proprietários de conteúdo porque esses relatórios geralmente agregam dados para vários canais. | ||
Video | String | Verdadeiro | O ID de um vídeo do YouTube. | ||
Group | String | Verdadeiro | (somente filtro) O ID de um grupo do YouTube Analytics. | ||
Playlist | String | Verdadeiro | O ID de uma lista de reprodução do YouTube. | ||
Country | String | Verdadeiro | O país associado às métricas na linha do relatório. O valor da dimensão é um código de país ISO-3166-1 de duas letras, como EUA, CN (China) ou FR (França). O código de país ZZ é usado para relatar métricas para as quais o YouTube não conseguiu identificar o país associado. | ||
Province | String | Verdadeiro | O estado ou território dos EUA associado às métricas na linha do relatório. O valor da dimensão é um código ISO 3166-2 que identifica um estado dos EUA ou o Distrito de Columbia, como US-MI (Michigan) ou US-TX (Texas). O código de província US-ZZ é usado para relatar métricas para as quais o YouTube não conseguiu identificar o estado dos EUA associado. Se a coluna Província for especificada, País deverá ser definido como EUA na cláusula WHERE. | ||
Continent | String | Verdadeiro | (somente filtro) Um código de região estatística das Nações Unidas (ONU). A API suporta os seguintes valores: 002 África, 019 Américas (América do Norte, América Latina, América do Sul e Caribe), 142 Ásia, 150 Europa, 009 Oceania. Esta dimensão só pode ser usada para filtrar dados. | ||
SubContinent | String | Verdadeiro | (somente filtro) Um código de região estatística da ONU que identifica uma sub-região geográfica. | ||
Day | String | Verdadeiro | Verdadeiro | Quando você usa essa dimensão, os dados do relatório são agregados diariamente e cada linha contém dados de um dia. | |
Month | String | Verdadeiro | Os dados no relatório são agregados por mês civil. No relatório, as datas são listadas no formato AAAA-MM. Observação: se sua consultar SQL usar a dimensão Mês, os parâmetros StartDate e EndDate deverão ser definidos como o primeiro dia do mês. | ||
IsCurated | Boolean | Verdadeiro | Este filtro indica que a solicitação está recuperando dados sobre exibições de vídeo que ocorreram no contexto de uma lista de reprodução. Esse filtro é necessário para qualquer relatório de lista de reprodução e seu valor deve ser definido como 1. Voltar para o início | ||
ClaimedStatus | String | Verdadeiro | (usado apenas em relatórios de proprietários de conteúdo) Essa dimensão permite indicar que um conjunto de resultados conterá apenas métricas para conteúdo reivindicado. O valor permitido é reivindicado. | ||
UploaderType | String | Verdadeiro | (usado apenas em relatórios de proprietários de conteúdo) Essa dimensão permite indicar se um conjunto de resultados conterá métricas para conteúdo enviado pelo proprietário do conteúdo especificado ou conteúdo enviado por terceiros, como vídeos enviados por usuários. Os valores permitidos são self e thirdParty. | ||
SubscribedStatus | String | Verdadeiro | Essa dimensão indica se as métricas de atividade do usuário na linha de dados estão associadas a espectadores que se inscreveram no canal de vídeo ou lista de reprodução. Os valores possíveis são SUBSCRIBED e UNSCRIBED. Observe que o valor da dimensão é preciso a partir do momento em que a atividade do usuário ocorre. | ||
YouTubeProduct | String | Verdadeiro | Essa dimensão identifica o serviço do YouTube no qual ocorreu a atividade do usuário. Os dados dessa dimensão estão disponíveis desde 18 de julho de 2015. Os valores permitidos são CORE, GAMING, KIDS, UNKNOWN. | ||
Views | Double | Falso | Verdadeiro | O número de vezes que um vídeo foi visualizado. Em um relatório de lista de reprodução, a métrica indica o número de vezes que um vídeo foi visualizado no contexto de uma lista de reprodução. | |
ViewerPercentage | Double | Falso | Falso | A porcentagem de espectadores que fizeram login ao assistir ao vídeo ou à lista de reprodução. | |
EstimatedMinutesWatched | Double | Falso | Verdadeiro | O número de minutos que os usuários assistiram aos vídeos do canal, proprietário do conteúdo, vídeo ou lista de reprodução especificados. | |
AverageViewDuration | Double | Falso | Verdadeiro | A duração média, em segundos, das reproduções de vídeo. Em um relatório de lista de reprodução, a métrica indica a duração média, em segundos, das reproduções de vídeo que ocorreram no contexto de uma lista de reprodução. | |
AverageViewPercentage | Double | Falso | Verdadeiro | A porcentagem média de um vídeo assistido durante uma reprodução de vídeo. | |
Comments | Double | Falso | Verdadeiro | O número de vezes que os usuários comentaram em um vídeo. | |
Likes | Double | Falso | Verdadeiro | O número de vezes que os usuários indicaram que gostaram de um vídeo, dando-lhe uma avaliação positiva. | |
Dislikes | Double | Falso | Verdadeiro | O número de vezes que os usuários indicaram que não gostaram de um vídeo, atribuindo-lhe uma classificação negativa. Essa é uma métrica principal e está sujeita à política de descontinuação. | |
Shares | Double | Falso | Verdadeiro | O número de vezes que os usuários compartilharam um vídeo por meio do botão Compartilhar. | |
SubscribersGained | Double | Falso | Verdadeiro | O número de vezes que os usuários se inscreveram em um canal ou vídeo. | |
SubscribersLost | Double | Falso | Verdadeiro | O número de vezes que os usuários cancelaram a inscrição em um canal ou vídeo. | |
VideosAddedToPlaylists | Double | Falso | Verdadeiro | O número de vezes que os vídeos foram adicionados à lista de reprodução do proprietário do vídeo ou a outras listas de reprodução do canal, como a lista de reprodução Assistir mais tarde. As listas de reprodução de uploads do canal e o histórico de exibição do usuário não são relatados. Essa métrica retorna um número absoluto, o que significa que, se um usuário adicionar um vídeo a uma lista de reprodução, removê-lo e adicioná-lo novamente, o valor da métrica refletirá o vídeo sendo adicionado a uma lista de reprodução duas vezes. Os dados dessa métrica não estão disponíveis para datas anteriores a 1º de outubro de 2014. | |
VideosRemovedFromPlaylists | Double | Falso | Verdadeiro | O número de vezes que os vídeos foram removidos da lista de reprodução do proprietário do vídeo e de outras listas de reprodução do YouTube, como a lista de reprodução Assistir mais tarde. Essa métrica retorna um número absoluto, o que significa que, se um usuário adicionar um vídeo a uma lista de reprodução, removê-lo, adicioná-lo novamente e removê-lo novamente, o valor da métrica refletirá o vídeo sendo removido de uma lista de reprodução duas vezes. Os dados dessa métrica não estão disponíveis para datas anteriores a 1º de outubro de 2014. | |
PlaylistStarts | Double | Falso | Falso | O número de vezes que os espectadores iniciaram a reprodução de uma lista de reprodução. | |
ViewsPerPlaylistStart | Double | Falso | Falso | O número médio de exibições de vídeo ocorridas sempre que uma lista de reprodução foi iniciada. | |
AverageTimeInPlaylist | Double | Falso | Falso | O tempo médio estimado, em minutos, que um espectador assistiu aos vídeos em uma lista de reprodução após o início da lista de reprodução. | |
AnnotationImpressions | Double | Falso | Verdadeiro | O número total de impressões de anotação. | |
AnnotationClickableImpressions | Double | Falso | Verdadeiro | O número de anotações que apareceram e puderam ser clicadas. | |
AnnotationClicks | Double | Falso | Verdadeiro | O número de anotações clicadas. | |
AnnotationClickThroughRate | Double | Falso | Verdadeiro | A proporção de anotações em que os visualizadores clicaram em relação ao número total de impressões de anotações clicáveis. | |
AnnotationClosableImpressions | Double | Falso | Verdadeiro | O número de anotações que apareceram e puderam ser fechadas. | |
AnnotationCloses | Double | Falso | Verdadeiro | O número de anotações fechadas. | |
AnnotationCloseRate | Double | Falso | Verdadeiro | A proporção de anotações que os visualizadores fecharam em relação ao número total de impressões de anotações. | |
EstimatedRevenue | Decimal | Falso | Falso | Os ganhos totais estimados (receita líquida) de todas as fontes de publicidade vendidas pelo Google, bem como de fontes não publicitárias para o período e a região selecionados. Os ganhos estimados estão sujeitos a ajustes no final do mês e não incluem publicidade vendida e veiculada por parceiros. | |
EstimatedAdRevenue | Decimal | Falso | Falso | Os ganhos totais estimados (receita líquida) de todas as fontes de publicidade vendidas pelo Google para o período e a região selecionados. Os ganhos estimados estão sujeitos a ajustes no final do mês e não incluem publicidade vendida e veiculada por parceiros. | |
EstimatedRedPartnerRevenue | Decimal | Falso | Falso | A receita total estimada obtida com as assinaturas do YouTube Red para as dimensões de relatório selecionadas. O valor da métrica reflete os ganhos de conteúdo musical e não musical e está sujeito a ajustes no final do mês. | |
GrossRevenue | Decimal | Falso | Falso | A receita bruta estimada, em USD, de toda a publicidade vendida pelo Google ou por parceiros da DoubleClick para o período e a região selecionados. A receita bruta está sujeita a ajustes no final do mês e não inclui publicidade veiculada por parceiros. A receita bruta não deve ser confundida com ganhos ou receita líquida, que considera sua parcela de propriedade e acordos de compartilhamento de receita. | |
Cpm | Decimal | Falso | Falso | A receita bruta estimada por mil impressões de anúncios. | |
AdImpressions | Double | Falso | Falso | O número de impressões de anúncios verificadas exibidas. | |
MonetizedPlaybacks | Double | Falso | Falso | O número de instâncias em que um espectador reproduziu seu vídeo e viu pelo menos uma impressão de anúncio. Uma reprodução monetizada é contada se um espectador vê um anúncio precedente, mas desiste de assistir ao anúncio antes do início do vídeo. O erro estimado esperado para este valor é de ±2,0%. | |
PlaybackBasedCpm | Decimal | Falso | Falso | A receita bruta estimada por mil reproduções. | |
StartDate | Date | Data de início para buscar dados do Analytics. | |||
EndDate | Date | Data de término para buscar dados do Analytics. |
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 |
---|---|---|
Segments | String | Segmenta os dados retornados para sua solicitação. Um SegmentId ou um segmento personalizado. |
Principais vídeos
Consulte os TopVideos de um canal ou as TopPlaylists se você for um proprietário de conteúdo. Você também pode usar esta exibição para consultar detalhes de reprodução e filtros geográficos.
Informações específicas da tabela
Selecione
A consultar a seguir retorna os principais vídeos de um canal por mais minutos assistidos:
SELECT * FROM TopVideos
A consultar a seguir retorna os principais vídeos de um canal por mais minutos assistidos em um país específico:
SELECT Video, Views, EstimatedMinutesWatched, AverageViewDuration, AverageViewPercentage FROM TopVideos WHERE Country = 'US'
A consultar a seguir retorna as principais playlists de um canal por mais minutos assistidos:
SELECT Playlist, Views, EstimatedMinutesWatched, PlaylistStarts, AverageViewDuration FROM TopVideos WHERE IsCurated=true
Selecionar Regras
Você pode usar as tabelas a seguir para criar outras consultas aos principais vídeos:
Principais vídeos para vídeos:
Dimensões | Obrigatório | vídeo |
---|---|---|
Métricas | Use 1 ou mais | visualizações, comentários, curtidas, não curtidas, videosAddedToPlaylists, videosRemovedFromPlaylists, compartilhamentos,ratedMinutesWatched, averageViewDuration, averageViewPercentage, annotationClickThroughRate, annotationCloseRate, annotationImpressions, annotationClickableImpressions, annotationClosableImpressions, annotationClicks, annotationCloses, assinantesGanhos, assinantesPerdidos |
Filtro | Use 0 ou um | país, continente, subcontinente |
Ordenar | Use 0 ou mais (somente ordem decrescente) | visualizações, minutos estimados assistidos, assinantes ganhos, assinantes perdidos |
Principais vídeos para listas de reprodução:
| Dimensões | Obrigatório | lista de reprodução | | --------------- | ------------------------------------------ | | Métricas | Use 1 ou mais | visualizações, minutos estimados assistidos, averageViewDuration, playlistStarts, viewsPerPlaylistStart, averageTimeInPlaylist | | Filtro | Obrigatório | isCurated=true | | Use 0 or one
| país, província, continente, subcontinente | | Use 0 or more
| lista de reprodução, subscritoStatus, youtubeProduct | | Ordenar | Use 0 ou mais (somente ordem decrescente) | visualizações, minutos estimados assistidos, lista de reproduçãoInícios |
Principais vídeos para proprietários de conteúdo:
| Dimensões | Obrigatório | vídeo | | -------------- | ------------------------------------- | | Métricas | Use 1 ou mais | visualizações, comentários, curtidas, não curtidas, videosAddedToPlaylists, videosRemovedFromPlaylists, compartilhamentos,ratedMinutesWatched, averageViewDuration, averageViewPercentage, annotationClickThroughRate, annotationCloseRate, annotationImpressions, annotationClickableImpressions, annotationClosableImpressions, annotationClicks, annotationCloses, assinantesGanhos, assinantesPerdidos, ganhos, adEarnings, grossRevenue, redPartnerRevenue, monetizedPlaybacks, playbackBasedCpm, impressões, impressionBasedCpm | | Filtro | Use exatamente um | canal | | Use 0 or one
| país, continente, subcontinente | | Ordenar | Use 0 ou mais (somente ordem decrescente) | visualizações, ganhos, redPartnerRevenue, estimadoMinutesAssistido, assinantesGanhos, assinantesPerdidos |
Principais vídeos para listas de reprodução de proprietários de conteúdo:
| Dimensões | Obrigatório | lista de reprodução | | --------------- | ------------------------------------------ | | Métricas | Use 1 ou mais | visualizações, minutos estimados assistidos, averageViewDuration, playlistStarts, viewsPerPlaylistStart, averageTimeInPlaylist | | Filtro | Obrigatório | isCurated=true | | Use 0 or one
| lista de reprodução, canal | | Use 0 or one
| país, província, continente, subcontinente | | Use 0 or more
| subscritoStatus, youtubeProduto | | Ordenar | Use 0 ou mais (somente ordem decrescente) | visualizações, minutos estimados assistidos, lista de reproduçãoInícios |
Colunas
Nome | Tipo | Dimensão | Métrica Padrão | Dimensão padrão | Descrição |
---|---|---|---|---|---|
Channel | String | Verdadeiro | (usado apenas em relatórios de proprietários de conteúdo) O ID de um canal do YouTube. A dimensão do canal é frequentemente usada em relatórios de proprietários de conteúdo porque esses relatórios geralmente agregam dados para vários canais. | ||
Video | String | Verdadeiro | Verdadeiro | O ID de um vídeo do YouTube. | |
Playlist | String | Verdadeiro | O ID de uma lista de reprodução do YouTube. | ||
Group | String | Verdadeiro | (somente filtro) O ID de um grupo do YouTube Analytics. | ||
Country | String | Verdadeiro | O país associado às métricas na linha do relatório. O valor da dimensão é um código de país ISO-3166-1 de duas letras, como EUA, CN (China) ou FR (França). O código de país ZZ é usado para relatar métricas para as quais o YouTube não conseguiu identificar o país associado. | ||
Province | String | Verdadeiro | O estado ou território dos EUA associado às métricas na linha do relatório. O valor da dimensão é um código ISO 3166-2 que identifica um estado dos EUA ou o Distrito de Columbia, como US-MI (Michigan) ou US-TX (Texas). O código de província US-ZZ é usado para relatar métricas para as quais o YouTube não conseguiu identificar o estado dos EUA associado. Se a coluna Província for especificada, País deverá ser definido como EUA na cláusula WHERE. | ||
Continent | String | Verdadeiro | (somente filtro) Um código de região estatística das Nações Unidas (ONU). A API suporta os seguintes valores: 002 África, 019 Américas (América do Norte, América Latina, América do Sul e Caribe), 142 Ásia, 150 Europa, 009 Oceania. Esta dimensão só pode ser usada para filtrar dados. | ||
SubContinent | String | Verdadeiro | (somente filtro) Um código de região estatística da ONU que identifica uma sub-região geográfica. | ||
IsCurated | Boolean | Verdadeiro | Este filtro indica que a solicitação está recuperando dados sobre exibições de vídeo que ocorreram no contexto de uma lista de reprodução. Esse filtro é necessário para qualquer relatório de lista de reprodução e seu valor deve ser definido como 1. Voltar para o início | ||
ClaimedStatus | String | Verdadeiro | (usado apenas em relatórios de proprietários de conteúdo) Essa dimensão permite indicar que um conjunto de resultados conterá apenas métricas para conteúdo reivindicado. O valor permitido é reivindicado. | ||
UploaderType | String | Verdadeiro | (usado apenas em relatórios de proprietários de conteúdo) Essa dimensão permite indicar se um conjunto de resultados conterá métricas para conteúdo enviado pelo proprietário do conteúdo especificado ou conteúdo enviado por terceiros, como vídeos enviados por usuários. Os valores permitidos são self e thirdParty. | ||
SubscribedStatus | String | Verdadeiro | Essa dimensão indica se as métricas de atividade do usuário na linha de dados estão associadas a espectadores que se inscreveram no canal de vídeo ou lista de reprodução. Os valores possíveis são SUBSCRIBED e UNSCRIBED. Observe que o valor da dimensão é preciso a partir do momento em que a atividade do usuário ocorre. | ||
YouTubeProduct | String | Verdadeiro | Essa dimensão identifica o serviço do YouTube no qual ocorreu a atividade do usuário. Os dados dessa dimensão estão disponíveis desde 18 de julho de 2015. Os valores permitidos são CORE, GAMING, KIDS, UNKNOWN. | ||
Views | Double | Falso | Verdadeiro | O número de vezes que um vídeo foi visualizado. Em um relatório de lista de reprodução, a métrica indica o número de vezes que um vídeo foi visualizado no contexto de uma lista de reprodução. | |
EstimatedMinutesWatched | Double | Falso | Verdadeiro | O número de minutos que os usuários assistiram aos vídeos do canal, proprietário do conteúdo, vídeo ou lista de reprodução especificados. | |
AverageViewDuration | Double | Falso | Verdadeiro | A duração média, em segundos, das reproduções de vídeo. Em um relatório de lista de reprodução, a métrica indica a duração média, em segundos, das reproduções de vídeo que ocorreram no contexto de uma lista de reprodução. | |
AverageViewPercentage | Double | Falso | Falso | A porcentagem média de um vídeo assistido durante uma reprodução de vídeo. | |
PlaylistStarts | Double | Falso | Falso | O número de vezes que os espectadores iniciaram a reprodução de uma lista de reprodução. | |
Likes | Double | Falso | Falso | O número de vezes que os usuários indicaram que gostaram de um vídeo, dando-lhe uma avaliação positiva. | |
ViewerPercentage | Double | Falso | Falso | A porcentagem de espectadores que fizeram login ao assistir ao vídeo ou à lista de reprodução. | |
Comments | Double | Falso | Verdadeiro | O número de vezes que os usuários comentaram em um vídeo. | |
Dislikes | Double | Falso | Verdadeiro | O número de vezes que os usuários indicaram que não gostaram de um vídeo, atribuindo-lhe uma classificação negativa. Essa é uma métrica principal e está sujeita à política de descontinuação. | |
Shares | Double | Falso | Verdadeiro | O número de vezes que os usuários compartilharam um vídeo por meio do botão Compartilhar. | |
SubscribersGained | Double | Falso | Verdadeiro | O número de vezes que os usuários se inscreveram em um canal ou vídeo. | |
SubscribersLost | Double | Falso | Verdadeiro | O número de vezes que os usuários cancelaram a inscrição em um canal ou vídeo. | |
VideosAddedToPlaylists | Double | Falso | Verdadeiro | O número de vezes que os vídeos foram adicionados à lista de reprodução do proprietário do vídeo ou a outras listas de reprodução do canal, como a lista de reprodução Assistir mais tarde. As listas de reprodução de uploads do canal e o histórico de exibição do usuário não são relatados. Essa métrica retorna um número absoluto, o que significa que, se um usuário adicionar um vídeo a uma lista de reprodução, removê-lo e adicioná-lo novamente, o valor da métrica refletirá o vídeo sendo adicionado a uma lista de reprodução duas vezes. Os dados dessa métrica não estão disponíveis para datas anteriores a 1º de outubro de 2014. | |
VideosRemovedFromPlaylists | Double | Falso | Verdadeiro | O número de vezes que os vídeos foram removidos da lista de reprodução do proprietário do vídeo e de outras listas de reprodução do YouTube, como a lista de reprodução Assistir mais tarde. Essa métrica retorna um número absoluto, o que significa que, se um usuário adicionar um vídeo a uma lista de reprodução, removê-lo, adicioná-lo novamente e removê-lo novamente, o valor da métrica refletirá o vídeo sendo removido de uma lista de reprodução duas vezes. Os dados dessa métrica não estão disponíveis para datas anteriores a 1º de outubro de 2014. | |
ViewsPerPlaylistStart | Double | Falso | Falso | O número médio de exibições de vídeo ocorridas sempre que uma lista de reprodução foi iniciada. | |
AverageTimeInPlaylist | Double | Falso | Falso | O tempo médio estimado, em minutos, que um espectador assistiu aos vídeos em uma lista de reprodução após o início da lista de reprodução. | |
AnnotationImpressions | Double | Falso | Verdadeiro | O número total de impressões de anotação. | |
AnnotationClickableImpressions | Double | Falso | Verdadeiro | O número de anotações que apareceram e puderam ser clicadas. | |
AnnotationClicks | Double | Falso | Verdadeiro | O número de anotações clicadas. | |
AnnotationClickThroughRate | Double | Falso | Verdadeiro | A proporção de anotações em que os visualizadores clicaram em relação ao número total de impressões de anotações clicáveis. | |
AnnotationClosableImpressions | Double | Falso | Verdadeiro | O número de anotações que apareceram e puderam ser fechadas. | |
AnnotationCloses | Double | Falso | Verdadeiro | O número de anotações fechadas. | |
AnnotationCloseRate | Double | Falso | Verdadeiro | A proporção de anotações que os visualizadores fecharam em relação ao número total de impressões de anotações. | |
EstimatedRevenue | Decimal | Falso | Falso | Os ganhos totais estimados (receita líquida) de todas as fontes de publicidade vendidas pelo Google, bem como de fontes não publicitárias para o período e a região selecionados. Os ganhos estimados estão sujeitos a ajustes no final do mês e não incluem publicidade vendida e veiculada por parceiros. | |
EstimatedAdRevenue | Decimal | Falso | Falso | Os ganhos totais estimados (receita líquida) de todas as fontes de publicidade vendidas pelo Google para o período e a região selecionados. Os ganhos estimados estão sujeitos a ajustes no final do mês e não incluem publicidade vendida e veiculada por parceiros. | |
EstimatedRedPartnerRevenue | Decimal | Falso | Falso | A receita total estimada obtida com as assinaturas do YouTube Red para as dimensões de relatório selecionadas. O valor da métrica reflete os ganhos de conteúdo musical e não musical e está sujeito a ajustes no final do mês. | |
GrossRevenue | Decimal | Falso | Falso | A receita bruta estimada, em USD, de toda a publicidade vendida pelo Google ou por parceiros da DoubleClick para o período e a região selecionados. A receita bruta está sujeita a ajustes no final do mês e não inclui publicidade veiculada por parceiros. A receita bruta não deve ser confundida com ganhos ou receita líquida, que considera sua parcela de propriedade e acordos de compartilhamento de receita. | |
Cpm | Decimal | Falso | Falso | A receita bruta estimada por mil impressões de anúncios. | |
AdImpressions | Double | Falso | Falso | O número de impressões de anúncios verificadas exibidas. | |
MonetizedPlaybacks | Double | Falso | Falso | O número de instâncias em que um espectador reproduziu seu vídeo e viu pelo menos uma impressão de anúncio. Uma reprodução monetizada é contada se um espectador vê um anúncio precedente, mas desiste de assistir ao anúncio antes do início do vídeo. O erro estimado esperado para este valor é de ±2,0%. | |
PlaybackBasedCpm | Decimal | Falso | Falso | A receita bruta estimada por mil reproduções. | |
StartDate | Date | Data de início para buscar dados do Analytics. Uma string de data ou uma data relativa (por exemplo, hoje, ontem ou #daysAgo). | |||
EndDate | Date | Data de término para buscar dados do Analytics. Uma string de data ou uma data relativa (por exemplo, hoje, ontem ou #daysAgo). |
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 |
---|---|---|
Segments | String | Segmenta os dados retornados para sua solicitação. Um SegmentId ou um segmento personalizado. |
TrafficSources
Consulta TrafficSources. As estatísticas são baseadas na maneira como os espectadores acessaram seu conteúdo de vídeo e lista de reprodução.
Informações específicas da tabela
Selecione
A consultar a seguir agrega estatísticas de exibição com base na maneira como os espectadores acessaram o conteúdo do seu vídeo; por exemplo, para identificar o número de visualizações provenientes de uma pesquisa no Google ou de um link para um vídeo relacionado.
SELECT * FROM TrafficSources
A consultar a seguir exibe as métricas Views e EstimatedMinutesWatched agrupadas pelas dimensões Day e InsightTrafficSourceType:
SELECT Day, InsightTrafficSourceType, Views, EstimatedMinutesWatched FROM TrafficSources
A consultar a seguir filtra as estatísticas a serem compiladas para um vídeo e país específicos:
SELECT Day, InsightTrafficSourceType, Views, EstimatedMinutesWatched FROM TrafficSources WHERE Video = 'video_id' AND Country = 'US'
A consultar a seguir agrega estatísticas de exibição com base na maneira como os espectadores acessaram o conteúdo da sua lista de reprodução; por exemplo, para identificar o número de visualizações provenientes de uma pesquisa no Google.
SELECT InsightTrafficSourceType, Views, EstimatedMinutesWatched, PlaylistStarts, ViewsPerPlaylistStart, AverageTimeInPlaylist FROM TrafficSources WHERE IsCurated=true
A consultar a seguir retorna os termos de pesquisa que geraram mais visualizações nos resultados de pesquisa do YouTube para vídeos localizados em listas de reprodução. Observe que a ordem e a limitação são necessárias para essa consultar devido a restrições na API do YouTube Analytics.
SELECT InsightTrafficSourceDetail, Views, EstimatedMinutesWatched, PlaylistStarts, ViewsPerPlaylistStart, AverageTimeInPlaylist FROM TrafficSources WHERE IsCurated=true AND InsightTrafficSourceType='YT_SEARCH' ORDER BY Views DESC LIMIT 25
Selecionar Regras
Você pode usar as tabelas a seguir para criar outras consultas às origens de tráfego:
Fontes de tráfego para vídeos:
| Dimensões | Use exatamente um | insightTrafficSourceType, insightTrafficSourceDetail | | --------------- | ------------------------------------- | | Use 0 or more
| dia, liveOrOnDemand, subscritoStatus | | Métricas | Use 1 ou mais | visualizações, estimadasMinutosAssistidos | | Filtro | Use 0 ou um | país, província, continente, subcontinente | | Use 0 or one
| vídeo, grupo | | Use 0 or more
| liveOrOnDemand, subscritoStatus | | Ordenar | Use 0 ou mais (somente ordem decrescente) | visualizações, estimadasMinutosAssistidos |
Fontes de tráfego para listas de reprodução:
| Dimensões | Use exatamente um | insightTrafficSourceType, insightTrafficSourceDetail | | --------------- | ------------------------------------------ | | Use 0 or more
| dia, inscritoStatus | | Métricas | Use 1 ou mais | visualizações, minutos estimados assistidos, playlistStarts, viewsPerPlaylistStart, averageTimeInPlaylist | | Filtro | Obrigatório | isCurated=true | | Use 0 or one
| país, província, continente, subcontinente | | Use 0 or one
| playlist, canal, grupo | | Optional
| subscritoEstado | | Ordenar | Use 0 ou mais (somente ordem decrescente) | visualizações, minutos estimados assistidos, lista de reproduçãoInícios |
Fontes de tráfego para proprietários de conteúdo:
| Dimensões | Obrigatório | insightTrafficSourceType | | --------------- | ------------------------------------------ | | Use 0 or more
| dia, liveOrOnDemand, subscritoStatus | | Métricas | Use 1 ou mais | visualizações, estimadasMinutosAssistidos | | Filtro | Use exatamente um | vídeo, canal, grupo | | Use 0 or one
| país, província, continente, subcontinente | | Use 0 or more
| liveOrOnDemand, subscritoStatus |
Fontes de tráfego para listas de reprodução de proprietários de conteúdo:
| Dimensões | Obrigatório | insightTrafficSourceType | | --------------- | ------------------------------------------ | | Use 0 or more
| dia, inscritoStatus | | Métricas | Use 1 ou mais | visualizações, minutos estimados assistidos, playlistStarts, viewsPerPlaylistStart, averageTimeInPlaylist | | Filtro | Obrigatório | isCurated=true | | Use 0 or one
| país, província, continente, subcontinente | | Use 0 or one
| playlist, canal, grupo | | Optional
| subscritoEstado |
Colunas
Nome | Tipo | Dimensão | Métrica Padrão | Dimensão padrão | Descrição |
---|---|---|---|---|---|
Channel | String | Verdadeiro | (usado apenas em relatórios de proprietários de conteúdo) O ID de um canal do YouTube. A dimensão do canal é frequentemente usada em relatórios de proprietários de conteúdo porque esses relatórios geralmente agregam dados para vários canais. | ||
Video | String | Verdadeiro | O ID de um vídeo do YouTube. | ||
Playlist | String | Verdadeiro | O ID de uma lista de reprodução do YouTube. | ||
Group | String | Verdadeiro | (somente filtro) O ID de um grupo do YouTube Analytics. | ||
Country | String | Verdadeiro | O país associado às métricas na linha do relatório. O valor da dimensão é um código de país ISO-3166-1 de duas letras, como EUA, CN (China) ou FR (França). O código de país ZZ é usado para relatar métricas para as quais o YouTube não conseguiu identificar o país associado. | ||
Province | String | Verdadeiro | O estado ou território dos EUA associado às métricas na linha do relatório. O valor da dimensão é um código ISO 3166-2 que identifica um estado dos EUA ou o Distrito de Columbia, como US-MI (Michigan) ou US-TX (Texas). O código de província US-ZZ é usado para relatar métricas para as quais o YouTube não conseguiu identificar o estado dos EUA associado. Se a coluna Província for especificada, País deverá ser definido como EUA na cláusula WHERE. | ||
Continent | String | Verdadeiro | (somente filtro) Um código de região estatística das Nações Unidas (ONU). Os valores permitidos são 002 África, 019 Américas (América do Norte, América Latina, América do Sul e Caribe), 142 Ásia, 150 Europa, 009 Oceania. Esta dimensão só pode ser usada para filtrar dados. | ||
SubContinent | String | Verdadeiro | (somente filtro) Um código de região estatística da ONU que identifica uma sub-região geográfica. | ||
Day | String | Verdadeiro | Quando você usa essa dimensão, os dados do relatório são agregados diariamente e cada linha contém dados de um dia. | ||
LiveOrOnDemand | String | Verdadeiro | Essa dimensão indica se as métricas de atividade do usuário na linha de dados estão associadas a exibições de uma transmissão ao vivo. Os dados dessa dimensão estão disponíveis para datas a partir de 1º de abril de 2014. Os valores permitidos são AO VIVO, ONDEMAND. | ||
SubscribedStatus | String | Verdadeiro | Essa dimensão indica se as métricas de atividade do usuário na linha de dados estão associadas a espectadores que se inscreveram no canal de vídeo ou lista de reprodução. Os valores permitidos são SUBSCRIBED, UNSCRIBED. Observe que o valor da dimensão é preciso a partir do momento em que a atividade do usuário ocorre. | ||
InsightTrafficSourceType | String | Verdadeiro | Verdadeiro | Os dados do relatório são agregados com base no tipo de referenciador, que descreve a maneira como os usuários acessaram o vídeo. Os valores permitidos são ADVERTISING, ANNOTATION, EXT_URL, NO_LINK_EMBEDDED, NO_LINK_OTHER, NOTIFICATION, PLAYLIST, PROMOTED, RELATED_VIDEO, SUBSCRIBER, YT_CHANNEL, YT_OTHER_PAGE, YT_SEARCH. | |
InsightTrafficSourceDetail | String | Verdadeiro | Detalhes sobre o InsightTrafficSourceType. | ||
IsCurated | Boolean | Verdadeiro | Este filtro indica que a solicitação está recuperando dados sobre exibições de vídeo que ocorreram no contexto de uma lista de reprodução. Esse filtro é necessário para qualquer relatório de lista de reprodução e seu valor deve ser definido como 1. Voltar para o início | ||
ClaimedStatus | String | Verdadeiro | (usado apenas em relatórios de proprietários de conteúdo) Essa dimensão permite indicar que um conjunto de resultados conterá apenas métricas para conteúdo reivindicado. O valor permitido é reivindicado. | ||
UploaderType | String | Verdadeiro | (usado apenas em relatórios de proprietários de conteúdo) Essa dimensão permite indicar se um conjunto de resultados conterá métricas para conteúdo enviado pelo proprietário do conteúdo especificado ou conteúdo enviado por terceiros, como vídeos enviados por usuários. Os valores permitidos são self e thirdParty. | ||
Views | Double | Falso | Verdadeiro | O número de vezes que um vídeo foi visualizado. Em um relatório de lista de reprodução, a métrica indica o número de vezes que um vídeo foi visualizado no contexto de uma lista de reprodução. | |
EstimatedMinutesWatched | Double | Falso | Verdadeiro | O número de minutos que os usuários assistiram aos vídeos do canal, proprietário do conteúdo, vídeo ou lista de reprodução especificados. | |
PlaylistStarts | Double | Falso | Falso | O número de vezes que os espectadores iniciaram a reprodução de uma lista de reprodução. | |
ViewsPerPlaylistStart | Double | Falso | Falso | O número médio de exibições de vídeo ocorridas sempre que uma lista de reprodução foi iniciada. | |
AverageTimeInPlaylist | Double | Falso | Falso | O tempo médio estimado, em minutos, que um espectador assistiu aos vídeos em uma lista de reprodução após o início da lista de reprodução. | |
StartDate | Date | Data de início para buscar dados do Analytics. | |||
EndDate | Date | Data de término para buscar dados do Analytics. |
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 |
---|---|---|
Segments | String | Segmenta os dados retornados para sua solicitação. Um SegmentId ou um segmento personalizado. |
VideoAbuseReportReasons
Consulte YouTube VideoAbuseReportReasons. Um recurso VideoAbuseReportReason contém informações sobre o motivo pelo qual um vídeo seria sinalizado por conter conteúdo abusivo.
Informações específicas da tabela
Selecione
Não há filtros obrigatórios para esta tabela. Uma coluna opcional é Idioma.
O operador '=' é compatível com esta coluna.
Colunas
Nome | Tipo | Dimensão | Métrica Padrão | Dimensão padrão | Descrição |
---|---|---|---|---|---|
Id [KEY] | String | O ID que o YouTube usa para identificar o motivo. | |||
Label | String | O texto do rótulo para o motivo. | |||
SecondaryReasonsAggregate | String | Uma lista de motivos secundários associados ao motivo, se houver algum disponível. Pode haver 0 ou mais. |
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 |
---|---|---|
Language | String | O parâmetro hl especifica o idioma que deve ser usado para valores de texto na resposta da API. O valor padrão é en_US. |
Categorias de vídeo
Consultar categorias de vídeo do YouTube. Um recurso VideoCategory identifica uma categoria que foi ou pode ser associada a vídeos enviados.
Informações específicas da tabela
Selecione
Você pode especificar exatamente uma das seguintes colunas: ID ou Região. Se você não especificar nenhum critério de filtragem, por padrão, obterá resultados para a região dos EUA. Um parâmetro opcional extra é o Idioma.
SELECT * FROM VideoCategories WHERE Region = 'JP'
O operador IN pode ser usado para filtrar vários IDs:
SELECT Id, Kind, Etag, ChannelId, Title, Assignable
FROM VideoCategories
WHERE (ID IN ('1', '2', '10'))
Colunas
Nome | Tipo | Dimensão | Métrica Padrão | Dimensão padrão | Descrição |
---|---|---|---|---|---|
Id [KEY] | String | O identificador exclusivo da categoria de vídeo. | |||
ChannelId | String | O canal do YouTube que criou a categoria de vídeo. | |||
Title | String | O título da categoria de vídeo. | |||
Assignable | Boolean | Indica se os vídeos podem ser associados à categoria. | |||
Region | String | O país do qual recuperar as categorias de vídeo. |
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 |
---|---|---|
Language | String | Especifica o idioma que deve ser usado para valores de texto na resposta da API. O valor padrão é en_US. |
Vídeos
Consultar vídeos do YouTube.
Informações específicas da tabela
Selecione
Por padrão, SupportEnhancedSQL
é definido como verdadeiro e o seguinte será transmitido ao YouTube Analytics, se presente. Outros filtros serão executados no lado do cliente. Se SupportEnhancedSQL
for definido como falso, apenas os seguintes filtros serão respeitados.
Por padrão, se nenhum filtro for especificado, o driver retornará todos os vídeos pertencentes ao usuário autenticado.
Apenas uma das seguintes colunas pode ser filtrada por vez: Id, MyRating, ChannelId ou Chart. As colunas extras suportadas são ForMine, Language, ForContentOwner, OnBehalfOfContentOwner.
Uma pesquisa em todos os vídeos no YouTube pode ser executada especificando SearchTerms, RelatedToVideoId, VideoDuration, VideoCategoryId ou Region.
Todas as colunas suportam o operador '='. PublishedAt também suporta estes operadores adicionais: '>', '>=', '<' e '<='. ID e ChannelId suportam IN.
Ordenar por é compatível com as colunas Data, Classificação, Relevância e Título.
SELECT * FROM Videos WHERE Id = '12345679'
SELECT * FROM Videos WHERE PublishedAt >= '2016-01-01T20:30:00Z' LIMIT 10
SELECT Description FROM Videos WHERE ForMine = True ORDER BY Date
Observação: A ordem não é suportada ao especificar uma das colunas usadas para pesquisar canais, como SearchTerms.
O operador IN pode ser usado para especificar uma lista de canais. Esta chamada retorna uma lista de vídeos para cada canal especificado.
SELECT * FROM Videos WHERE ChannelId IN (a, b, c)
SELECT * FROM Videos WHERE ChannelId IN (SELECT ID FROM Channels)
O operador IN também pode ser usado para obter dados de vários vídeos.
SELECT * FROM Videos WHERE ID IN (a, b, c)
Colunas
Nome | Tipo | Dimensão | Métrica Padrão | Dimensão padrão | Descrição |
---|---|---|---|---|---|
Id [KEY] | String | O ID que o YouTube usa para identificar exclusivamente o vídeo. | |||
ChannelId | String | O ID que o YouTube usa para identificar exclusivamente o canal para o qual o vídeo foi enviado. | |||
CategoryId | String | A categoria de vídeo do YouTube associada ao vídeo. | |||
Title | String | O título do vídeo. | |||
ChannelTitle | String | Título do canal ao qual o vídeo pertence. | |||
PublishedAt | Datetime | A data e a hora em que o vídeo foi publicado. Observe que esse horário pode ser diferente do horário em que o vídeo foi carregado. O valor é especificado no formato ISO 8601 (AAAA-MM-DDThhss.sZ). | |||
Description | String | A descrição do vídeo. | |||
Duration | String | A duração do vídeo. O valor da propriedade é uma duração ISO 8601. | |||
ViewCount | Long | O número de vezes que o vídeo foi visualizado. | |||
LikeCount | Long | O número de usuários que indicaram que gostaram do vídeo. | |||
DislikeCount | Long | O número de usuários que indicaram que não gostaram do vídeo. Em conjunto com as alterações para tornar a contagem de vídeos não favoritos privada em toda a plataforma do YouTube, esse campo é retornado apenas se a solicitação de API tiver sido autenticada pelo proprietário do vídeo. | |||
CommentCount | Long | O número de comentários para o vídeo. | |||
EmbedHtml | String | Uma tag iframe que incorpora um player que reproduzirá o vídeo. | |||
PublicStatsViewable | Boolean | Esse valor indica se as estatísticas de vídeo estendidas na página de exibição podem ser visualizadas publicamente. Por padrão, essas estatísticas podem ser visualizadas, e estatísticas como contagem de visualizações e avaliações ainda serão visíveis publicamente, mesmo que esse valor seja definido como falso. | |||
TagsAggregate | String | Uma lista de marcas de palavras-chave associadas ao vídeo. | |||
LiveBroadcastContent | String | Indica se o vídeo é uma transmissão ao vivo futura/ativa. Um valor de nenhum indica que o vídeo não é uma transmissão ao vivo futura/ativa. Valores válidos para esta coluna: ao vivo, nenhum, próximo. | |||
Dimension | String | Indica se o vídeo está disponível em 3D ou 2D. | |||
Definition | String | Indica se o vídeo está disponível em HD de alta definição ou apenas em definição padrão. Valores válidos para esta coluna: hd, sd. | |||
Caption | String | Indica se as legendas estão disponíveis para o vídeo. Valores válidos para esta coluna: false, true. | |||
LicensedContent | Boolean | Indica se o vídeo representa conteúdo licenciado, o que significa que o conteúdo foi enviado para um canal vinculado a um parceiro de conteúdo do YouTube e reivindicado por esse parceiro. | |||
AllowedAggregate | String | Uma lista de códigos de região que identificam os países onde o vídeo pode ser visualizado. | |||
BlockedAggregate | String | Uma lista de códigos de região que identificam os países onde o vídeo está bloqueado. | |||
Projection | String | Especifica o formato de projeção do vídeo. Valores válidos: 360, retangular. | |||
PrivacyStatus | String | O status de privacidade da lista de reprodução. Valores válidos: privado, público, não listado. | |||
MadeForKids | Boolean | Esse valor indica se o vídeo é feito para crianças. | |||
License | String | A licença. Valores válidos: creativeCommon, youtube. | |||
Embeddable | Boolean | Este valor indica se o vídeo pode ser incorporado em outro site. | |||
ThumbnailsDefaultUrl | String | A URL da imagem padrão. | |||
DefaultLanguage | String | Esta coluna é confidencial para testadores confiáveis. O idioma do texto nas colunas Título e Descrição. | |||
DefaultAudioLanguage | String | A coluna default_audio_language especifica o idioma falado na faixa de áudio padrão do vídeo. | |||
UploadStatus | String | O status do vídeo enviado. Valores válidos para esta coluna: excluído, com falha, processado, rejeitado, carregado. | |||
FailureReason | String | Este valor explica por que um vídeo não foi carregado. Esta coluna só tem um valor se a coluna UploadStatus indicar que o upload falhou. Valores válidos para esta coluna: codec, conversão, emptyFile, invalidFile, tooSmall, uploadAborted. | |||
RejectionReason | String | Esse valor explica por que o YouTube rejeitou um vídeo enviado. Esta coluna só tem um valor se a coluna UploadStatus indicar que o upload foi rejeitado. Valores válidos para esta coluna: reivindicação, direitos autorais, duplicado, inapropriado, comprimento, TermsOfUse, marca comercial, uploaderAccountClosed, uploaderAccountSuspended. | |||
RecordingDate | Datetime | A data e a hora em que o vídeo foi gravado. O valor é especificado no formato ISO 8601 (AAAA-MM-DDThhss.sssZ). | |||
SearchTerms | String | O termo de consultar a ser pesquisado. |
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 |
---|---|---|
SafeSearch | String | Indica se os resultados da pesquisa devem incluir conteúdo restrito, bem como conteúdo padrão. Valores aceitáveis: moderado, nenhum ou estrito. |
EventType | String | O parâmetro eventType restringe uma pesquisa a eventos de transmissão. Os valores aceitáveis são: COMPLETED, LIVE, UPCOMING. Os valores permitidos são COMPLETED, LIVE, UPCOMING. |
RelatedToVideoId | String | Recupera uma lista de vídeos relacionados ao vídeo que o valor da coluna identifica. |
VideoDuration | String | Filtra os resultados da pesquisa de vídeo com base em sua duração. Valores aceitáveis: qualquer, longo, médio ou curto. |
VideoCategoryId | String | O parâmetro videoCategoryId identifica a categoria de vídeo para a qual o gráfico deve ser recuperado. |
Region | String | Instrui a API a selecionar um gráfico de vídeo disponível na região especificada. Esta coluna só pode ser usada em conjunto com a coluna do gráfico. O valor do parâmetro é um código de país ISO 3166-1 alfa-2. |
ForMine | String | Restringe a pesquisa para recuperar apenas os vídeos pertencentes ao usuário autenticado. É falso por padrão. |
Chart | String | O parâmetro gráfico identifica o gráfico que você deseja recuperar. Os valores aceitáveis são: mostPopular - Retorna os vídeos mais populares para a região de conteúdo e categoria de vídeo especificadas. Os valores permitidos são mostPopular. |
MyRating | String | A classificação do usuário autenticado. Valores aceitáveis: gostar ou não gostar. Os valores permitidos são gostei, não gostei. |
Language | String | Recupere metadados de recursos localizados para um idioma de aplicativo específico compatível com o site do YouTube. |
ForContentOwner | String | Restringe a pesquisa para recuperar apenas os vídeos pertencentes ao proprietário do conteúdo especificado pelo parâmetro OnBehalfOfContentOwner. |
OnBehalfOfContentOwner | String | Este parâmetro destina-se exclusivamente a parceiros de conteúdo do YouTube. |
Procedimentos armazenados
Procedimentos armazenados* são interfaces semelhantes a funções que estendem a funcionalidade do conector além das simples operações SELECT/INSERT/UPDATE/DELETE com o YouTube Analytics.
Procedimentos armazenados* aceitar uma lista de parâmetros, executar a função pretendida e, em seguida, retornar, se aplicável, quaisquer dados de resposta relevantes do YouTube Analytics, junto com uma indicação de se o procedimento foi bem-sucedido ou não.
Conector Jitterbit para procedimentos armazenados do YouTube Analytics
Nome | Descrição |
---|---|
CreateCustomSchema | Cria um arquivo de esquema personalizado com base nas dimensões e métricas especificadas. |
GetOAuthAccessToken | Obtém o token de acesso OAuth para ser usado para autenticação com vários serviços do Google. |
GetOAuthAuthorizationURL | Obtém o URL de autorização OAuth usado para autenticação com vários serviços do Google. |
RefreshOAuthAccessToken | Obtém o token de acesso OAuth para ser usado para autenticação com vários serviços do Google. |
CreateCustomSchema
Cria um arquivo de esquema personalizado com base nas dimensões e métricas especificadas.
CreateCustomSchema
Cria um arquivo de esquema personalizado com base nas dimensões e métricas especificadas.
Um esquema personalizado pode ser usado para uma abordagem mais personalizada para seus dados. As opções personalizadas podem incluir listas separadas por vírgulas para dados específicos.
Entrada
Nome | Tipo | Obrigatório | Aceita fluxos de saída | Descrição |
---|---|---|---|---|
TableName | String | Verdade | Falso | O nome da nova tabela. |
FileName | String | Falso | Falso | O caminho completo do arquivo e o nome do esquema a ser gerado. Ex: 'C:\Usuários\Usuário\Desktop\JiraSD\DataSetTest.rsd' |
Description | String | Falso | Falso | Uma descrição opcional para a tabela. |
Dimensions | String | Falso | Falso | Uma lista separada por vírgulas de dimensões a serem incluídas no arquivo de esquema. |
Metrics | String | Verdade | Falso | Uma lista separada por vírgulas de métricas a serem incluídas no arquivo de esquema. |
FileStream | String | Falso | Verdade | Fluxo contendo o esquema baixado se nenhum FileName for especificado |
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. |
FileData | String | O esquema gerado codificado em Base64. Retornado apenas se FileName ou FileStream não estiver definido. |
GetOAuthAccessToken
Obtém o token de acesso OAuth para ser usado para autenticação com vários serviços do Google.
Entrada
Nome | Tipo | Obrigatório | Descrição |
---|---|---|---|
AuthMode | String | Verdade | O tipo de modo de autenticação a ser usado. Os valores permitidos são APP, WEB. O valor padrão é WEB. |
Verifier | String | Falso | O código do verificador retornado pelo Google depois que a permissão para o aplicativo se conectar foi concedida. WEB AuthMode apenas. |
Scope | String | Verdade | O escopo de acesso às APIs do Google. Por padrão, o acesso a todas as APIs usadas por esse provedor de dados será especificado. o valor padrão é *https://www.googleapis.com/auth/youtube https://www.googleapis.com/auth/youtube.readonly https://www.googleapis.com/auth/youtubepartner https://www.googleapis.com/auth/yt-analytics-monetary.readonly https://www.googleapis.com/auth/yt-analytics.readonly https://www.googleapis.com/auth/youtube.force-ssl* . |
CallbackURL | String | Falso | Este campo determina para onde a resposta é enviada. O valor desse parâmetro deve corresponder exatamente a um dos valores registrados no Console de APIs, incluindo os esquemas HTTP ou HTTPS, capitalização e barra final ('/'). |
Prompt | String | Verdade | Este campo indica o prompt para apresentar ao usuário. Ele aceita um dos seguintes valores: NONE, CONSENT, SELECT ACCOUNT. O padrão é SELECT_ACCOUNT, portanto, um determinado usuário será solicitado a selecionar a conta à qual se conectar. Se estiver definido como CONSENT, o usuário verá uma página de consentimento todas as vezes, mesmo que já tenha dado consentimento ao aplicativo para um determinado conjunto de escopos. Por fim, se for definido como NONE, nenhuma tela de autenticação ou consentimento será exibida ao usuário. O valor padrão é SELECT_ACCOUNT. |
AccessType | String | Verdade | Este campo indica se seu aplicativo precisa acessar uma API do Google quando o usuário não está presente no navegador. O padrão deste parâmetro é ONLINE. Se seu aplicativo precisar atualizar os tokens de acesso quando o usuário não estiver presente no navegador, use OFFLINE. Isso fará com que seu aplicativo obtenha um token de atualização na primeira vez que seu aplicativo trocar um código de autorização para um usuário. Os valores permitidos são ONLINE, OFFLINE. O valor padrão é OFFLINE. |
State | String | Falso | Este campo 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 Google. Os usos incluem redirecionar o usuário para o recurso correto em seu site, usar nonces e atenuar a falsificação de solicitação entre sites. |
Colunas do conjunto de resultados
Nome | Tipo | Descrição |
---|---|---|
OAuthAccessToken | String | O token de autenticação retornado do Google. Isso pode ser usado em chamadas subseqüentes para outras operações para este serviço específico. |
OAuthRefreshToken | String | Um token que pode ser usado para obter um novo token de acesso. |
ExpiresIn | String | O tempo de vida restante no token de acesso. |
GetOAuthAuthorizationURL
Obtém o URL de autorização OAuth usado para autenticação com vários serviços do Google.
Entrada
Nome | Tipo | Obrigatório | Descrição |
---|---|---|---|
Scope | String | Verdade | O escopo de acesso às APIs do Google. Por padrão, o acesso a todas as APIs usadas por esse provedor de dados será especificado. o valor padrão é *https://www.googleapis.com/auth/youtube https://www.googleapis.com/auth/youtube.readonly https://www.googleapis.com/auth/youtubepartner https://www.googleapis.com/auth/yt-analytics-monetary.readonly https://www.googleapis.com/auth/yt-analytics.readonly https://www.googleapis.com/auth/youtube.force-ssl* . |
CallbackURL | String | Falso | Este campo determina para onde a resposta é enviada. O valor desse parâmetro deve corresponder exatamente a um dos valores registrados no Console de APIs, incluindo os esquemas HTTP ou HTTPS, maiúsculas e minúsculas e barra final ('/'). |
Prompt | String | Verdade | Este campo indica o prompt para apresentar ao usuário. Ele aceita um dos seguintes valores: NONE, CONSENT, SELECT ACCOUNT. O padrão é SELECT_ACCOUNT, portanto, um determinado usuário será solicitado a selecionar a conta à qual se conectar. Se estiver definido como CONSENT, o usuário verá uma página de consentimento todas as vezes, mesmo que já tenha dado consentimento ao aplicativo para um determinado conjunto de escopos. Por fim, se for definido como NONE, nenhuma tela de autenticação ou consentimento será exibida ao usuário. O valor padrão é SELECT_ACCOUNT. |
AccessType | String | Verdade | Este campo indica se seu aplicativo precisa acessar uma API do Google quando o usuário não está presente no navegador. O padrão deste parâmetro é ONLINE. Se seu aplicativo precisar atualizar tokens de acesso quando o usuário não estiver presente no navegador, use OFFLINE. Isso fará com que seu aplicativo obtenha um token de atualização na primeira vez que seu aplicativo trocar um código de autorização para um usuário. Os valores permitidos são ONLINE, OFFLINE. O valor padrão é OFFLINE. |
State | String | Falso | Este campo 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 Google. Os usos possíveis incluem redirecionar o usuário para o recurso correto em seu site, usar nonces e atenuar a falsificação de solicitação entre sites. |
Colunas do conjunto de resultados
Nome | Tipo | Descrição |
---|---|---|
URL | String | A URL para concluir a autenticação do usuário. |
RefreshOAuthAccessToken
Obtém o token de acesso OAuth para ser usado para autenticação com vários serviços do Google.
Entrada
Nome | Tipo | Obrigatório | Descrição |
---|---|---|---|
OAuthRefreshToken | String | Verdade | O token de atualização retornado da troca do código de autorização original. |
Colunas do conjunto de resultados
Nome | Tipo | Descrição |
---|---|---|
OAuthAccessToken | String | O token de autenticação retornado do Google. Isso pode ser usado em chamadas subseqüentes para outras operações para este serviço específico. |
OAuthRefreshToken | String | O token de autenticação retornado do Google. 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 do banco de dados para o YouTube Analytics:
- sys_catalogs: Lista os bancos de dados disponíveis.
- sys_schemas: Lista os esquemas disponíveis.
- sys_tables: Lista as tabelas e exibições disponíveis.
- sys_tablecolumns: Descreve as colunas das tabelas e exibições disponíveis.
- sys_procedures: Descreve os procedimentos armazenados disponíveis.
- sys_procedureparameters: Descreve procedimento armazenado* parâmetros.
- sys_keycolumns: Descreve as chaves primárias e estrangeiras.
- sys_indexes: Descreve os índices disponíveis.
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 visualizaçã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 Grupos:
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Groups'
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 RefreshOAuthAccessToken:
SELECT * FROM sys_procedureparameters WHERE ProcedureName='RefreshOAuthAccessToken' 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 Grupos:
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Groups'
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_primarykeys
Descreve as chaves primárias. A consultar a seguir recupera as chaves primárias de todas as tabelas e exibições:
SELECT * FROM sys_primarykeys
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. |
KeySeq | String | O número de sequência da chave primária. |
KeyName | String | O nome da chave primária. |
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:youtubeanalytics: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.
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.
Propriedade | Descrição |
---|---|
AuthScheme | O tipo de autenticação a ser usado ao se conectar ao YouTube Analytics. |
ChannelId | O ID de um canal pertencente ao usuário autenticado. |
ContentOwnerId | A ID do detentor dos direitos autorais do conteúdo no sistema de gerenciamento de direitos do YouTube. |
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. |
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. |
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. |
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 visualizações relatadas a um subconjunto das tabelas disponíveis. Por exemplo, Views=ViewA, ViewB, ViewC. |
Propriedade | Descrição |
---|---|
DefaultFilter | Um filtro padrão a ser aplicado a todas as consultas. |
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. |
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. |
UserDefinedViews | Um caminho de arquivo apontando para o arquivo de configuração JSON que contém suas exibições personalizadas. |
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 se conectar ao YouTube Analytics. |
ChannelId | O ID de um canal pertencente ao usuário autenticado. |
ContentOwnerId | A ID do detentor dos direitos autorais do conteúdo no sistema de gerenciamento de direitos do YouTube. |
AuthScheme
O tipo de autenticação a ser usado ao se conectar ao YouTube 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.
ChannelId
O ID de um canal pertencente ao usuário autenticado.
Tipo de dados
string
Valor padrão
""
Observações
O ID de um canal pertencente ao usuário autenticado. Você pode encontrar isso na página de configurações avançadas da conta do seu canal. Se não for especificado, MINE será usado; isso retorna dados para o canal do YouTube do usuário autenticado.
ContentOwnerId
O ID do detentor dos direitos autorais do conteúdo no sistema de gerenciamento de direitos do YouTube.
Tipo de dados
string
Valor padrão
""
Observações
A ID do detentor dos direitos autorais do conteúdo no sistema de gerenciamento de direitos do YouTube. O proprietário do conteúdo é a pessoa ou organização que reivindica vídeos e define sua política de monetização.
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. |
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:
OFF
: Indica que o fluxo OAuth será tratado inteiramente pelo usuário. Um OAuthAccessToken será necessário para autenticação.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.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.
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. Defina InitiateOAuth para GETANDREFRESH para 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
GOOGLEJSONBLOB
, 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
, GOOGLEJSON
Tipo de dados
string
Valor padrão
"USER"
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. |
GOOGLEJSON | O armazenamento de certificados é o nome de um arquivo JSON que contém as informações da conta de serviço. Válido apenas ao conectar-se a um serviço do Google. |
GOOGLEJSONBLOB | O armazenamento de certificados é uma string que contém o JSON da conta de serviço. Válido apenas ao conectar-se a um serviço do Google. |
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.
Isso não é necessário ao usar o GOOGLEJSON OAuthJWTCertType. As chaves JSON do Google não são criptografadas.
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@cdata.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.
Isso não é necessário ao usar o GOOGLEJSON OAuthJWTCertType. As chaves JSON do Google contêm uma cópia da conta do emissor.
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 de e-mail.
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 visualizações relatadas a um subconjunto das tabelas disponíveis. Por exemplo, Views=ViewA, ViewB, ViewC. |
Local
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%\\\YouTubeAnalytics 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%\\YouTubeAnalytics 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 exibiçõ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 |
---|---|
DefaultFilter | Um filtro padrão a ser aplicado a todas as consultas. |
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. |
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. |
UserDefinedViews | Um caminho de arquivo apontando para o arquivo de configuração JSON que contém suas exibições personalizadas. |
DefaultFilter
Um filtro padrão a ser aplicado a todas as consultas.
Tipo de dados
string
Valor padrão
"EndDate=Today"
Observações
Um filtro padrão a ser aplicado a todas as consultas. Conveniente para definir Dimensões, Data Inicial, Data Final e Segmentos padrão para todas as consultas. Esses valores serão substituídos se definidos na consultar. Exemplo de valor: Dimensões=Ano E EndDate=Hoje
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. |
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.
UserDefinedViews
Um caminho de arquivo apontando para o arquivo de configuração JSON que contém suas exibições personalizadas.
Tipo de dados
string
Valor padrão
""
Observações
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 Groups 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"