Ressource REST : projects.dataSources

Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.

Ressource : DataSource

Représente les métadonnées relatives à la source de données. Les métadonnées sont suffisantes pour afficher l'interface utilisateur et demander des jetons OAuth appropriés.

Représentation JSON

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

string

Uniquement en sortie. Nom de ressource de la source de données

dataSourceId

string

ID de la source de données.

displayName

string

Nom convivial de la source de données.

description

string

Chaîne de description conviviale de la source de données.

clientId

string

ID client de la source de données à utiliser pour recevoir le jeton d'actualisation.

scopes[]

string

Champs d'application Auth de l'API pour lesquels le jeton d'actualisation doit être obtenu. Il s'agit des champs d'application requis par une source de données pour préparer des données et les intégrer dans BigQuery, par exemple : https://www.googleapis.com/auth/bigquery.

transferType
(deprecated)

enum (TransferType)

Obsolète. Ce champ n'a aucun effet.

supportsMultipleTransfers
(deprecated)

boolean

Obsolète. Ce champ n'a aucun effet.

updateDeadlineSeconds

integer

Nombre de secondes d'attente d'une mise à jour de la source de données avant que le service de transfert de données n'indique l'état ÉCHEC.

defaultSchedule

string

Planification du transfert de données par défaut. Exemples de planifications valides : 1st,3rd monday of month 15:30, every wed,fri of jan,jun 13:15 et first sunday of quarter 00:00.

supportsCustomSchedule

boolean

Indique si la source de données est compatible avec une planification définie par l'utilisateur ou fonctionne selon la programmation par défaut. Si ce paramètre est défini sur true, l'utilisateur peut remplacer la programmation par défaut.

parameters[]

object (DataSourceParameter)

Paramètres de source de données

helpUrl

string

URL du document d'aide de cette source de données.

authorizationType

enum (AuthorizationType)

Indique le type d'autorisation.

dataRefreshType

enum (DataRefreshType)

Indique si la source de données est compatible avec l'actualisation automatique des données au cours des derniers jours et la manière dont elle est compatible. Pour certaines sources, les données peuvent n'être complètes que quelques jours plus tard. Il est donc utile d'actualiser automatiquement les données.

defaultDataRefreshWindowDays

integer

Fenêtre d'actualisation des données par défaut en fonction des jours. Utile seulement lorsque dataRefreshType est égal à SLIDING_WINDOW.

manualRunsDisabled

boolean

Désactive le remplissage et la planification manuelle des exécutions pour la source de données.

minimumScheduleInterval

string (Duration format)

Intervalle minimal requis pour la planification des exécutions par le planificateur

Durée en secondes avec neuf chiffres au maximum après la virgule. Se termine par "s". Example : "3.5s".

TransferType

OBSOLÈTE. Représente le type de transfert de données.

Enums
TRANSFER_TYPE_UNSPECIFIED Espace réservé du type de transfert non valide ou inconnu
BATCH Transfert de données par lot
STREAMING Transfert de données en flux continu. La source de données en streaming n'est actuellement pas compatible avec plusieurs configurations de transfert par projet.

DataSourceParameter

Représente un paramètre de source de données avec des règles de validation afin que les paramètres puissent être affichés dans l'interface utilisateur. Ces paramètres nous sont fournis par les sources de données compatibles, et comprennent toutes les informations requises pour l'affichage et la validation. Ainsi, toute personne qui utilise cette API peut décider de générer des interfaces utilisateur génériques ou des formulaires spécifiques aux sources de données personnalisées.

Représentation 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,
  "deprecated": boolean
}
Champs
paramId

string

Identifiant du paramètre.

displayName

string

Nom à afficher du paramètre dans l'interface utilisateur.

description

string

Description du paramètre.

type

enum (Type)

Type de paramètre.

required

boolean

Paramètre requis.

repeated

boolean

Obsolète. Ce champ n'a aucun effet.

validationRegex

string

Expression régulière pouvant être utilisée pour la validation des paramètres.

allowedValues[]

string

Toutes les valeurs possibles du paramètre.

minValue

number

Pour les valeurs entières et doubles, spécifiez une valeur minimale autorisée.

maxValue

number

Pour les valeurs entières et doubles, indiquez une valeur maximale autorisée.

fields[]

object (DataSourceParameter)

Obsolète. Ce champ n'a aucun effet.

validationDescription

string

Description des conditions requises pour ce champ, au cas où l'entrée utilisateur ne respecte pas le modèle d'expression régulière ou les valeurs minimales/maximales.

validationHelpUrl

string

URL d'un document d'aide qui explique plus en détail les règles de dénomination.

immutable

boolean

Non modifiable après sa création initiale.

recurse

boolean

Obsolète. Ce champ n'a aucun effet.

deprecated

boolean

Si la valeur est définie sur "true", elle ne doit pas être utilisée dans de nouveaux transferts et n'est pas visible par les utilisateurs.

Type

Type de paramètre

Enums
TYPE_UNSPECIFIED Type non spécifié
STRING Paramètre de chaîne
INTEGER Paramètre entier (64 bits). Ce paramètre sera sérialisée vers JSON en tant que chaîne.
DOUBLE Paramètre à virgule flottante avec deux décimales
BOOLEAN Paramètre booléen
RECORD Obsolète. Ce champ n'a aucun effet.
PLUS_PAGE ID d'une page Google+

AuthorizationType

Type d'autorisation nécessaire pour cette source de données

Enums
AUTHORIZATION_TYPE_UNSPECIFIED Type non spécifié
AUTHORIZATION_CODE Utilisez des codes d'autorisation OAuth 2 pouvant être échangés contre un jeton d'actualisation sur le backend.
GOOGLE_PLUS_AUTHORIZATION_CODE Renvoie un code d'autorisation pour une page Google+ donnée, qui peut ensuite être échangé contre un jeton d'actualisation sur le backend.
FIRST_PARTY_OAUTH Utilisez l'accès OAuth propriétaire en fonction des clients détenus par Loas. L'accès OAuth propriétaire ne nécessite pas de jeton d'actualisation pour obtenir un jeton d'accès hors connexion. Il utilise plutôt une assertion JWT signée par le client pour récupérer un jeton d'accès.

DataRefreshType

Représente la façon dont la source de données est compatible avec l'actualisation automatique des données.

Enums
DATA_REFRESH_TYPE_UNSPECIFIED La source de données n'est pas compatible avec l'actualisation automatique des données, qui est une valeur par défaut.
SLIDING_WINDOW La source de données est compatible avec l'actualisation automatique des données et son exécution est planifiée pour les derniers jours. Ne permet pas de définir des valeurs personnalisées pour chaque configuration de transfert.
CUSTOM_SLIDING_WINDOW La source de données est compatible avec l'actualisation automatique des données et son exécution est planifiée pour les derniers jours. Permet de définir des valeurs personnalisées pour chaque configuration de transfert.

Méthodes

checkValidCreds

Renvoie la valeur "true" si des identifiants valides existent pour la source de données présentée et l'utilisateur demandeur.

get

Récupère une source de données compatible et renvoie ses paramètres, qui peuvent être utilisés pour l'affichage dans l'interface utilisateur.

list

Répertorie les sources de données compatibles et renvoie leurs paramètres, qui peuvent être utilisés pour l'affichage dans l'interface utilisateur.