標準フィールド

ここでは、類似するコンセプトが必要になった場合に使用する、一連の標準メッセージ フィールドの定義について説明します。これにより、異なる API 間で、同じコンセプトには同じ名前とセマンティクスが使用されるようになります。

名前 説明
name string name フィールドには、相対的なリソース名を格納します。
parent string リソース定義とリスト / 作成リクエストについては、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 「US」や「419」など、ロケーションの Unicode 国 / リージョン コード(CLDR)。詳細については、http://www.unicode.org/reports/tr35/#unicode_region_subtag をご覧ください。
language_code string 「en-US」や「sr-Latn」などの BCP-47 言語コード。詳細については、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 メソッドの標準フィルタ パラメータ。
query string 検索メソッド(:search)に適用される場合は、filter と同じです。
page_token string リスト リクエストでのページ設定トークン。
page_size int32 リスト リクエストでのページ設定サイズ。
total_size int32 ページ設定に関係なく、リスト内のアイテムの合計数。
next_page_token string リスト レスポンスでの次のページ設定トークン。後続のリクエストで page_token として使用されます。値が空の場合、結果はありません。
order_by string リスト リクエストの結果の順序を指定します。
request_id string 重複するリクエストを検出するために使用される一意の文字列 ID。
resume_token string ストリーミング リクエストを再開するために使用される不透明トークン。
labels map<string, string> Cloud のリソースラベルを表します。
deleted bool 削除の取り消し動作が許可されるリソースには、リソースが削除されたことを示す deleted フィールドが含まれている必要があります。
show_deleted bool リソースで削除の取り消し動作が許可される場合、削除済みリソースがクライアントで検出できるように、対応する List メソッドに show_deleted フィールドが含まれている必要があります。
update_mask FieldMask このフィールドは、リソースの部分更新を実行する場合に Update リクエスト メッセージに使用されます。このマスクは、リクエスト メッセージではなく、リソースを基準にしています。
validate_only bool true の場合、指定されたリクエストを検証するのみで実行しないことを示します。

システム パラメータ

標準のフィールドのほかに、Google API はすべての API メソッドで利用可能な一連の一般的なリクエスト パラメータもサポートしています。これらのパラメータはシステム パラメータといいます。詳細については、システム パラメータをご覧ください。

このページは役立ちましたか?評価をお願いいたします。

フィードバックを送信...