Package google.maps.mapsplatformdatasets.v1alpha

אינדקס

MapsPlatformDatasetsV1Alpha

הגדרת שירות ל-API של מערכי הנתונים של הפלטפורמה של מפות Google.

CreateDataset

rpc CreateDataset(CreateDatasetRequest) returns (Dataset)

יוצרים מערך נתונים חדש לפרויקט שצוין.

היקפי הרשאות

נדרש היקף OAuth הבא:

  • https://www.googleapis.com/auth/cloud-platform
הרשאות IAM

נדרשת הרשאת IAM הבאה במשאב parent:

  • mapsplatformdatasets.datasets.create

מידע נוסף זמין במשאבי העזרה של IAM.
DeleteDataset

rpc DeleteDataset(DeleteDatasetRequest) returns (Empty)

מחיקת מערך הנתונים שצוין .

היקפי הרשאות

נדרש היקף OAuth הבא:

  • https://www.googleapis.com/auth/cloud-platform
הרשאות IAM

נדרשת הרשאת IAM הבאה במשאב name:

  • mapsplatformdatasets.datasets.delete

מידע נוסף זמין במשאבי העזרה של IAM.
DownloadDataset

rpc DownloadDataset(DownloadDatasetRequest) returns (DownloadDatasetResponse)

מוריד מערך נתונים.

היקפי הרשאות

נדרש היקף OAuth הבא:

  • https://www.googleapis.com/auth/cloud-platform
הרשאות IAM

נדרשת הרשאת IAM הבאה במשאב name:

  • mapsplatformdatasets.datasets.export

מידע נוסף זמין במשאבי העזרה של IAM.
GetDataset

rpc GetDataset(GetDatasetRequest) returns (Dataset)

מורידים את מערך הנתונים.

היקפי הרשאות

נדרש היקף OAuth הבא:

  • https://www.googleapis.com/auth/cloud-platform
הרשאות IAM

נדרשת הרשאת IAM הבאה במשאב name:

  • mapsplatformdatasets.datasets.get

מידע נוסף זמין במשאבי העזרה של IAM.
ImportDataset

rpc ImportDataset(ImportDatasetRequest) returns (ImportDatasetResponse)

מייבאת גרסה חדשה של הנתונים של מערך הנתונים.

היקפי הרשאות

נדרש היקף OAuth הבא:

  • https://www.googleapis.com/auth/cloud-platform
הרשאות IAM

נדרשת הרשאת IAM הבאה במשאב name:

  • mapsplatformdatasets.datasets.import

מידע נוסף זמין במשאבי העזרה של IAM.
ListDatasets

rpc ListDatasets(ListDatasetsRequest) returns (ListDatasetsResponse)

הצגת רשימה של כל מערכי הנתונים של הפרויקט שצוין.

היקפי הרשאות

נדרש היקף OAuth הבא:

  • https://www.googleapis.com/auth/cloud-platform
הרשאות IAM

נדרשת הרשאת IAM הבאה במשאב parent:

  • mapsplatformdatasets.datasets.list

מידע נוסף זמין במשאבי העזרה של IAM.
UpdateDatasetMetadata

rpc UpdateDatasetMetadata(UpdateDatasetMetadataRequest) returns (Dataset)

מעדכנים את המטא-נתונים של מערך הנתונים.

היקפי הרשאות

נדרש היקף OAuth הבא:

  • https://www.googleapis.com/auth/cloud-platform
הרשאות IAM

נדרשת הרשאת IAM הבאה במשאב name:

  • mapsplatformdatasets.datasets.update

מידע נוסף זמין במשאבי העזרה של IAM.

CreateDatasetRequest

מבקשים ליצור מערך נתונים של מפות.

שדות
parent

string

חובה. פרויקט הורה שיהיה הבעלים של מערך הנתונים. פורמט: פרויקטים/{$project}
dataset

Dataset

חובה. גרסת מערך הנתונים שצריך ליצור.

מערך נתונים

ייצוג של מערך נתונים מפלטפורמת מפות.

שדות
name

string

שם המשאב, פרויקטים/{project}/datasets/{dataset_id}
display_name

string

שם קריא לבני אדם, מוצג בממשק המשתמש של המסוף .
description

string

תיאור של מערך הנתונים הזה .
version_id

string

מזהה הגרסה של מערך הנתונים.
usage[]

Usage

תרחישים לדוגמה למערך הנתונים הזה.
status

Status

פלט בלבד. הסטטוס של גרסת מערך הנתונים הזו.
create_time

Timestamp

פלט בלבד. השעה שבה מערך הנתונים נוצר לראשונה.
update_time

Timestamp

פלט בלבד. השעה שבה עודכנו לאחרונה המטא-נתונים של מערך הנתונים.
version_create_time

Timestamp

פלט בלבד. השעה שבה נוצרה הגרסה הזו של מערך הנתונים. (זה קרה כשמייבאים נתונים למערך הנתונים)
version_description

string

פלט בלבד. התיאור של גרסה זו של מערך הנתונים. הוא מסופק כשמייבאים נתונים למערך הנתונים.
שדה איחוד data_source. פרטים על מקור הנתונים של מערך הנתונים. הערך של data_source יכול להיות רק אחת מהאפשרויות הבאות:
local_file_source

LocalFileSource

מקור קובץ מקומי של מערך הנתונים להעלאה יחידה.
gcs_source

GcsSource

מקור של קובץ ב-Google Cloud Storage של מערך הנתונים להעלאה יחידה.

DeleteDatasetRequest

מבקשים למחוק מערך נתונים.

מערך הנתונים למחיקה.

שדות
name

string

חובה. Format: projects/${project}/datasets/{dataset_id}

DownloadDatasetRequest

מבקשים להוריד את מערך הנתונים.

שדות
name

string

מערך הנתונים שיש לאחזר. Format: projects/${project}/datasets/${dataset_id}

DownloadDatasetResponse

תגובה מהורדת מערך הנתונים.

FileFormat

הפורמט של הקובץ שמועלה כרגע.

טיפוסים בני מנייה (enums)
FILE_FORMAT_UNSPECIFIED פורמט הקובץ לא צוין.
FILE_FORMAT_GEOJSON קובץ GeoJson.
FILE_FORMAT_KML קובץ KML.
FILE_FORMAT_CSV קובץ ה-CSV.

GcsSource

הפרטים לגבי מקור הנתונים כשהוא ב-Google Cloud Storage.

שדות
input_uri

string

URI של נתוני מקור. לדוגמה, gs://my_bucket/my_object.
file_format

FileFormat

פורמט הקובץ של האובייקט Google Cloud Storage. משמש בעיקר לאימות.

GetDatasetRequest

בקשה לקבלת מערך הנתונים שצוין.

שדות
name

string

חובה. שם המשאב. פרויקטים/{project}/datasets/{dataset_id}

ImportDatasetRequest

בקשה לייבוא גרסה חדשה של מערך הנתונים.

שדות
name

string

חובה. שם המשאב, פרויקטים/{project}/datasets/{dataset_id}
version_description

string

תיאור של הנתונים החדשים המיובאים.
שדה איחוד data_source. פרטים על מקור הנתונים של מערך הנתונים. הערך של data_source יכול להיות רק אחת מהאפשרויות הבאות:
local_file_source

LocalFileSource

מקור קובץ מקומי של מערך הנתונים לייבוא חד-פעמי.
gcs_source

GcsSource

מקור קובץ של מערך הנתונים ב-Google Cloud Storage, לייבוא חד-פעמי.

ImportDatasetResponse

תגובה מייבוא גרסה חדשה של מערך הנתונים.

שדות
name

string

חובה. שם המשאב של הגרסה החדשה של מערך הנתונים, פרויקטים/{project}/datasets/{dataset_id}@{version_id}

ListDatasetsRequest

מבקשים ליצור רשימה של מערכי נתונים בפרויקט.

שדות
parent

string

חובה. שם הפרויקט שעבורו רוצים לרשום את כל מערכי הנתונים.
page_size

int32

המספר המקסימלי של גרסאות שיש להחזיר בכל דף. אם לא צוין (או אפס), כל מערכי הנתונים יוחזרו.
page_token

string

אסימון הדף שהתקבל מקריאה קודמת של ListDatasets. צריך לספק אותו כדי לאחזר את הדף הבא.

ListDatasetsResponse

תשובה לבקשת רשימה של מערכי נתונים בפרויקט.

שדות
datasets[]

Dataset

כל מערכי הנתונים של הפרויקט.
next_page_token

string

אסימון שניתן לשלוח בתור page_token לאחזור הדף הבא. אם השדה הזה יושמט, לא יופיעו דפים נוספים.

LocalFileSource

הפרטים על מקור הנתונים כאשר הוא קובץ מקומי.

שדות
filename

string

שם הקובץ והסיומת של הקובץ שהועלה.
file_format

FileFormat

הפורמט של הקובץ שמועלה כרגע.

סטטוס

הסטטוס של גרסת מערך הנתונים.

שדות
state

State

סטטוס: 'טיפוסים בני מנייה (enum)'.
error_message

string

הודעת שגיאה שמציינת את סיבת הכשל. השדה ריק אם מערכי הנתונים לא במצב נכשל.

ארץ

רשימת מצבים למערך הנתונים.

טיפוסים בני מנייה (enums)
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 המצב שהושלם. המצב הזה מייצג את מערך הנתונים שזמין לשימוש הספציפי שלו.

UpdateDatasetMetadataRequest

מבקשים לעדכן את שדות המטא-נתונים של מערך הנתונים.

שדות
dataset

Dataset

חובה. מערך הנתונים שיש לעדכן. השם של מערך הנתונים משמש לזיהוי מערך הנתונים שיש לעדכן. השם הוא בפורמט הבא: פרויקטים/{project}/datasets/{dataset_id}
update_mask

FieldMask

רשימת השדות לעדכון. יש לתמוך בערך "*" להחלפה מלאה.

Usage

ההגדרה 'שימוש' קובעת איפה הנתונים ישמשו לצורך עיבוד הנתונים.

טיפוסים בני מנייה (enums)
USAGE_UNSPECIFIED השימוש במערך הנתונים הזה לא הוגדר.
USAGE_DATA_DRIVEN_STYLING מערך הנתונים הזה ישמש לעיצוב מבוסס-נתונים.