REST 리소스: projects.dataSources

리소스: DataSource

데이터 소스 메타데이터를 나타냅니다. 메타데이터로 충분히 UI를 렌더링하고 적절한 OAuth 토큰을 요청할 수 있습니다.

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
}
필드
name

string

출력 전용입니다. 데이터 소스 리소스 이름입니다.

dataSourceId

string

데이터 소스 ID입니다.
displayName

string

사용자 친화적인 데이터 소스 이름입니다.
description

string

사용자 친화적인 데이터 소스 설명 문자열입니다.
clientId

string

갱신 토큰을 받는 데 사용되는 데이터 소스 클라이언트 ID입니다.
scopes[]

string

갱신 토큰을 받아야 하는 API 인증 범위입니다. 이 범위는 데이터 소스에서 데이터를 준비하여 BigQuery에 수집하는 데 필요한 범위입니다(예: https://www.googleapis.com/auth/bigquery).

transferType
(deprecated)

enum(TransferType)

지원 중단되었습니다. 이 필드는 아무 영향도 미치지 않습니다.
supportsMultipleTransfers
(deprecated)

boolean

지원 중단되었습니다. 이 필드는 아무 영향도 미치지 않습니다.
updateDeadlineSeconds

number

데이터 전송 서비스가 전송을 실패하기 전에 데이터 소스에서 업데이트를 기다리는 시간(초)입니다.
defaultSchedule

string

기본 데이터 전송 일정입니다. 유효한 일정의 예시로는 1st,3rd monday of month 15:30, every wed,fri of jan,jun 13:15, first sunday of quarter 00:00이 있습니다.

supportsCustomSchedule

boolean

데이터 소스가 사용자 정의 일정을 지원하는지 아니면 기본 일정에 따라 작동하는지를 지정합니다. true로 설정하면 사용자가 기본 일정을 재정의할 수 있습니다.

parameters[]

object(DataSourceParameter)

데이터 소스 매개변수입니다.
helpUrl

string

이 데이터 소스와 관련한 도움말 문서의 URL입니다.
authorizationType

enum(AuthorizationType)

승인 유형을 나타냅니다.
dataRefreshType

enum(DataRefreshType)

데이터 소스가 지난 며칠에 대하여 자동 데이터 새로고침을 지원하는지 여부와 새로고침을 지원하는 방법을 지정합니다. 일부 데이터 소스의 경우, 며칠이 지나야만 데이터가 완전해지므로 데이터 자동 새로고침을 사용하는 것이 유용합니다.

defaultDataRefreshWindowDays

number

기본 데이터 새로고침 기간(일)입니다. dataRefreshType = SLIDING_WINDOW인 경우에만 의미가 있습니다.

manualRunsDisabled

boolean

데이터 소스의 백필 및 수동 실행 예약을 사용 중지합니다.
minimumScheduleInterval

string (Duration format)

스케줄러가 실행을 예약할 최소 간격입니다.

초 단위 기간으로, 소수점 아래 9자리까지 지정 가능하며 's'로 끝납니다(예: "3.5s").
redirectUrl

string

타사 데이터 소스의 전체 전송 구성 설정에 대한 리디렉션 URL입니다.

TransferType

지원 중단됨. 데이터 전송 유형을 나타냅니다.

열거형
TRANSFER_TYPE_UNSPECIFIED 잘못되었거나 알 수 없는 전송 유형 자리표시자입니다.
BATCH 일괄 데이터 전송입니다.
STREAMING 스트리밍 데이터 전송입니다. 데이터 소스 스트리밍 시 현재는 프로젝트당 여러 개의 전송 구성이 지원되지 않습니다.

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

매개 변수 식별자입니다.
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

지원 중단됨. 이 필드는 아무 영향도 미치지 않습니다.

유형

매개변수 유형입니다.

열거형
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

데이터 소스가 데이터 자동 새로고침을 지원하는 방식을 나타냅니다.

열거형
DATA_REFRESH_TYPE_UNSPECIFIED 데이터 소스가 데이터 자동 새로고침을 지원하지 않습니다(기본값).
SLIDING_WINDOW 데이터 소스가 데이터 자동 새로고침을 지원하며 지난 며칠간에 대해 실행이 예약됩니다. 각 전송 구성에 맞춤 값을 설정할 수 없습니다.
CUSTOM_SLIDING_WINDOW 데이터 소스가 데이터 자동 새로고침을 지원하며 지난 며칠간에 대해 실행이 예약됩니다. 각 전송 구성에 맞춤 값을 설정할 수 있습니다.

메소드

checkValidCreds

 지정된 데이터 소스와 요청 사용자에 대한 유효한 사용자 인증 정보가 있는 경우, true를 반환합니다.

get

 지원되는 데이터 소스를 가져오고 UI 렌더링에 사용할 수 있는 설정을 반환합니다.

list

 지원되는 데이터 소스를 나열하고 UI 렌더링에 사용할 수 있는 설정을 반환합니다.