コレクション: projects.dataSources

リソース: DataSource

データソースのメタデータを表します。メタデータだけで UI をレンダリングし、適切な OAuth トークンをリクエストできます。

JSON 表現

{
  "name": string,
  "dataSourceId": string,
  "displayName": string,
  "description": string,
  "clientId": string,
  "scopes": [
    string
  ],
  "transferType": enum(TransferType),
  "supportsMultipleTransfers": boolean,
  "statusUpdateDeadlineSeconds": number,
  "defaultSchedule": string,
  "supportsCustomSchedule": boolean,
  "parameters": [
    {
      object(DataSourceParameter)
    }
  ],
  "helpUrl": string,
  "authorizationType": enum(AuthorizationType),
  "dataRefreshType": enum(DataRefreshType),
  "defaultDataRefreshWindowDays": number,
  "manualRunsDisabled": boolean,
}
フィールド
name

string

データソースのリソース名。

dataSourceId

string

データソースの ID。

displayName

string

わかりやすいデータソース名。

description

string

わかりやすいデータソースの説明。

clientId

string

更新トークンの取得に使用するデータソースのクライアント ID。指定しないと、データ転送でオンラインの認証情報が送信されません。

scopes[]

string

更新トークンを取得する API auth スコープ。clientId を指定した場合にのみ有効です。それ以外の場合は無視されます。これらのスコープは、データソースがデータを準備し、BigQuery に取り込む場合に必要になります(たとえば、https://www.googleapis.com/auth/bigquery)。

transferType

enum(TransferType)

転送タイプ。現在サポートされているのはバッチ転送だけです。この転送では、データの取り込みに BigQuery バッチ API(load または query)を使用します。

supportsMultipleTransfers

boolean

データソースが異なる BigQuery ターゲットに複数の転送を実行できるかどうかを表します。

statusUpdateDeadlineSeconds

number

データソースからのステータス更新を待機する時間(秒数)。この時間が経過すると、BigQuery は転送を失敗と見なします。

defaultSchedule

string

デフォルトのデータ転送スケジュール。有効なスケジュールの例: 1st,3rd monday of month 15:30every wed,fri of jan,jun 13:15first sunday of quarter 00:00

supportsCustomSchedule

boolean

データソースがユーザー定義のスケジュールをサポートするのか、デフォルトのスケジュールを使用するのかを指定します。true に設定すると、ユーザーがデフォルトのスケジュールを上書きできます。

parameters[]

object(DataSourceParameter)

データソースのパラメータ。

helpUrl

string

このデータソースのヘルプ ドキュメントの URI。

authorizationType

enum(AuthorizationType)

認証タイプを表します。

dataRefreshType

enum(DataRefreshType)

データソースが過去数日分のデータの自動更新をサポートするかどうかを指定します。サポートする場合には、その方法も設定します。データソースによっては、データが完了するまでに数日かかる場合があります。この場合、データの自動更新は便利な機能です。

defaultDataRefreshWindowDays

number

デフォルトのデータ更新ウィンドウ(日数)。dataRefreshType = SLIDING_WINDOW の場合にのみ有効です。

manualRunsDisabled

boolean

データソースのバックフィルと手動実行スケジュールを無効にします。

TransferType

データ転送タイプを表します。

列挙値
TRANSFER_TYPE_UNSPECIFIED 転送タイプが無効または不明な場合のプレースホルダ。
BATCH バッチデータ転送。
STREAMING ストリーミング データ転送。現在、データソースのストリーミングでは、1 つのプロジェクトに複数の転送設定を作成できます。

DataSourceParameter

パラメータを UI でレンダリングできるように検証ルールを含むデータソース パラメータを表します。これらのパラメータは対応のデータソースによって提供され、レンダリングと検証に必要なすべての情報が含まれています。この API の使用者が汎用的な UI を生成するのか、カスタム データソース固有の形式を生成するのかを決めることができます。

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,
}
フィールド
paramId

string

パラメータ ID。

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

命名規則を説明するヘルプ ドキュメントの URL。

immutable

boolean

最初の作成後に変更できないことを表します。

recurse

boolean

true に設定すると、parameter_id が同じ親からスキーマが取得されます。パラメータ型が RECORD の場合にのみ有効です。

Type

パラメータの型。

列挙値
TYPE_UNSPECIFIED 未指定
STRING 文字列型パラメータ
INTEGER 整数型パラメータ(64 ビット)。JSON には文字列としてシリアライズされます。
DOUBLE 倍制度浮動小数点型パラメータ
BOOLEAN ブール型パラメータ
RECORD レコード パラメータ
PLUS_PAGE Google+ ページのページ ID

AuthorizationType

このデータソースに必要な認証タイプ。

列挙値
AUTHORIZATION_TYPE_UNSPECIFIED 未指定
AUTHORIZATION_CODE バックエンドの更新トークンと交換可能な OAuth 2 認証コードを使用します。
GOOGLE_PLUS_AUTHORIZATION_CODE 特定の Google+ ページの認証コードを返します。このコードは、バックエンドの更新トークンと交換できます。

DataRefreshType

データソースがデータの自動更新をサポートする方法を表します。

列挙値
NONE データソースはデータの自動更新をサポートしません。これはデフォルトの値です。
SLIDING_WINDOW データソースはデータの自動更新をサポートし、過去数日分の更新スケジュールを設定できます。転送設定にカスタム値を設定することはできません。
CUSTOM_SLIDING_WINDOW データソースはデータの自動更新をサポートし、過去数日分の更新スケジュールを設定できます。転送設定にカスタム値を設定できます。

メソッド

checkValidCredentials

指定されたデータと登録ユーザーに有効な認証情報が存在すると、true を返します。

get

サポートされるデータソースを取得し、設定を返します。この設定は UI のレンダリングに使用できます。

list

サポートされるデータソースのリストを作成し、設定を返します。この設定は UI のレンダリングに使用できます。

needsNewCredentials

指定されたデータと登録ユーザーに新しい認証情報が必要な場合に true を返します。
このページは役立ちましたか?評価をお願いいたします。

フィードバックを送信...