이번 섹션에서는 유사한 개념이 필요할 때 사용해야 하는 표준 메시지 필드 정의에 대해서 설명합니다. 이 정의를 통해 개념이 같으면 API가 다르더라도 이름과 시맨틱스가 동일할 수 있습니다.
| 이름 | 유형 | 설명 |
|---|---|---|
name |
string |
name 필드에는 상대 리소스 이름이 포함되어야 합니다. |
parent |
string |
리소스 정의 및 List/Create 요청의 경우 parent 필드에는 상위 상대 리소스 이름이 포함되어야 합니다. |
create_time |
Timestamp |
개체가 만들어진 타임스탬프입니다. |
update_time |
Timestamp |
개체가 마지막으로 업데이트된 타임스탬프입니다. 참고: update_time은 만들기/패치/삭제 작업을 실행할 때 업데이트됩니다. |
delete_time |
Timestamp |
개체가 삭제된 타임스탬프입니다. 단, 보관 기능을 지원하는 경우에 한합니다. |
expire_time |
Timestamp |
개체가 만료된 경우의 타임스탬프입니다. |
start_time |
Timestamp |
기간의 시작을 나타내는 타임스탬프입니다. |
end_time |
Timestamp |
기간 또는 작업(성공 여부에 상관없이)의 끝을 나타내는 타임스탬프입니다. |
read_time |
Timestamp |
개체를 읽어야 하거나(요청에서 사용된 경우), 혹은 읽은(응답에서 사용된 경우) 특정 타임스탬프입니다. |
time_zone |
string |
시간대 이름입니다. 'America/Los_Angeles' 같은 IANA TZ 이름이 되어야 합니다. 자세한 내용은 https://en.wikipedia.org/wiki/List_of_tz_database_time_zones를 참조하세요. |
region_code |
string |
위치를 나타내는 Unicode 국가/지역 코드(CLDR)입니다(예: 'US', '419'). 자세한 내용은 http://www.unicode.org/reports/tr35/#unicode_region_subtag를 참조하세요. |
language_code |
string |
BCP-47 언어 코드(예: 'en-US' 또는 'sr-Latn')입니다. 자세한 내용은 http://www.unicode.org/reports/tr35/#Unicode_locale_identifier를 참조하세요. |
mime_type |
string |
IANA에서 게시한 MIME 유형입니다(미디어 유형으로도 불림). 자세한 내용은 https://www.iana.org/assignments/media-types/media-types.xhtml을 참조하세요. |
display_name |
string |
개체의 표시 이름입니다. |
title |
string |
개체의 공식 명칭입니다(예: 회사 이름). display_name 공식 버전으로 처리되어야 합니다. |
description |
string |
개체에 대한 텍스트 설명이 포함된 1개 이상의 단락입니다. |
filter |
string |
List 메서드의 표준 필터 매개변수입니다. AIP-160을 참조하세요. |
query |
string |
검색 메서드에 적용되는 경우(즉, :search) filter와 동일합니다. |
page_token |
string |
List 요청에서 페이지로 나누기 토큰입니다. |
page_size |
int32 |
List 요청에서 페이지로 나누기 크기입니다. |
total_size |
int32 |
페이지로 나누기와 상관없이 목록에 포함된 전체 항목 수입니다. |
next_page_token |
string |
List 응답에서 다음 페이지로 나누기 토큰입니다. 다음 요청에 page_token으로 사용해야 합니다. 비어있는 값은 결과가 더 이상 없다는 의미입니다. |
order_by |
string |
List 요청에 대한 결과 정렬을 지정합니다. |
progress_percent |
int32 |
작업 진행 상태를 백분율로 지정합니다(0~100). -1 값은 진행 상태를 알 수 없음을 나타냅니다. |
request_id |
string |
중복 요청을 감지할 때 사용되는 고유 문자열 ID입니다. |
resume_token |
string |
스트리밍 요청을 재개할 때 사용되는 불투명 토큰입니다. |
labels |
map<string, string> |
클라우드 리소스 라벨을 나타냅니다. |
show_deleted |
bool |
리소스가 삭제 취소 동작을 허용하는 경우 클라이언트가 삭제된 리소스를 탐색할 수 있도록 해당 List 메서드에 show_deleted 필드가 있어야 합니다. |
update_mask |
FieldMask |
리소스에 부분 업데이트를 수행할 수 있도록 Update 요청 메시지에 사용됩니다. 이 마스크는 요청 메시지가 아닌 리소스와 관련이 있습니다. |
validate_only |
bool |
true인 경우 지정된 요청을 실행하지 않고 확인만 해야 한다는 것을 나타냅니다. |
시스템 매개변수
Google API는 표준 필드 외에 모든 API 메서드에서 사용할 수 있는 공통 요청 매개변수 집합도 지원합니다. 이러한 매개변수를 시스템 매개변수라고 합니다. 자세한 내용은 시스템 매개변수를 참조하세요.