Package google.type

索引

日付

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

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

関連するタイプ:

フィールド
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 水曜日
THURSDAY 木曜日
FRIDAY Friday
SATURDAY 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。必須。通常の電話番号またはショートコードのいずれかです。今後、以下のフィールドに新しいフィールドが追加される可能性があるため、クライアントはコーディングするフィールドが設定されていない電話番号を無視する必要があります。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 にテキストを送信して、プランの残り時間を確認する」)。

ショートコードは特定の地域に限定されており、国際電話はできません。つまり、地域間で同じ国番号(US と CA など)を共有している場合でも、同じショートコードを異なる地域で、使用方法や料金が異なることがあります。

フィールド
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 の値は型情報を持たず、単一の項目に複数の値を含めることがあるため(例: 「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.Dategoogle.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")。