パッケージ google.walletobjects.v1

インデックス

AddMessageRequest

AddMessage エンドポイントが呼び出されるときに使用されるリソース。

フィールド
message

Message

AppLinkData

フィールド

AppLinkInfo

フィールド
app_logo_image

Image

アプリリンク モジュールに表示される省略可能な画像。

title

LocalizedString

必須のアプリリンク モジュールのタイトルに表示される文字列。

description

LocalizedString

必須のアプリリンク モジュールの説明に表示される文字列。

app_target

AppTarget

クライアントでアプリリンク モジュールを開くときに使用する URL。パートナーがウェブページまたはアプリへのディープリンクを開くために使用されます。

AppTarget

フィールド
target_uri

Uri

Barcode

フィールド
kind
(deprecated)

string

リソースの種類を識別します。値: 固定文字列 "walletobjects#barcode"

type

BarcodeType

バーコードのタイプ。

render_encoding

BarcodeRenderEncoding

バーコードのレンダリング エンコード。指定すると、バーコードは指定されたエンコードでレンダリングされます。指定しなかった場合、最も一般的なエンコードが Google によって選択されます。

value

string

バーコードにコード化された値。

alternate_text

string

バーコードの下に表示されるデフォルトのテキストをオーバーライドするオプションのテキスト。このフィールドは、バーコードに相当する値を人間が読み取れるテキストで示すもので、バーコードがスキャンできない場合に使用されます。

show_code_text

LocalizedString

クリック操作の背後にバーコードが隠れるときに表示されるオプションのテキスト。これは、パスでスマートタップが有効になっている場合に発生します。指定しない場合、デフォルトが Google によって選択されます。

BarcodeRenderEncoding

列挙型
RENDER_ENCODING_UNSPECIFIED
UTF_8 バーコードの UTF_8 エンコーディング。これは、バーコード タイプ qrCode のみでサポートされます。

BarcodeType

列挙型
BARCODE_TYPE_UNSPECIFIED
AZTEC
aztec

AZTEC のレガシー エイリアス。非推奨。

CODE_39
code39

CODE_39 のレガシー エイリアス。非推奨。

CODE_128
code128

CODE_128 のレガシー エイリアス。非推奨。

CODABAR
codabar

CODABAR のレガシー エイリアス。非推奨。

DATA_MATRIX 黒と白で構成される 2D マトリックス バーコード。セルまたはモジュールは、正方形または長方形の形で配置されます。
dataMatrix

DATA_MATRIX のレガシー エイリアス。非推奨。

EAN_8
ean8

EAN_8 のレガシー エイリアス。非推奨。

EAN_13
ean13

EAN_13 のレガシー エイリアス。非推奨。

EAN13

EAN_13 のレガシー エイリアス。非推奨。

ITF_14 14 桁の ITF コード。
itf14

ITF_14 のレガシー エイリアス。非推奨。

PDF_417
pdf417

PDF_417 のレガシー エイリアス。非推奨。

PDF417

PDF_417 のレガシー エイリアス。非推奨。

QR_CODE
qrCode

QR_CODE のレガシー エイリアス。非推奨。

qrcode

QR_CODE のレガシー エイリアス。非推奨。

UPC_A 11 または 12 桁のコード。
upcA

UPC_A のレガシー エイリアス。非推奨。

TEXT_ONLY フィールドをテキスト フィールドとしてレンダリングします。alternateText フィールドは、textOnly タイプのバーコードでは使用できません。
textOnly

TEXT_ONLY のレガシー エイリアス。非推奨。

CallbackOptions

フィールド
url

string

販売者が構成した HTTPS URL。URL は HTTPS でホストされ、robots.txt は UserAgent:Google-Valuables によって URL パスにアクセスできるようにする必要があります。

update_request_url

string

更新をリクエストするために呼び出される販売者エンドポイントの URL。URL は HTTPS でホストされ、robots.txt は UserAgent:Google-Valuables によって URL パスにアクセスできるようにする必要があります。

このフィールドを使用する前に、Google サポートにお問い合わせください。

DateTime

フィールド
date

string

ISO 8601 拡張形式の日付 / 時刻。オフセットは必要な場合と必要でない場合があります(親フィールドのドキュメントを参照)。時刻は、ナノ秒の精度まで指定できます。オフセットは秒の精度で指定できます(オフセット秒は ISO 8601 には含まれていません)。

例:

1985-04-12T23:20:50.52Z は、1985 年 4 月 12 日の 23 時 20 分 50.52 秒(UTC)です。

1985-04-12T19:20:50.52-04:00 は、1985 年 4 月 12 日の 19 時 20 分 50.52 秒(UTC の 4 時間前)です(上記の例と同じ時刻を表します)。日付 / 時刻がニューヨークの物理的な場所を対象としている場合、これはアメリカ東部夏時間(EDT)に相当します。夏時間を実施しているリージョンでは、年内の時期に応じてオフセットが異なるので注意してください。

1985-04-12T19:20:50.52 は 1985 年 4 月 12 日の 19 時 20 分 50.52 秒で、オフセット情報はありません。

オフセットを指定すると、これは全世界である特定の時点を表します。日付 / 時刻は、ユーザーのタイムゾーンに基づいて調整されます。たとえば、2018-06-19T18:30:00-04:00 という時刻は、ニューヨークのユーザーの場合は 18:30:00、ロサンゼルスのユーザーの場合は 15:30:00 になります。

オフセットを省略すると、これはローカルの日付 / 時刻になり、全世界で複数の時点を表します。日付 / 時刻は、常にユーザーの現在のタイムゾーンでの日付 / 時刻になります。たとえば、2018-06-19T18:30:00 という時刻は、ニューヨークのユーザーの場合は 18:30:00、ロサンゼルスのユーザーの場合も 18:30:00 になります。これは、同じローカルの日付 / 時刻を複数のタイムゾーンにわたって多くの物理的な場所に適用する場合に便利です。

DiscoverableProgram

Android Pay アプリ内でクラスが検出され、インスタンス化される方法の詳細。これは、ポイント プログラムまたはギフトカード プログラムを検索し、スキャンするか、手動で入力することによって行います。

フィールド
merchant_signup_info

DiscoverableProgramMerchantSignupInfo

販売店のサイトからこのプログラムに登録し、貴重な情報を提供できるかどうか。MERCHANT_HOSTED_SIGNUP が有効な場合に使用します。

merchant_signin_info

DiscoverableProgramMerchantSigninInfo

販売店のサイトからこのプログラムにログインし、貴重な情報を提供できるかどうか。MERCHANT_HOSTED_SIGNIN が有効な場合に使用します。

state

State

検出可能なプログラムの可視化状態。

State

列挙型
STATE_UNSPECIFIED
TRUSTED_TESTERS 発行者アカウントにアクセスできるテスターにのみ表示されます。
trustedTesters

TRUSTED_TESTERS のレガシー エイリアス。非推奨。

LIVE 全員に表示されます。
live

LIVE のレガシー エイリアス。非推奨。

DISABLED 表示されません。
disabled

DISABLED のレガシー エイリアス。非推奨。

DiscoverableProgramMerchantSigninInfo

販売者がホストするプログラムのログインフローに関する情報。

フィールド
signin_website

Uri

販売店のログインサイトにユーザーを誘導する URL。

DiscoverableProgramMerchantSignupInfo

販売者がホストするプログラムの登録フローに関する情報。

フィールド
signup_website

Uri

販売店の登録サイトにユーザーを誘導する URL。

signup_shared_datas[]

SharedDataType

POST リクエストで登録サイトの URL に送信されるユーザーデータ。この情報は、エンコードされて共有されます。販売店のサイトでは、検出可能なプログラムのユーザー登録で、この情報が事前に入力されます。

SharedDataType

列挙型
SHARED_DATA_TYPE_UNSPECIFIED
FIRST_NAME
LAST_NAME
STREET_ADDRESS 単一行の住所欄
ADDRESS_LINE_1 複数行の住所欄
ADDRESS_LINE_2
ADDRESS_LINE_3
CITY
STATE
ZIPCODE
COUNTRY
EMAIL
PHONE

GroupingInfo

NEXT_ID: 2

フィールド
sort_index

int32

パスが他のパスとまとめてグループ化されている場合に、パスを並べ替えるための任意のインデックス。並べ替えインデックスが小さいパスは、並べ替えインデックスが大きいパスより前に表示されます。指定しない場合、値は INT_MAX とみなされます。並べ替えインデックスが同じである 2 つのパスの並べ替え動作は定義されません。

画像

Google がホストする画像のラッピング タイプ。

フィールド
kind
(deprecated)

string

リソースの種類を識別します。値: 固定文字列 "walletobjects#image"

source_uri

ImageUri

画像の URI。

ImageModuleData

フィールド
main_image

Image

100% 幅の画像。

id

string

画像モジュールに関連付けられた ID。このフィールドは、画像モジュールの管理を容易にするためのものです。

ImageUri

フィールド
uri

string

画像の場所。URI にはスキームが必要です。

description
(deprecated)

string

画像に関する追加情報。この情報は使用されず、下位互換性のためだけに保持されます。

localized_description
(deprecated)

LocalizedString

説明を翻訳した文字列。この情報は使用されず、下位互換性のためだけに保持されます。

InfoModuleData

フィールド
label_value_rows[]

LabelValueRow

ラベルと値のコレクションのリスト。これらは、1 つの列に順番に表示されます。

show_last_update_time
(deprecated)

bool

LabelValue

詳細ビューに表示されるテキスト文字列のペア。LabelValue / LabelValueRow はテーブルとして表示されなくなり、アイテムのリストとして表示されるので注意してください。

フィールド
label

string

特定の行と列のラベル。2 列のレイアウトの場合は 15 文字以下、1 列のレイアウトの場合は 30 文字以下にすることをおすすめします。

value

string

特定の行と列の値。2 列のレイアウトの場合は 15 文字以下、1 列のレイアウトの場合は 30 文字以下にすることをおすすめします。

localized_label

LocalizedString

ラベルの翻訳文字列。2 列のレイアウトの場合は 15 文字以下、1 列のレイアウトの場合は 30 文字以下にすることをおすすめします。

localized_value

LocalizedString

値の翻訳文字列。2 列のレイアウトの場合は 15 文字以下、1 列のレイアウトの場合は 30 文字以下にすることをおすすめします。

LabelValueRow

フィールド
columns[]

LabelValue

ラベルと値のリスト。フィールド名と異なり、これらは複数の列ではなく、1 つの列に順番に表示されます。

LatLongPoint

フィールド
kind
(deprecated)

string

リソースの種類を識別します。値: 固定文字列 "walletobjects#latLongPoint"

latitude

double

-90.0~+90.0 の範囲(両端を含む)の値で指定される緯度。この範囲外の値は指定できません。

longitude

double

-180.0~+180.0 の範囲(両端を含む)で指定される経度。この範囲外の値は指定できません。

LinksModuleData

フィールド
uris[]

Uri

URI のリスト。

LocalizedString

フィールド
kind
(deprecated)

string

リソースの種類を識別します。値: 固定文字列 "walletobjects#localizedString"

translated_values[]

TranslatedString

文字列の翻訳が含まれます。

default_value

TranslatedString

適切な翻訳が利用できない場合に表示される文字列が含まれます。

Message

Valuable で表示されるメッセージ

フィールド
kind
(deprecated)

string

リソースの種類を識別します。値: 固定文字列 "walletobjects#walletObjectMessage"

header

string

メッセージ ヘッダー。

body

string

メッセージの本文。

display_interval

TimeInterval

メッセージがユーザーに表示される期間。メッセージごとに startTimeendTime の両方を定義できます。startTime が設定されていない限り、ウォレット オブジェクトが挿入されたすぐ後にメッセージが表示されます。endTime が設定されない場合、メッセージは無期限にメッセージのリストに表示されます。

id

string

メッセージに関連付けられた ID。この項目はメッセージの管理を容易にするためのものです。ID 値は、同じクラスやインスタンスの複数のメッセージで重複する可能性があります。メッセージごとに適切な ID を選択するように注意してください。

message_type

MessageType

メッセージのタイプ。現在、これはクーポンにのみ設定できます。

localized_header

LocalizedString

メッセージ ヘッダーの翻訳文字列。

localized_body

LocalizedString

メッセージ本文の翻訳文字列。

MessageType

列挙型
MESSAGE_TYPE_UNSPECIFIED
TEXT メッセージをカード情報画面にテキストとして表示します。これがデフォルトのメッセージ タイプです。
text

TEXT のレガシー エイリアス。非推奨。

EXPIRATION_NOTIFICATION クーポンの有効期限について表示する通知。displayInterval.start.date によって、通知が表示される時間が設定されます。有効期限の 30 日前まで設定できます。30 日より前に指定した場合は、30 日前に通知がトリガーされます。
expirationNotification

EXPIRATION_NOTIFICATION のレガシー エイリアス。非推奨。

ModifyLinkedOfferObjects

フィールド
add_linked_offer_object_ids[]

string

オブジェクトに追加するリンク済みクーポン オブジェクトの ID。

remove_linked_offer_object_ids[]

string

オブジェクトから削除する、リンク済みクーポン オブジェクトの ID。

ModifyLinkedOfferObjectsRequest

フィールド
linked_offer_object_ids

ModifyLinkedOfferObjects

オブジェクトに追加する、またはオブジェクトから削除するリンク済みクーポン オブジェクトの ID。

Money

フィールド
kind
(deprecated)

string

リソースの種類を識別します。値: 固定文字列 "walletobjects#money"

micros

int64

マイクロ単位の金額。たとえば、$1 USD は 1000000 マイクロとして表されます。

currency_code

string

通貨コード(「USD」、「EUR」など)。

MultipleDevicesAndHoldersAllowedStatus

列挙型
STATUS_UNSPECIFIED
MULTIPLE_HOLDERS 複数のデバイス上で複数のユーザーが許可されます。
multipleHolders

MULTIPLE_HOLDERS のレガシー エイリアス。非推奨。

ONE_USER_ALL_DEVICES 複数のデバイス上で 1 人のユーザーが許可されます。
oneUserAllDevices

ONE_USER_ALL_DEVICES のレガシー エイリアス。非推奨。

ONE_USER_ONE_DEVICE 限られた状況下で一部のパートナーが使用することを想定しています。詳細については、サポートにお問い合わせください。
oneUserOneDevice

ONE_USER_ONE_DEVICE のレガシー エイリアス。非推奨。

Pagination

フィールド
kind
(deprecated)

string

リソースの種類を識別します。値: 固定文字列 "walletobjects#pagination"

results_per_page

int32

このページで返される結果の数。

next_page_token

string

次のページを取得するために送信するページトークン。

Review

フィールド
comments

string

ReviewStatus

列挙型
REVIEW_STATUS_UNSPECIFIED
UNDER_REVIEW
underReview

UNDER_REVIEW のレガシー エイリアス。非推奨。

APPROVED
approved

APPROVED のレガシー エイリアス。非推奨。

REJECTED
rejected

REJECTED のレガシー エイリアス。非推奨。

DRAFT
draft

DRAFT のレガシー エイリアス。非推奨。

State

列挙型
STATE_UNSPECIFIED
ACTIVE オブジェクトはアクティブであり、他のアクティブなオブジェクトとともに表示されます。
active

ACTIVE のレガシー エイリアス。非推奨。

COMPLETED
completed

COMPLETED のレガシー エイリアス。非推奨。

EXPIRED オブジェクトは有効ではなくなりました(validTimeInterval が経過しました)。
expired

EXPIRED のレガシー エイリアス。非推奨。

INACTIVE
inactive

INACTIVE のレガシー エイリアス。非推奨。

TextModuleData

テキスト モジュールのデータ。すべてのフィールドは省略可能です。利用可能な場合はヘッダーが表示され、定義されている場合はさまざまなタイプの本文が連結されます。

フィールド
header

string

テキスト モジュールのヘッダー。小さな画面でも文字列全体が表示されるように、35 文字以下にすることをおすすめします。

body

string

テキスト モジュールの本文。途切れのない文字列として定義されています。小さな画面でも文字列全体が表示されるように、500 文字以下にすることをおすすめします。

localized_header

LocalizedString

ヘッダーの翻訳文字列。小さな画面でも文字列全体が表示されるように、35 文字以下にすることをおすすめします。

localized_body

LocalizedString

本文の翻訳文字列。小さな画面でも文字列全体が表示されるように、500 文字以下にすることをおすすめします。

id

string

メッセージに関連付けられた ID。このフィールドは、テキスト モジュールの管理を容易にするためのものです。

TimeInterval

フィールド
kind
(deprecated)

string

リソースの種類を識別します。値: 固定文字列 "walletobjects#timeInterval"

start

DateTime

期間の開始時刻。

オフセットは省略可能です。オフセットを指定し、end の時刻を設定する場合は、end にもオフセットを含める必要があります。

end

DateTime

期間の終了時刻。

オフセットは省略可能です。オフセットを指定し、start の時刻を設定する場合は、start にもオフセットを含める必要があります。

TranslatedString

フィールド
kind
(deprecated)

string

リソースの種類を識別します。値: 固定文字列 "walletobjects#translatedString"

language

string

BCP 47 言語タグを表します。たとえば、「en-US」、「en-GB」、「de」、「de-AT」など。

value

string

UTF-8 でエンコードされた翻訳文字列。

URI

フィールド
kind
(deprecated)

string

リソースの種類を識別します。値: 固定文字列 "walletobjects#uri"

uri

string

ウェブページ、画像、他のリソースの場所。LinksModuleData モジュールの URI には、URI のタイプ(ウェブページへのリンク、マップへのリンク、電話番号、メールアドレス)ごとにそれぞれ異なるプレフィックスを指定できます。URI にはスキームが必要です。

description

string

アプリにテキストとして表示される URI のタイトル。小さな画面でも文字列全体が表示されるように、20 文字以下にすることをおすすめします。

description が画像に含まれている場合など、一部のコンテキストでは、このテキストは使用されません。

localized_description

LocalizedString

説明の翻訳文字列。小さな画面でも文字列全体が表示されるように、20 文字以下にすることをおすすめします。

id

string

URI に関連付けられた ID。このフィールドは URI の管理を容易にするためのものです。