Recurso REST: projects.dataSources

Recurso: DataSource

Representa os metadados da fonte de dados. Os metadados são suficientes para renderizar a interface do usuário e solicitar tokens OAuth adequados.

Representação JSON 

{
  "name": string,
  "dataSourceId": string,
  "displayName": string,
  "description": string,
  "clientId": string,
  "scopes": [
    string
  ],
  "transferType": enum(TransferType),
  "supportsMultipleTransfers": boolean,
  "updateDeadlineSeconds": number,
  "defaultSchedule": string,
  "supportsCustomSchedule": boolean,
  "parameters": [
    {
      object(DataSourceParameter)
    }
  ],
  "helpUrl": string,
  "authorizationType": enum(AuthorizationType),
  "dataRefreshType": enum(DataRefreshType),
  "defaultDataRefreshWindowDays": number,
  "manualRunsDisabled": boolean,
  "minimumScheduleInterval": string,
  "partnerLegalName": string,
  "redirectUrl": string
}
Campos
name

string

Apenas saída. Nome do recurso de fonte de dados.

dataSourceId

string

Código da fonte de dados.
displayName

string

Nome da fonte de dados amigável.
description

string

String de descrição da fonte de dados amigável.
clientId

string

ID do cliente da fonte de dados que precisa ser usado para recebimento do token de atualização.
scopes[]

string

Escopos de autenticação da API que precisam ser usados para recebimento do token de atualização. Esses são os escopos necessários para que uma fonte de dados prepare dados e faça a ingestão deles no BigQuery, por exemplo, https://www.googleapis.com/auth/bigquery

transferType
(deprecated)

enum(TransferType)

Obsoleto. Esse campo não tem efeito.
supportsMultipleTransfers
(deprecated)

boolean

Obsoleto. Esse campo não tem efeito.
updateDeadlineSeconds

number

O número de segundos a aguardar por uma atualização da fonte de dados antes que o serviço de transferência de dados marque a transferência como FAILED.
defaultSchedule

string

Horário padrão de transferência de dados. Exemplos de programações válidas incluem: 1st,3rd monday of month 15:30, every wed,fri of jan,jun 13:15 e first sunday of quarter 00:00.

supportsCustomSchedule

boolean

Especifica se a fonte de dados é compatível com uma programação definida pelo usuário ou se opera na programação padrão. Quando definido como true, o usuário pode substituir a programação padrão.

parameters[]

object(DataSourceParameter)

Parâmetros da fonte de dados.

helpUrl

string

URL para o documento de ajuda para essa fonte de dados.
authorizationType

enum(AuthorizationType)

Indica o tipo de autorização.
dataRefreshType

enum(DataRefreshType)

Especifica se (e como) a fonte de dados é compatível com atualização automática de dados nos últimos dias. Em algumas fontes, os dados só ficam completos alguns dias depois. Por isso, é útil atualizá-los automaticamente.

defaultDataRefreshWindowDays

number

Janela de atualização de dados padrão em dias. Só é significativo quando dataRefreshType = SLIDING_WINDOW.

manualRunsDisabled

boolean

Desativa o preenchimento e a programação de execução manual da fonte de dados.

minimumScheduleInterval

string (Duration format)

O intervalo mínimo para o programador agendar execuções.

Uma duração em segundos com até nove dígitos fracionários, encerrada por "s". Exemplo: "3.5s".
redirectUrl

string

Redireciona o URL para concluir a configuração da transferência de fontes de dados de terceiros.

TransferType

OBSOLETO. Representa o tipo de transferência de dados.

Enums
TRANSFER_TYPE_UNSPECIFIED Marcador para tipo de transferência inválido ou desconhecido.
BATCH Transferência de dados em lote.
STREAMING Transmissão de dados por streaming. Atualmente, a fonte de dados de streaming não é compatível com várias configurações de transferência por projeto.

DataSourceParameter

Representa um parâmetro de fonte de dados com regras de validação para que os parâmetros possam ser renderizados na IU. Esses parâmetros são fornecidos por fontes de dados compatíveis e incluem todas as informações necessárias para renderização e validação. Portanto, quem usa essa API pode decidir gerar formulários específicos de IU genérica ou de fonte de dados personalizada.

Representação JSON 

{
  "paramId": string,
  "displayName": string,
  "description": string,
  "type": enum(Type),
  "required": boolean,
  "repeated": boolean,
  "validationRegex": string,
  "allowedValues": [
    string
  ],
  "minValue": number,
  "maxValue": number,
  "fields": [
    {
      object(DataSourceParameter)
    }
  ],
  "validationDescription": string,
  "validationHelpUrl": string,
  "immutable": boolean,
  "recurse": boolean
}
Campos
paramId

string

Parâmetro identificador.
displayName

string

Nome de exibição do parâmetro na interface do usuário.
description

string

Descrição do parâmetro.
type

enum(Type)

Tipo de parâmetro.
required

boolean

É um parâmetro obrigatório.
repeated

boolean

Obsoleto. Esse campo não tem efeito.

validationRegex

string

Expressão regular que pode ser usada para validação de parâmetros.
allowedValues[]

string

Todos os valores possíveis para o parâmetro.
minValue

number

Para valores inteiros e duplos, especifica o valor mínimo permitido.
maxValue

number

Para valores inteiros e duplos, especifica o valor máximo permitido.
fields[]

object(DataSourceParameter)

Obsoleto. Esse campo não tem efeito.

validationDescription

string

Descrição dos requisitos deste campo, caso a entrada do usuário não atenda ao padrão da expressão regular ou aos valores de mínimo/máximo.
validationHelpUrl

string

URL de um documento de ajuda para explicar melhor os requisitos de nomenclatura.
immutable

boolean

Não pode ser alterado após a criação inicial.
recurse

boolean

Obsoleto. Esse campo não tem efeito.

Tipo

Tipo de parâmetro.

Enums
TYPE_UNSPECIFIED Tipo não especificado.
STRING Parâmetro de string.
INTEGER Parâmetro inteiro (64 bits). Será serializado para json como string.
DOUBLE Parâmetro de ponto flutuante de precisão dupla.
BOOLEAN Parâmetro booleano.
RECORD Obsoleto. Esse campo não tem efeito.
PLUS_PAGE Código da página de uma Página do Google+.

AuthorizationType

O tipo de autorização necessária para essa fonte de dados.

Enums
AUTHORIZATION_TYPE_UNSPECIFIED Tipo não especificado.
AUTHORIZATION_CODE Usa os códigos de autorização do OAuth 2 que podem ser trocados por um token de atualização no back-end.
GOOGLE_PLUS_AUTHORIZATION_CODE Retorna um código de autorização para uma determinada página do Google+ que pode ser trocado por um token de atualização no back-end.

DataRefreshType

Representa como a fonte de dados oferece suporte à atualização automática de dados.

Enums
DATA_REFRESH_TYPE_UNSPECIFIED A fonte de dados não é compatível com a atualização automática de dados, que é o valor padrão.
SLIDING_WINDOW A fonte de dados é compatível com a atualização automática de dados, e as execuções serão programadas para os últimos dias. Não permite que valores personalizados sejam configurados para cada configuração de transferência.
CUSTOM_SLIDING_WINDOW A fonte de dados é compatível com a atualização automática de dados, e as execuções serão programadas para os últimos dias. Permite que valores personalizados sejam definidos para cada configuração de transferência.

Métodos

checkValidCreds

 Retorna verdadeiro se existirem credenciais válidas para a fonte de dados e o usuário solicitante.

get

 Recupera uma fonte de dados compatível e retorna suas configurações, que podem ser usadas para renderização da interface do usuário.

list

 Lista as fontes de dados compatíveis e retorna as respectivas configurações, que podem ser usadas para renderização da IU.