インデックス
AddMessageRequest(メッセージ)AppLinkData(メッセージ)AppLinkData.AppLinkInfo(メッセージ)AppLinkData.AppLinkInfo.AppTarget(メッセージ)Barcode(メッセージ)BarcodeRenderEncoding(列挙型)BarcodeType(列挙型)CallbackOptions(メッセージ)DateTime(メッセージ)DiscoverableProgram(メッセージ)DiscoverableProgram.State(列挙型)DiscoverableProgramMerchantSigninInfo(メッセージ)DiscoverableProgramMerchantSignupInfo(メッセージ)DiscoverableProgramMerchantSignupInfo.SharedDataType(列挙型)GroupingInfo(メッセージ)Image(メッセージ)ImageModuleData(メッセージ)ImageUri(メッセージ)InfoModuleData(メッセージ)LabelValue(メッセージ)LabelValueRow(メッセージ)LatLongPoint(メッセージ)LinksModuleData(メッセージ)LocalizedString(メッセージ)Message(メッセージ)Message.MessageType(列挙型)ModifyLinkedOfferObjects(メッセージ)ModifyLinkedOfferObjectsRequest(メッセージ)Money(メッセージ)MultipleDevicesAndHoldersAllowedStatus(列挙型)Pagination(メッセージ)Review(メッセージ)ReviewStatus(列挙型)State(列挙型)TextModuleData(メッセージ)TimeInterval(メッセージ)TranslatedString(メッセージ)Uri(メッセージ)
AddMessageRequest
AddMessage エンドポイントが呼び出されるときに使用されるリソース。
| フィールド | |
|---|---|
message |
|
AppLinkData
| フィールド | |
|---|---|
android_app_link_info |
パートナー アプリリンクに関する補足情報。含まれている場合、アプリリンク リンク モジュールは、Android クライアントの重要な詳細情報に表示されます。 |
ios_app_link_info |
パートナー アプリリンクに関する補足情報。含まれている場合、アプリリンク リンク モジュールは、iOS クライアントの重要な詳細情報に表示されます。 |
web_app_link_info |
パートナー アプリリンクに関する補足情報。含まれている場合、アプリリンク リンク モジュールは、ウェブ クライアントの重要な詳細情報に表示されます。 |
AppLinkInfo
| フィールド | |
|---|---|
app_logo_image |
アプリリンク モジュールに表示される省略可能な画像。 |
title |
必須のアプリリンク モジュールのタイトルに表示される文字列。 |
description |
必須のアプリリンク モジュールの説明に表示される文字列。 |
app_target |
クライアントでアプリリンク モジュールを開くときに使用する URL。パートナーがウェブページまたはアプリへのディープリンクを開くために使用されます。 |
AppTarget
| フィールド | |
|---|---|
target_uri |
|
Barcode
| フィールド | |
|---|---|
kind |
リソースの種類を識別します。値: 固定文字列 |
type |
バーコードのタイプ。 |
render_encoding |
バーコードのレンダリング エンコード。指定すると、バーコードは指定されたエンコードでレンダリングされます。指定しなかった場合、最も一般的なエンコードが Google によって選択されます。 |
value |
バーコードにコード化された値。 |
alternate_text |
バーコードの下に表示されるデフォルトのテキストをオーバーライドするオプションのテキスト。このフィールドは、バーコードに相当する値を人間が読み取れるテキストで示すもので、バーコードがスキャンできない場合に使用されます。 |
show_code_text |
クリック操作の背後にバーコードが隠れるときに表示されるオプションのテキスト。これは、パスでスマートタップが有効になっている場合に発生します。指定しない場合、デフォルトが Google によって選択されます。 |
BarcodeRenderEncoding
| 列挙型 | |
|---|---|
RENDER_ENCODING_UNSPECIFIED |
|
UTF_8 |
バーコードの UTF_8 エンコーディング。これは、バーコード タイプ qrCode のみでサポートされます。 |
BarcodeType
| 列挙型 | |
|---|---|
BARCODE_TYPE_UNSPECIFIED |
|
AZTEC |
|
aztec |
|
CODE_39 |
|
code39 |
|
CODE_128 |
|
code128 |
|
CODABAR |
|
codabar |
|
DATA_MATRIX |
黒と白で構成される 2D マトリックス バーコード。セルまたはモジュールは、正方形または長方形の形で配置されます。 |
dataMatrix |
|
EAN_8 |
|
ean8 |
|
EAN_13 |
|
ean13 |
|
EAN13 |
|
ITF_14 |
14 桁の ITF コード。 |
itf14 |
|
PDF_417 |
|
pdf417 |
|
PDF417 |
|
QR_CODE |
|
qrCode |
|
qrcode |
|
UPC_A |
11 または 12 桁のコード。 |
upcA |
|
TEXT_ONLY |
フィールドをテキスト フィールドとしてレンダリングします。alternateText フィールドは、textOnly タイプのバーコードでは使用できません。 |
textOnly |
|
CallbackOptions
| フィールド | |
|---|---|
url |
販売者が構成した HTTPS URL。URL は HTTPS でホストされ、robots.txt は UserAgent:Google-Valuables によって URL パスにアクセスできるようにする必要があります。 |
DateTime
| フィールド | |
|---|---|
date |
ISO 8601 拡張形式の日付 / 時刻。オフセットは必要な場合と必要でない場合があります(親フィールドのドキュメントを参照)。時刻は、ナノ秒の精度まで指定できます。オフセットは秒の精度で指定できます(オフセット秒は ISO 8601 には含まれていません)。 例:
オフセットを指定すると、これは全世界である特定の時点を表します。日付 / 時刻は、ユーザーのタイムゾーンに基づいて調整されます。たとえば、 オフセットを省略すると、これはローカルの日付 / 時刻になり、全世界で複数の時点を表します。日付 / 時刻は、常にユーザーの現在のタイムゾーンでの日付 / 時刻になります。たとえば、 |
DiscoverableProgram
Android Pay アプリ内でクラスが検出され、インスタンス化される方法の詳細。これは、ポイント プログラムまたはギフトカード プログラムを検索し、スキャンするか、手動で入力することによって行います。
| フィールド | |
|---|---|
merchant_signup_info |
販売店のサイトからこのプログラムに登録し、貴重な情報を提供できるかどうか。MERCHANT_HOSTED_SIGNUP が有効な場合に使用します。 |
merchant_signin_info |
販売店のサイトからこのプログラムにログインし、貴重な情報を提供できるかどうか。MERCHANT_HOSTED_SIGNIN が有効な場合に使用します。 |
state |
検出可能なプログラムの可視化状態。 |
State
| 列挙型 | |
|---|---|
STATE_UNSPECIFIED |
|
TRUSTED_TESTERS |
発行者アカウントにアクセスできるテスターにのみ表示されます。 |
trustedTesters |
|
LIVE |
全員に表示されます。 |
live |
|
DISABLED |
表示されません。 |
disabled |
|
DiscoverableProgramMerchantSigninInfo
販売者がホストするプログラムのログインフローに関する情報。
| フィールド | |
|---|---|
signin_website |
販売店のログインサイトにユーザーを誘導する URL。 |
DiscoverableProgramMerchantSignupInfo
販売者がホストするプログラムの登録フローに関する情報。
| フィールド | |
|---|---|
signup_website |
販売店の登録サイトにユーザーを誘導する URL。 |
signup_shared_datas[] |
POST リクエストで登録サイトの URL に送信されるユーザーデータ。この情報は、エンコードされて共有されます。販売店のサイトでは、検出可能なプログラムのユーザー登録で、この情報が事前に入力されます。 |
GroupingInfo
NEXT_ID: 2
| フィールド | |
|---|---|
sort_index |
パスが他のパスとまとめてグループ化されている場合に、パスを並べ替えるための任意のインデックス。並べ替えインデックスが小さいパスは、並べ替えインデックスが大きいパスより前に表示されます。指定しない場合、値は INT_MAX とみなされます。並べ替えインデックスが同じである 2 つのパスの並べ替え動作は定義されません。 |
画像
Google がホストする画像のラッピング タイプ。
| フィールド | |
|---|---|
kind |
リソースの種類を識別します。値: 固定文字列 |
source_uri |
画像の URI。 |
ImageModuleData
| フィールド | |
|---|---|
main_image |
100% 幅の画像。 |
id |
画像モジュールに関連付けられた ID。このフィールドは、画像モジュールの管理を容易にするためのものです。 |
ImageUri
| フィールド | |
|---|---|
uri |
画像の場所。URI にはスキームが必要です。 |
description |
画像に関する追加情報。この情報は使用されず、下位互換性のためだけに保持されます。 |
localized_description |
説明を翻訳した文字列。この情報は使用されず、下位互換性のためだけに保持されます。 |
InfoModuleData
| フィールド | |
|---|---|
label_value_rows[] |
ラベルと値のコレクションのリスト。これらは、1 つの列に順番に表示されます。 |
show_last_update_time |
|
LabelValue
詳細ビューに表示されるテキスト文字列のペア。LabelValue / LabelValueRow はテーブルとして表示されなくなり、アイテムのリストとして表示されるので注意してください。
| フィールド | |
|---|---|
label |
特定の行と列のラベル。2 列のレイアウトの場合は 15 文字以下、1 列のレイアウトの場合は 30 文字以下にすることをおすすめします。 |
value |
特定の行と列の値。2 列のレイアウトの場合は 15 文字以下、1 列のレイアウトの場合は 30 文字以下にすることをおすすめします。 |
localized_label |
ラベルの翻訳文字列。2 列のレイアウトの場合は 15 文字以下、1 列のレイアウトの場合は 30 文字以下にすることをおすすめします。 |
localized_value |
値の翻訳文字列。2 列のレイアウトの場合は 15 文字以下、1 列のレイアウトの場合は 30 文字以下にすることをおすすめします。 |
LabelValueRow
| フィールド | |
|---|---|
columns[] |
ラベルと値のリスト。フィールド名と異なり、これらは複数の列ではなく、1 つの列に順番に表示されます。 |
LatLongPoint
| フィールド | |
|---|---|
kind |
リソースの種類を識別します。値: 固定文字列 |
latitude |
-90.0~+90.0 の範囲(両端を含む)の値で指定される緯度。この範囲外の値は指定できません。 |
longitude |
-180.0~+180.0 の範囲(両端を含む)で指定される経度。この範囲外の値は指定できません。 |
LinksModuleData
| フィールド | |
|---|---|
uris[] |
URI のリスト。 |
LocalizedString
| フィールド | |
|---|---|
kind |
リソースの種類を識別します。値: 固定文字列 |
translated_values[] |
文字列の翻訳が含まれます。 |
default_value |
適切な翻訳が利用できない場合に表示される文字列が含まれます。 |
Message
Valuable で表示されるメッセージ
| フィールド | |
|---|---|
kind |
リソースの種類を識別します。値: 固定文字列 |
header |
メッセージ ヘッダー。 |
body |
メッセージの本文。 |
display_interval |
メッセージがユーザーに表示される期間。メッセージごとに |
id |
メッセージに関連付けられた ID。この項目はメッセージの管理を容易にするためのものです。ID 値は、同じクラスやインスタンスの複数のメッセージで重複する可能性があります。メッセージごとに適切な ID を選択するように注意してください。 |
message_type |
メッセージのタイプ。現在、これはクーポンにのみ設定できます。 |
localized_header |
メッセージ ヘッダーの翻訳文字列。 |
localized_body |
メッセージ本文の翻訳文字列。 |
MessageType
| 列挙型 | |
|---|---|
MESSAGE_TYPE_UNSPECIFIED |
|
TEXT |
メッセージをカード情報画面にテキストとして表示します。これがデフォルトのメッセージ タイプです。 |
text |
|
EXPIRATION_NOTIFICATION |
クーポンの有効期限について表示する通知。displayInterval.start.date によって、通知が表示される時間が設定されます。有効期限の 30 日前まで設定できます。30 日より前に指定した場合は、30 日前に通知がトリガーされます。 |
expirationNotification |
|
ModifyLinkedOfferObjects
| フィールド | |
|---|---|
add_linked_offer_object_ids[] |
オブジェクトに追加するリンク済みクーポン オブジェクトの ID。 |
remove_linked_offer_object_ids[] |
オブジェクトから削除する、リンク済みクーポン オブジェクトの ID。 |
ModifyLinkedOfferObjectsRequest
| フィールド | |
|---|---|
linked_offer_object_ids |
オブジェクトに追加する、またはオブジェクトから削除するリンク済みクーポン オブジェクトの ID。 |
Money
| フィールド | |
|---|---|
kind |
リソースの種類を識別します。値: 固定文字列 |
micros |
マイクロ単位の金額。たとえば、$1 USD は 1000000 マイクロとして表されます。 |
currency_code |
通貨コード(「USD」、「EUR」など)。 |
MultipleDevicesAndHoldersAllowedStatus
| 列挙型 | |
|---|---|
STATUS_UNSPECIFIED |
|
MULTIPLE_HOLDERS |
複数のデバイス上で複数のユーザーが許可されます。 |
multipleHolders |
|
ONE_USER_ALL_DEVICES |
複数のデバイス上で 1 人のユーザーが許可されます。 |
oneUserAllDevices |
|
ONE_USER_ONE_DEVICE |
限られた状況下で一部のパートナーが使用することを想定しています。詳細については、サポートにお問い合わせください。 |
oneUserOneDevice |
|
Pagination
| フィールド | |
|---|---|
kind |
リソースの種類を識別します。値: 固定文字列 |
results_per_page |
このページで返される結果の数。 |
next_page_token |
次のページを取得するために送信するページトークン。 |
Review
| フィールド | |
|---|---|
comments |
|
ReviewStatus
| 列挙型 | |
|---|---|
REVIEW_STATUS_UNSPECIFIED |
|
UNDER_REVIEW |
|
underReview |
|
APPROVED |
|
approved |
|
REJECTED |
|
rejected |
|
DRAFT |
|
draft |
|
State
| 列挙型 | |
|---|---|
STATE_UNSPECIFIED |
|
ACTIVE |
オブジェクトはアクティブであり、他のアクティブなオブジェクトとともに表示されます。 |
active |
|
COMPLETED |
|
completed |
|
EXPIRED |
オブジェクトは有効ではなくなりました(validTimeInterval が経過しました)。 |
expired |
|
INACTIVE |
|
inactive |
|
TextModuleData
テキスト モジュールのデータ。すべてのフィールドは省略可能です。利用可能な場合はヘッダーが表示され、定義されている場合はさまざまなタイプの本文が連結されます。
| フィールド | |
|---|---|
header |
テキスト モジュールのヘッダー。小さな画面でも文字列全体が表示されるように、35 文字以下にすることをおすすめします。 |
body |
テキスト モジュールの本文。途切れのない文字列として定義されています。小さな画面でも文字列全体が表示されるように、500 文字以下にすることをおすすめします。 |
localized_header |
ヘッダーの翻訳文字列。小さな画面でも文字列全体が表示されるように、35 文字以下にすることをおすすめします。 |
localized_body |
本文の翻訳文字列。小さな画面でも文字列全体が表示されるように、500 文字以下にすることをおすすめします。 |
id |
メッセージに関連付けられた ID。このフィールドは、テキスト モジュールの管理を容易にするためのものです。 |
TimeInterval
| フィールド | |
|---|---|
kind |
リソースの種類を識別します。値: 固定文字列 |
start |
期間の開始時刻。 オフセットは省略可能です。オフセットを指定し、 |
end |
期間の終了時刻。 オフセットは省略可能です。オフセットを指定し、 |
TranslatedString
| フィールド | |
|---|---|
kind |
リソースの種類を識別します。値: 固定文字列 |
language |
BCP 47 言語タグを表します。たとえば、「en-US」、「en-GB」、「de」、「de-AT」など。 |
value |
UTF-8 でエンコードされた翻訳文字列。 |
URI
| フィールド | |
|---|---|
kind |
リソースの種類を識別します。値: 固定文字列 |
uri |
ウェブページ、画像、他のリソースの場所。 |
description |
アプリにテキストとして表示される URI のタイトル。小さな画面でも文字列全体が表示されるように、20 文字以下にすることをおすすめします。
|
localized_description |
説明の翻訳文字列。小さな画面でも文字列全体が表示されるように、20 文字以下にすることをおすすめします。 |
id |
URI に関連付けられた ID。このフィールドは URI の管理を容易にするためのものです。 |