Package google.maps.mapsplatformdatasets.v1

אינדקס

MapsPlatformDatasets

הגדרת השירות ל-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.
FetchDatasetErrors

rpc FetchDatasetErrors(FetchDatasetErrorsRequest) returns (FetchDatasetErrorsResponse)

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

היקפי ההרשאות

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

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

נדרשת הרשאת ה-IAM הבאה במשאב dataset:

  • mapsplatformdatasets.datasets.get

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

חובה. פרויקט ההורה שיהיה הבעלים של מערך הנתונים. פורמט: 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

אובייקט התגובה של DownloadDataset.

FetchDatasetErrorsRequest

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

שדות
dataset

string

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

int32

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

הערך המקסימלי הוא 500; ערכים מעל 500 יוגבלו ל-500.

אם לא צויין ערך, יוחזרו 50 שגיאות לכל היותר.
page_token

string

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

FetchDatasetErrorsResponse

אובייקט התגובה של FetchDatasetErrors.

שדות
next_page_token

string

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

אם השדה הזה יושמט, אין דפים נוספים.
errors[]

Status

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

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}

אפשר גם לאחזר כמה גרסאות מיוחדות על ידי הוספת התו '@' ותג. פורמט: projects/{project}/datasets/{dataset_id}@{tag}

תג 'active' (פעיל): המידע על הגרסה האחרונה שהושלמה ייכלל, ו-NOT_FOUND אם אין למערך הנתונים גרסה כזו.

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

אובייקט התגובה שלImportDataset.

שדות
name

string

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

ListDatasetsRequest

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

שדות
parent

string

חובה. שם הפרויקט שעבורו רוצים להציג רשימה של כל מערכי הנתונים. פורמט: projects/{project}
page_size

int32

המספר המקסימלי של מערכי נתונים שצריך להחזיר בכל דף.

אם לא צוין (או אפס), כל מערכי הנתונים יוחזרו.
page_token

string

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

string

התג שמציין את הגרסה הרצויה לכל מערך נתונים.

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

תג 'active': כל מערך נתונים בתשובה יכלול את המידע על הגרסה האחרונה שהושלמה, והמערכת תדלג על מערך הנתונים אם אין בו מערך נתונים.

ListDatasetsResponse

אובייקט תשובה של ListDatasets.

שדות
datasets[]

Dataset

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

string

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

אם השדה הזה יושמט, אין דפים נוספים.

LocalFileSource

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

שדות
filename

string

שם הקובץ של הקובץ שהועלה.
file_format

FileFormat

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

סטטוס

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

שדות
state

State

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

string

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

מדינה

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

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