Google API設計指南－標準字段

翻譯自 API Design Guide - Standard Fields

本節介紹了在須要相似概念時應使用的一組標準消息字段定義，這將確保相同的概念在不一樣的 API 中具備相同的名稱和語義。

| 名稱 | 類型 | 描述 |
| - | - | - |
| name | string | name 字段應該包含相對資源名稱 |
| parent | string | 對於資源定義和 List/Create 請求，parent 字段應該包含父資源的相對資源名稱 |
| create_time | Timestamp | 資源建立的時間戳 |
| update_time | Timestamp | 資源最後更新的時間戳（當執行 create/patch/delete 操做時更新） |
| delete_time | Timestamp | 資源刪除的時間戳，只有支持恢復時有效 |
| time_zone | string | 時區名，必須是一個像 "America/Los_Angeles" 的 IANA TZ 名字。更多信息請參考 https://en.wikipedia.org/wiki... |
| region_code | string | 國家地區編碼（CLDR），更多信息請參考 http://www.unicode.org/report... |
| language_code | string | BCP-47 語言編碼例如「en-US」或「sr-Latn」，更多信息請參考 http://www.unicode.org/report... |
| display_name | string | 資源的顯示名稱 |
| title | string | 資源的官方名稱，例如公司名稱。它應該被看作是 display_name 的正式名稱 |
| description | string | 資源的描述信息 |
| filter | string | List 方法的標準過濾字段 |
| query | string | 在 search 方法中使用，功能與 filter 相同 |
| page_token | string | List 請求中的分頁字段 |
| page_size | int32 | List 請求中一頁的大小 |
| total_size | int32 | 資源總數量 |
| next_page_token | string | List 響應中的下一頁，用於下一次請求的 page_token 字段 |
| resume_token | string | 用於恢復流請求的 opaque token |
| labels | map<string, string> | 表示雲資源標籤 |
| deleted | bool | 若是資源支持恢復，它必須具備 deleted 標籤來標記資源是否被刪除 |
| show_deleted | bool | 若是資源支持恢復，對應的 List 方法必須有 show_deleted 字段來表示是否展現被刪除的資源 |
| update_mask | FieldMask | 用於在 Update 請求中對資源進行部分更新 |
| validate_only | bool | 爲 true 時表示請求只驗證而不會執行 |

查看其餘章節