Package google.type

索引

Date

誕生日などのように、カレンダーの日付全体またはその一部を表します。時間帯とタイムゾーンは、他の場所で指定されているか、重要ではありません。日付は西暦を基準にしており、次のいずれかを表します。

  • 年の値がゼロ以外である月と日の値を含む完全な日付
  • 年の値がゼロである月と日(記念日など)。
  • 月と日の値がゼロである単独の年。
  • 日の値がゼロである年と月(クレジット カードの有効期限など)

関連するタイプ:

フィールド
year

int32

その日付の年。1~9999、または年のない日付を指定する場合は 0 にする必要があります。

month

int32

1 年の中の月。1~12、または月と日のない年を指定する場合は 0 にする必要があります。

day

int32

1 月の中の日付。1~31 で、その年と月で有効な値にする必要があります。または、日が重要でない場合は年のみか年と月を指定するには 0 にする必要があります。

DayOfWeek

曜日を表します。

列挙型
DAY_OF_WEEK_UNSPECIFIED 曜日は指定されていません。
MONDAY 月曜日
TUESDAY 火曜日
WEDNESDAY Wednesday
THURSDAY 木曜日
FRIDAY 金曜日
SATURDAY 土曜日
SUNDAY 日曜日

間隔

時間間隔を表します。開始日時を示す Timestamp(この日時を含む)と終了日時を示す Timestamp(この日時を含まない)としてエンコードされます。

開始日時は終了日時以前にする必要があります。開始日時と終了日時が同じ場合、時間間隔は空になります(どの時間とも一致しません)。開始日時と終了日時が両方とも指定されていない場合、その時間間隔はすべての時間と一致します。

フィールド
start_time

Timestamp

省略可。時間間隔の開始日時(この日時を含む)。

指定した場合、開始日時と同じかそれ以降の Timestamp がこの時間間隔に一致します。

end_time

Timestamp

省略可。時間間隔の終了日時(この日時を含まない)。

指定した場合、終了時刻より前の Timestamp がこの時間間隔に一致します。

LatLng

緯度と経度のペアを表すオブジェクト。これは緯度を表す倍精度値と経度を表す倍精度値のペアで表現されます。特に明記されていない場合、このオブジェクトは WGS84 規格に準拠する必要があります。値は正規化範囲内になければなりません。

フィールド
latitude

double

緯度(度単位)。範囲 [-90.0, +90.0] 内になければなりません。

longitude

double

経度(度単位)。範囲 [-180.0, +180.0] 内になければなりません。

Money

その通貨タイプで金額を表します。

フィールド
currency_code

string

ISO 4217 で定義されている 3 文字の通貨コード。

units

int64

金額の整数部分。たとえば、currencyCode が "USD" の場合、1 単位は 1 米ドルです。

nanos

int32

金額の小数部分をナノ(10^-9)単位で表した数。値は -999,999,999 以上 +999,999,999 以下でなければなりません。units が正の場合、nanos には正数または 0 を指定します。units がゼロの場合、nanos には正数、0、または負数を指定できます。units が負の場合、nanos は負数または 0 を指定します。たとえば、$-1.75 は units = -1、nanos = -750,000,000 と表されます。

PostalAddress

郵便物の配達先住所や支払い先住所などの住所を表します。郵便サービスは、郵便住所を使用して、敷地、私書箱などに郵便物を配達できます。郵送先住所は、道路、町、山などの地理的位置をモデル化することを目的としていません。

一般的な使用法では、住所を作成するにはユーザー入力や既存データのインポートなどの方法がプロセスに応じて使用されます。

住所の入力または編集に関するアドバイス:

  • https://github.com/google/libaddressinput などの国際化対応の住所ウィジェットを使用してください。
  • フィールドの入力または編集に使用する UI 要素は、そのフィールドが使用されない国ではユーザーに表示しないでください。

このスキーマの使用方法の詳細については、https://support.google.com/business/answer/6397478 をご覧ください。

フィールド
revision

int32

PostalAddress のスキーマ リビジョン。これは、最新のリビジョンである 0 に設定する必要があります。

新しいリビジョンはすべて、古いリビジョンと下位互換性があることが必要です。

region_code

string

必須。住所の国 / 地域に対応する CLDR 地域コード。これは推測されず、値が正しいことを確認するのはユーザー次第です。詳細については、https://cldr.unicode.org/ と https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html をご覧ください。例: スイスの場合は「CH」。

language_code

string

省略可。この住所の内容の BCP-47 言語コード(分かっている場合)。これは、入力フォームの UI 言語であることが多く、住所の国/リージョンで使用されている言語のいずれか、またはそれらの文字変換された同等語と一致することが期待されます。これは、特定の国の書式設定に影響する可能性がありますが、データの正確性には重要ではなく、検証やその他の書式設定関連でない操作にはに影響しません。

この値が不明な場合は、省略してください(正しくない可能性のあるデフォルトを指定するのではなく)。

例: 「zh-Hant」、「ja」、「ja-Latn」、「en」。

postal_code

string

省略可。住所の郵便番号。すべての国で郵便番号の使用や存在を必要としているわけではありませんが、使用されている場合は、住所の他の部分で追加の確認が行われることがあります(例: 米国での州 / 郵便番号の確認)。

sorting_code

string

省略可。追加の国固有の並べ替えコード。ほとんどの地域では、これは使用されていません。使用される場合、値は「CEDEX」などの文字列で、必要に応じて数字(「CEDEX 7」など)が続くか、数字のみで「セクターコード」(ジャマイカ)、「配達エリア インジケーター」(マラウイ)、「郵便局インジケーター」(コートジボワール)を表します。

administrative_area

string

省略可。その国 / 地域の住所に使用される最上位の行政区域。たとえば、州、省、都道府県などがあります。スペインの場合、これは自治州ではなく県です(例: 「Catalonia」ではなく「Barcelona」)。州や県などの行政区画が住所表記に使用されない国もあります。たとえば、スイスではこの項目を空のままにします。

locality

string

省略可。一般的に住所の市町村部分を指します。たとえば、米国の市、イタリアのコムーネ、英国の郵便町です。国 / 地域によっては、これに相当する地域区分が明確に定義されていない場合や、この構造にうまく適合しない場合がありますが、その場合は locality を空のままにして address_lines を使用します。

sublocality

string

省略可。住所の市町村部分の下位の区画。たとえば、近隣地域、区、地区などです。

address_lines[]

string

住所の下位部分を記述する非構造化の住所行。

address_lines の値には型情報がなく、1 つのフィールドに複数の値が含まれることがあるため(例: 「Austin, TX」)、行の順序を明確にすることが重要です。住所行の順序は、住所の国または地域の「封筒の順序」にする必要があります。この順序が異なる地域(日本など)では、address_language を使用して明示的に指定します(たとえば、大きい単位から小さい単位の順序の場合は「ja」、小さい単位から大きい単位の順序の場合は「ja-Latn」または「en」)。このようにして、言語に基づいて住所の最も具体的な行を選択できます。

住所の構造表現として許容される最小限の構成は、region_code と、残りのすべての情報が配置された address_lines です。そのような住所を、ジオコーディングなしできわめて正確に近く書式設定することも可能ですが、住所の構成要素についての意味的な推論は、少なくとも部分的に解決されるまでは不可能です。

まったく構造化されていない住所を扱うときは、region_code と address_lines だけで構成される住所を作成してからジオコーディングすることが、おすすめの方法です(住所のどの部分が地域区分で、どれが行政区域かを推測するのではなく)。

recipients[]

string

省略可。その住所で受け取る人。この項目は、状況によって複数の情報を含むことがあります。たとえば、「様方」情報が含まれる場合があります。

organization

string

省略可。その住所にある組織の名前。

TimeOfDay

1 日のうちの時間を表します。日付とタイムゾーンは重要ではないか、他の場所で指定されています。API は、うるう秒を許可するようにできます。関連する型は、google.type.Date と google.protobuf.Timestamp です。

フィールド
hours

int32

時間(24 時間形式)。0 以上、通常は 23 以下の値を指定する必要があります。API ではビジネスの終了時間などのシナリオにおいて、値 "24:00:00" を許可することもできます。

minutes

int32

分。0 以上 59 以下にする必要があります。

seconds

int32

秒。0 以上、通常は 59 以下の値を指定する必要があります。API がうるう秒を許可する場合、値 60 が許可されます。

nanos

int32

秒の小数部分(ナノ秒単位)。0 以上 999,999,999 以下にする必要があります。

TimeZone

IANA タイムゾーン データベースのタイムゾーンを表します。

フィールド
id

string

IANA タイムゾーン データベースのタイムゾーン。たとえば、「America/New_York」。

version

string

省略可。IANA タイムゾーン データベースのバージョン番号。たとえば、「2019a」。