REST Resource: projects.datasets

リソース: Dataset

マップ プラットフォームのデータセットを表しています。

JSON 表現 
{
  "name": string,
  "displayName": string,
  "description": string,
  "versionId": string,
  "usage": [
    enum (Usage)
  ],
  "status": {
    object (Status)
  },
  "createTime": string,
  "updateTime": string,
  "versionCreateTime": string,
  "versionDescription": string,

  // Union field data_source can be only one of the following:
  "localFileSource": {
    object (LocalFileSource)
  },
  "gcsSource": {
    object (GcsSource)
  }
  // End of list of possible types for union field data_source.
}
フィールド
name

string

リソース名: projects/{project}/datasets/{dataset_id}
displayName

string

コンソール UI に表示される、人が読める形式の名前。
description

string

このデータセットの説明
versionId

string

データセットのバージョン ID。
usage[]

enum (Usage)

このデータセットに指定されているユースケース。
status

object (Status)

出力のみ。このデータセット バージョンのステータス。
createTime

string (Timestamp format)

出力のみ。データセットが最初に作成された時刻。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
updateTime

string (Timestamp format)

出力のみ。データセットのメタデータが最後に更新された時刻。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
versionCreateTime

string (Timestamp format)

出力のみ。このバージョンのデータセットが作成された時刻。（これは、データセットにデータをインポートする際に発生）

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
versionDescription

string

出力のみ。このバージョンのデータセットの説明。これは、データセットにデータをインポートする際に提供されます。
共用体フィールド data_source。データセットのデータのソースに関する詳細。data_source は次のいずれかになります。
localFileSource

object (LocalFileSource)

1 回のアップロードで使用するデータセットのローカル ファイル ソース。
gcsSource

object (GcsSource)

1 回のアップロードで使用するデータセットの Google Cloud Storage ファイルソース。

使用状況

用途では、データの処理方法を伝えるためにデータを使用する場所を指定します。

列挙型
USAGE_UNSPECIFIED このデータセットの使用方法は設定されていません。
USAGE_DATA_DRIVEN_STYLING このデータセットはデータドリブンのスタイル設定に使用されます。

LocalFileSource

ローカル ファイルのデータソースに関する詳細。

JSON 表現 
{
  "filename": string,
  "fileFormat": enum (FileFormat)
}
フィールド
filename

string

アップロードしたファイルの名前と拡張子。
fileFormat

enum (FileFormat)

アップロードするファイルの形式。

FileFormat

アップロードするファイルの形式。

列挙型
FILE_FORMAT_UNSPECIFIED ファイル形式が指定されていません。
FILE_FORMAT_GEOJSON GeoJson ファイル。
FILE_FORMAT_KML KML ファイル。
FILE_FORMAT_CSV 。

GcsSource

Google Cloud Storage にあるデータソースの詳細。

JSON 表現 
{
  "inputUri": string,
  "fileFormat": enum (FileFormat)
}
フィールド
inputUri

string

ソースデータの URI。たとえば、gs://my_bucket/my_object のようにします。
fileFormat

enum (FileFormat)

Google Cloud Storage オブジェクトのファイル形式。これは主に検証に使用されます。

ステータス

データセットのステータス。

JSON 表現 
{
  "state": enum (State),
  "errorMessage": string
}
フィールド
state

enum (State)

ステータスの列挙型。
errorMessage

string

失敗の理由を示すエラー メッセージ。データセットが失敗状態でない場合は空です。

状態

データセットの状態のリスト。

列挙型
STATE_UNSPECIFIED このデータセットの状態は設定されていません。
STATE_IMPORTING データをデータセットにインポートしています。
STATE_IMPORT_SUCCEEDED データセットへのデータのインポートが完了しました。
STATE_IMPORT_FAILED データセットにデータをインポートできませんでした。
STATE_DELETING データセットを削除中です。
STATE_DELETION_FAILED 削除の失敗状態。この状態は、データセットの削除が失敗したことを示します。削除を再試行する場合があります。
STATE_PROCESSING データを処理しています。
STATE_PROCESSING_FAILED 処理の失敗状態。この状態は、処理が失敗したことを表します。エラーが報告される場合があります。
STATE_NEEDS_REVIEW この状態は現在使用されていません。
STATE_PUBLISHING 公開状態。この状態は公開中であることを示します。
STATE_PUBLISHING_FAILED 公開エラーの状態。この状態は、公開が失敗したことを示します。公開は再試行される可能性があります。
STATE_COMPLETED 完了状態。この状態は、特定の用途に利用できるデータセットを表します。

Methods

create

 指定したプロジェクトの新しいデータセットを作成します。

delete

 指定したデータセットを削除します。

get

 データセットを取得します。

list

 指定したプロジェクトのすべてのデータセットを一覧表示します。

patch

 データセットのメタデータを更新します。