Package google.maps.mapsplatformdatasets.v1alpha

אינדקס

MapsPlatformDatasetsV1Alpha

הגדרת השירות של Maps Platform Datasets API.

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.
ListDatasetErrors

rpc ListDatasetErrors(ListDatasetErrorsRequest) returns (ListDatasetErrorsResponse)

קבלת כל השגיאות של מערך נתונים (נכון לעכשיו, האפשרות הזו פועלת רק לתרחיש השימוש ב-DDS).

היקפי הרשאות

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

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

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

  • mapsplatformdatasets.datasets.get

מידע נוסף זמין במאמרי העזרה בנושא 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

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

Dataset

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

מערך נתונים

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

שדות
name

string

שם המשאב, projects/{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

חובה. פורמט: projects/${project}/datasets/{dataset_id}

DownloadDatasetRequest

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

שדות
name

string

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

DownloadDatasetResponse

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

FileFormat

הפורמט של הקובץ שמעלים.

טיפוסים בני מנייה (enum)
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

חובה. שם המשאב. projects/{project}/datasets/{dataset_id}

ImportDatasetRequest

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

שדות
name

string

חובה. שם המשאב, projects/{project}/datasets/{dataset_id}
version_description

string

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

LocalFileSource

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

GcsSource

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

ImportDatasetResponse

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

שדות
name

string

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

ListDatasetErrorsRequest

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

שדות
name

string

חובה. פורמט: projects/${project}/datasets/{dataset_id}
page_size

int32

המספר המקסימלי של גרסאות שיוחזרו לכל דף. ברירת המחדל היא 10.
page_token

string

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

ListDatasetErrorsResponse

תגובה של ListDatasetErrors. מחזירה מחרוזת שחוזרת על עצמה להודעות שגיאה.

שדות
error_messages[]

string

השגיאות שקשורות למערך נתונים.
next_page_token

string

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

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

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

מדינה

רשימה של סטטוסים של גרסת מערך הנתונים. אם משנים כאן ערכים, כדאי לעדכן את שיטות השירות Status.

טיפוסים בני מנייה (enum)
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

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

FieldMask

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

שימוש

השימוש מציין איפה הנתונים אמורים לשמש, כדי להנחות את אופן העיבוד שלהם.

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