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 日曜日

間隔

開始タイムスタンプ（この時間を含む）と終了タイムスタンプ（この時間を除く）としてエンコードされた時間間隔を表します。

開始時間は終了時間以下にする必要があります。開始時間が終了時間と等しい場合、期間は空になります（どの時間にも一致しません）。開始時刻と終了時刻の両方が指定されていない場合、間隔は任意の時刻と一致します。

フィールド
start_time

Timestamp

省略可。期間の開始値（この値を含みます）。

指定する場合は、この期間に一致するタイムスタンプが開始時刻と同じかそれ以降である必要があります。
end_time

Timestamp

省略可。間隔の終了時間です（この時間は含まれません）。

指定する場合、この期間に一致するタイムスタンプは終了時間より前にする必要があります。

PhoneNumber

API ワイヤー形式に適した、電話番号を表すオブジェクト。

この表現は、次のように表されます。

  • ロケール固有の電話番号のフォーマット（「+1 (650) 253-0000 ext. 123」など）には使用しないでください。

  • は、効率的なストレージ用に設計されていません。

  • 通話には適さない場合があります。その目的で番号を解析するには、専用のライブラリ（参照を参照）を使用する必要があります。

この数値をさまざまなユースケースに合わせてフォーマットするなど、意味のある処理を行うには、まず i18n.phonenumbers.PhoneNumber オブジェクトに変換します。

たとえば、Java では次のようになります。

com.google.type.PhoneNumber wireProto =
    com.google.type.PhoneNumber.newBuilder().build();
com.google.i18n.phonenumbers.Phonenumber.PhoneNumber phoneNumber =
    PhoneNumberUtil.getInstance().parse(wireProto.getE164Number(), "ZZ");
if (!wireProto.getExtension().isEmpty()) {
  phoneNumber.setExtension(wireProto.getExtension());
}

参照: - https://github.com/google/libphonenumber

フィールド
extension

string

電話番号の番号。長さが最大 40 桁の一連の番号であることを除き、内線番号については ITU 勧告で標準化されていません。桁数以外に、「,」（ポーズを指します）や「#」などの他のダイヤル文字もここに保存されます。

現在、短いコードを含む拡張機能を使用する地域はないため、通常、このフィールドは E.164 番号と組み合わせてのみ設定されます。将来的にショートコードの拡張ができるように、E.164 番号とは別に保持されます。
共用体フィールド kind。必須。通常の電話番号またはショートコードのいずれか。今後、以下の oneof に新しいフィールドが追加される可能性があるため、クライアントは、コードが設定されているフィールドが設定されていない電話番号を無視する必要があります。kind は次のいずれかになります。
e164_number

string

先頭にプラス記号（+）が付いた電話番号。その後に、国番号（1 ～ 3 桁）と加入者番号からなる緩和された ITU E.164 形式の電話番号が続きます。スペースやフォーマットは追加されません。例: - 正しい: "+15552220123" - 正しくない: "+1 (555) 222-01234 x123"。

ITU E.164 形式では後者が 12 桁に制限されていますが、実際にはすべての国がこの制限を遵守しているわけではないため、ここでは制限を緩和しています。国内専用番号は使用できません。

参照: - https://www.itu.int/rec/T-REC-E.164-201011-I - https://en.wikipedia.org/wiki/E.164- https://en.wikipedia.org/wiki/List_of_country_calling_codes
short_code

ShortCode

ショートコード。

参照: - https://en.wikipedia.org/wiki/Short_code

ShortCode

ショートコードを表すオブジェクト。通常、通常の電話番号よりもはるかに短い電話番号で、MMS システムと SMS システムのメッセージの宛先として使用できるほか、略称ダイヤルにも使用できます（「プランの残り分を確認するには 611 にテキストを送信してください」など）。

ショートコードは地域に限定され、国際電話には使用できません。つまり、同じショートコードが異なる地域に存在し、使用方法や料金が異なる場合があります（米国とカナダなど）。

フィールド
region_code

string

必須。このショートコードへの通話が可能な地域の BCP-47 地域コード（「US」や「BB」など）。

参照: - http://www.unicode.org/reports/tr35/#unicode_region_subtag
number

string

必須。先頭のプラス記号（+）や国コードを含めないショートコードの数字。例: 「611」。

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

省略可。その国 / 地域の住所に使用される最上位の行政区域。たとえば、州、省、都道府県などがこれに該当します。具体的には、スペインの場合であれば自治州ではなく県になります（例:「カタルーニャ」ではなく「バルセロナ」）。州や県などの行政区画が住所表記に使用されない国もあります。たとえば、スイスではこの項目を空のままにします。
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

1 分間の秒数。0 以上で、通常は 59 以下にする必要があります。API がうるう秒を許可する場合、値 60 が許可されます。
nanos

int32

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

TimeZone

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

フィールド
id

string

IANA タイムゾーン データベースのタイムゾーン。例: 「America/New_York」。
version

string

省略可。IANA タイムゾーン データベースのバージョン番号。例: 「2019a」。