目次
LoyaltyClassService
(インターフェース)LoyaltyObjectService
(インターフェース)LoyaltyClass
(メッセージ)LoyaltyClassAddMessageRequest
(メッセージ)LoyaltyClassAddMessageResponse
(メッセージ)LoyaltyClassGetRequest
(メッセージ)LoyaltyClassInsertRequest
(メッセージ)LoyaltyClassListRequest
(メッセージ)LoyaltyClassListResponse
(メッセージ)LoyaltyClassPatchRequest
(メッセージ)LoyaltyClassUpdateRequest
(メッセージ)LoyaltyObject
(メッセージ)LoyaltyObjectAddMessageRequest
(メッセージ)LoyaltyObjectAddMessageResponse
(メッセージ)LoyaltyObjectGetRequest
(メッセージ)LoyaltyObjectInsertRequest
(メッセージ)LoyaltyObjectListRequest
(メッセージ)LoyaltyObjectListResponse
(メッセージ)LoyaltyObjectModifyLinkedOfferObjectsRequest
(メッセージ)LoyaltyObjectPatchRequest
(メッセージ)LoyaltyObjectUpdateRequest
(メッセージ)LoyaltyPoints
(メッセージ)LoyaltyPointsBalance
(メッセージ)
LoyaltyClassService
AddMessage | |
---|---|
指定されたクラス ID のポイントクラスにメッセージを追加します。
|
Get | |
---|---|
指定されたクラス ID のポイントクラスを返します。
|
Insert | |
---|---|
指定された ID とプロパティのポイントクラスを挿入します。
|
List | |
---|---|
指定された発行者 ID のすべてのポイントクラスのリストを返します。
|
Patch | |
---|---|
指定されたクラス ID のポイントクラスを更新します。このメソッドは、パッチのセマンティクスをサポートします。
|
Update | |
---|---|
指定されたクラス ID のポイントクラスを更新します。
|
LoyaltyObjectService
AddMessage | |
---|---|
指定されたオブジェクト ID のポイント オブジェクトにメッセージを追加します。
|
Get | |
---|---|
指定されたオブジェクト ID のポイント オブジェクトを返します。
|
Insert | |
---|---|
指定された ID とプロパティのポイント オブジェクトを挿入します。
|
List | |
---|---|
指定された発行者 ID のすべてのポイント オブジェクトのリストを返します。
|
ModifyLinkedOfferObjects | |
---|---|
指定された ID のポイント オブジェクトのリンク済みクーポン オブジェクトを修正します。
|
Patch | |
---|---|
指定されたオブジェクト ID のポイント オブジェクトを更新します。このメソッドは、パッチのセマンティクスをサポートします。
|
Update | |
---|---|
指定されたオブジェクト ID のポイント オブジェクトを更新します。
|
LoyaltyClass
フィールド | |
---|---|
kind |
リソースの種類を識別します。値: 固定文字列 |
program_name |
必須。プログラム名(「Adam's Apparel」など)。小さな画面でも文字列全体が表示されるように、アプリで最初の 20 文字の後に省略記号を表示できます。 |
program_logo |
必須。ポイント プログラムまたは会社のロゴ。このロゴは、アプリの詳細ビューとリストビューの両方に表示されます。 |
account_name_label |
アカウント名のラベル(「会員名」など)。小さな画面でも文字列全体が表示されるように、15 文字以下にすることをおすすめします。 |
account_id_label |
アカウント ID ラベル(「会員 ID」など)。小さな画面でも文字列全体が表示されるように、15 文字以下にすることをおすすめします。 |
rewards_tier_label |
特典階層のラベル(「特典階層」など)。小さな画面でも文字列全体が表示されるように、9 文字以下にすることをおすすめします。 |
rewards_tier |
特典階層(「ゴールド」、「プラチナ」など)。小さな画面でも文字列全体が表示されるように、7 文字以下にすることをおすすめします。 |
localized_program_name |
program_name の翻訳文字列。小さな画面でも文字列全体が表示されるように、アプリで最初の 20 文字の後に省略記号を表示できます。 |
localized_account_name_label |
account_name_label の翻訳文字列。小さな画面でも文字列全体が表示されるように、15 文字以下にすることをおすすめします。 |
localized_account_id_label |
account_id_label の翻訳文字列。小さな画面でも文字列全体が表示されるように、15 文字以下にすることをおすすめします。 |
localized_rewards_tier_label |
rewards_tier_label の翻訳文字列。小さな画面でも文字列全体が表示されるように、9 文字以下にすることをおすすめします。 |
localized_rewards_tier |
rewards_tier の翻訳文字列。小さな画面でも文字列全体が表示されるように、7 文字以下にすることをおすすめします。 |
secondary_rewards_tier_label |
特典のサブ階層のラベル(「特典階層」など)。 |
localized_secondary_rewards_tier_label |
secondary_rewards_tier_label の翻訳文字列。 |
secondary_rewards_tier |
特典のサブ階層(「ゴールド」、「プラチナ」など)。 |
localized_secondary_rewards_tier |
secondary_rewards_tier の翻訳文字列。 |
discoverable_program |
Google Pay アプリ内でクラスが検出され、インスタンス化される方法。 |
class_template_info |
クラスの表示方法に関するテンプレート情報。設定しない場合、デフォルトの表示フィールドになります。 |
id |
必須。クラスの一意識別子。この ID は、発行者のすべてのクラスに対して、一意である必要があります。この値には issuer ID.identifier の形式を使用する必要があります。前の部分は Google が発行するものであり、後の部分はご自身で選択するものです。一意識別子には、英数字、「.」、「_」、「-」のみを使用できます。 |
version |
非推奨 |
issuer_name |
必須。発行者の名前。小さな画面でも文字列全体が表示されるように、20 文字以下にすることをおすすめします。 |
messages[] |
アプリに表示されるメッセージの配列。このオブジェクトのすべてのユーザーが、関連するメッセージを受信します。このフィールドの最大数は 10 です。 |
allow_multiple_users_per_object |
非推奨。代わりに |
homepage_uri |
アプリケーションのホームページの URI。このフィールドに URI を指定したときの動作は、linksModuleData に URI を指定したときの動作とまったく同じです(オブジェクトがレンダリングされると、通常はそのオブジェクトの linksModuleData セクションと考えられる場所にホームページのリンクが表示されます)。 |
locations[] |
オブジェクトを使用できる場所のリスト。この情報は、位置情報の通知をトリガーするために使用されます。オブジェクト内の場所、クラス内の場所、Google プレイス ID の場所の順に優先されます。 |
review_status |
必須。クラスのステータス。Insert / patch / update API 呼び出しを使用して クラスが開発中の場合は、このフィールドを クラス使用の準備が整ったら、このフィールドを すでに |
review |
クラスが |
info_module_data |
非推奨。代わりに textModulesData を使用してください。 |
image_modules_data[] |
画像モジュールのデータ。このフィールドが表示される数には上限があり、オブジェクト レベルから 1 個、クラス オブジェクト レベルでは 1 個が最大数になります。 |
text_modules_data[] |
テキスト モジュールのデータ。テキスト モジュールのデータがクラスにも定義されている場合、両方が表示されます。このフィールドが表示される数には上限があり、オブジェクトから 10 個、クラスから 10 個が最大数になります。 |
links_module_data |
リンク モジュールのデータ。リンク モジュールのデータがオブジェクトにも定義されている場合、両方が表示されます。 |
redemption_issuers[] |
スマートタップ対応のパートナーのみが利用できます。詳細については、サポートにお問い合わせください。 |
country_code |
カードの国を表示するために使用される国コード(ユーザーがその国にいない場合)。あるいは、ユーザーのロケールでコンテンツが利用できない場合にローカライズされたコンテンツを表示するために使用される国コード。 |
hero_image |
カードの表面に表示されるオプションのバナー画像。バナー画像がない場合は、何も表示されません。画像は 100% の幅で表示されます。 |
word_mark |
非推奨。 |
enable_smart_tap |
スマートタップ対応のパートナーのみが利用できます。詳細については、サポートにお問い合わせください。 |
hex_background_color |
カードの背景色。設定されていない場合は、ヒーロー画像の主要色が使用され、ヒーロー画像が設定されていない場合は、ロゴの主要色が使用されます。形式は #rrggbb です( |
localized_issuer_name |
issuer_name の翻訳文字列。小さな画面でも文字列全体が表示されるように、20 文字以下にすることをおすすめします。 |
multiple_devices_and_holders_allowed_status |
複数のユーザーやデバイスについて、このクラスを参照する同じオブジェクトを保存しているかどうかを示します。 |
callback_options |
コールバック オプション。エンドユーザーがこのクラスのオブジェクトを保存または削除するたびに発行者をコールバックするために使用します。このクラスのすべてのオブジェクトは、コールバックの対象となります。 |
LoyaltyClassAddMessageRequest
フィールド | |
---|---|
resource_id |
クラスの一意識別子。この ID は、発行者のすべてのクラスに対して、一意である必要があります。この値には issuer ID.identifier の形式を使用する必要があります。前の部分は Google が発行するものであり、後の部分はご自身で選択するものです。一意識別子には、英数字、「.」、「_」、「-」のみを使用できます。 |
add_message_request |
リクエストの本文。 |
LoyaltyClassAddMessageResponse
フィールド | |
---|---|
resource |
更新された LoyaltyClass リソース。 |
LoyaltyClassGetRequest
フィールド | |
---|---|
resource_id |
クラスの一意識別子。この ID は、発行者のすべてのクラスに対して、一意である必要があります。この値には issuer ID.identifier の形式を使用する必要があります。前の部分は Google が発行するものであり、後の部分はご自身で選択するものです。一意識別子には、英数字、「.」、「_」、「-」のみを使用できます。 |
LoyaltyClassInsertRequest
フィールド | |
---|---|
resource |
リクエストの本文。 |
LoyaltyClassListRequest
フィールド | |
---|---|
issuer_id |
クラスをリストする権限を持つ発行者の ID。 |
token |
|
max_results |
リストから返される結果の最大数を示します。 |
LoyaltyClassListResponse
フィールド | |
---|---|
resources[] |
リスト リクエストに対応するリソース。 |
pagination |
レスポンスのページ分け。 |
LoyaltyClassPatchRequest
フィールド | |
---|---|
resource_id |
クラスの一意識別子。この ID は、発行者のすべてのクラスに対して、一意である必要があります。この値には issuer ID.identifier の形式を使用する必要があります。前の部分は Google が発行するものであり、後の部分はご自身で選択するものです。一意識別子には、英数字、「.」、「_」、「-」のみを使用できます。 |
resource |
リクエストの本文。 |
LoyaltyClassUpdateRequest
フィールド | |
---|---|
resource_id |
クラスの一意識別子。この ID は、発行者のすべてのクラスに対して、一意である必要があります。この値には issuer ID.identifier の形式を使用する必要があります。前の部分は Google が発行するものであり、後の部分はご自身で選択するものです。一意識別子には、英数字、「.」、「_」、「-」のみを使用できます。 |
resource |
リクエストの本文。 |
LoyaltyObject
フィールド | |
---|---|
kind |
リソースの種類を識別します。値: 固定文字列 |
class_reference |
親クラスの継承されたフィールドのコピー。このフィールドは、GET 中に取得されます。 |
account_name |
ポイント プログラムのアカウント所有者の名前(「John Smith」など)。小さな画面でも文字列全体が表示されるように、20 文字以下にすることをおすすめします。 |
account_id |
ポイント プログラムのアカウントの識別子。20 文字以下にすることをおすすめします。 |
loyalty_points |
特典ポイントのラベル、保有ポイント数、タイプ。 |
linked_offer_ids[] |
このポイントカードにリンクされているクーポン オブジェクトのリスト。クーポン オブジェクトがすでに存在している必要があります。 クーポン オブジェクト ID には issuer ID.identifier の形式を使用する必要があります。前の部分は Google が発行するものであり、後の部分はご自身で選択するものです。 |
secondary_loyalty_points |
予備の特典ポイントのラベル、保有ポイント数、タイプ。一次的なポイントに加えて表示されます。 |
id |
必須。オブジェクトの一意識別子。この ID は、発行者のすべてのオブジェクトに対して、一意である必要があります。この値には issuer ID.identifier の形式を使用する必要があります。前の部分は Google が発行するものであり、後の部分はご自身で選択するものです。一意識別子には、英数字、「.」、「_」、「-」のみを使用できます。 |
class_id |
必須。このオブジェクトに関連付けられたクラス。クラスはこのオブジェクトと同じ型で、すでに存在し、承認される必要があります。 クラス ID には、issuer ID.identifier の形式を使用する必要があります。前の部分は Google が発行するものであり、後の部分はご自身で選択するものです。 |
version |
非推奨 |
state |
必須。オブジェクトの状態。このフィールドは、アプリでのオブジェクトの表示方法を決定するために使用されます。たとえば、 |
barcode |
バーコードのタイプと値。 |
messages[] |
アプリに表示されるメッセージの配列。このオブジェクトのすべてのユーザーが、関連するメッセージを受信します。このフィールドの最大数は 10 です。 |
valid_time_interval |
このオブジェクトが |
locations[] |
オブジェクトを使用できる場所のリスト。この情報は、位置情報の通知をトリガーするために使用されます。オブジェクト内の場所、クラス内の場所、Google プレイス ID の場所の順に優先されます。 |
has_users |
オブジェクトにユーザーが存在するかどうかを示します。このフィールドはプラットフォームによって設定されます。 |
smart_tap_redemption_value |
スマートタップ対応のパートナーのみが利用できます。詳細については、サポートにお問い合わせください。 |
has_linked_device |
このオブジェクトが現在 1 つのデバイスにリンクされているかどうか。このフィールドは、ユーザーがオブジェクトを保存し、オブジェクトがデバイスにリンクされているときに、プラットフォームによって設定されます。一部のパートナーが使用することを想定しています。詳細については、サポートにお問い合わせください。 |
disable_expiration_notification |
通知を明示的に止めるかどうかを示します。このフィールドが true に設定されている場合、 現在、これはクーポンにのみ設定できます。 |
info_module_data |
非推奨。代わりに textModulesData を使用してください。 |
image_modules_data[] |
画像モジュールのデータ。このフィールドが表示される数には上限があり、オブジェクト レベルから 1 個、クラス オブジェクト レベルでは 1 個が最大数になります。 |
text_modules_data[] |
テキスト モジュールのデータ。テキスト モジュールのデータがクラスにも定義されている場合、両方が表示されます。このフィールドが表示される数には上限があり、オブジェクトから 10 個、クラスから 10 個が最大数になります。 |
links_module_data |
リンク モジュールのデータ。リンク モジュールのデータがクラスにも定義されている場合、両方が表示されます。 |
app_link_data |
パートナー アプリリンクに関する補足情報。 |
LoyaltyObjectAddMessageRequest
フィールド | |
---|---|
resource_id |
オブジェクトの一意識別子。この ID は、発行者のすべてのオブジェクトに対して、一意である必要があります。この値には issuer ID.identifier の形式を使用する必要があります。前の部分は Google が発行するものであり、後の部分はご自身で選択するものです。一意識別子には、英数字、「.」、「_」、「-」のみを使用できます。 |
add_message_request |
リクエストの本文。 |
LoyaltyObjectAddMessageResponse
フィールド | |
---|---|
resource |
更新された LoyaltyObject リソース。 |
LoyaltyObjectGetRequest
フィールド | |
---|---|
resource_id |
オブジェクトの一意識別子。この ID は、発行者のすべてのオブジェクトに対して、一意である必要があります。この値には issuer ID.identifier の形式を使用する必要があります。前の部分は Google が発行するものであり、後の部分はご自身で選択するものです。一意識別子には、英数字、「.」、「_」、「-」のみを使用できます。 |
LoyaltyObjectInsertRequest
フィールド | |
---|---|
resource |
リクエストの本文。 |
LoyaltyObjectListRequest
フィールド | |
---|---|
class_id |
オブジェクトがリストされるクラスの ID。 |
token |
|
max_results |
リストから返される結果の最大数を示します。 |
LoyaltyObjectListResponse
フィールド | |
---|---|
resources[] |
リスト リクエストに対応するリソース。 |
pagination |
レスポンスのページ分け。 |
LoyaltyObjectModifyLinkedOfferObjectsRequest
フィールド | |
---|---|
resource_id |
オブジェクトの一意識別子。この ID は、発行者のすべてのオブジェクトに対して、一意である必要があります。この値には issuer ID.identifier の形式を使用する必要があります。前の部分は Google が発行するものであり、後の部分はご自身で選択するものです。一意識別子には、英数字、「.」、「_」、「-」のみを使用できます。 |
modify_linked_offer_objects_request |
ポイント オブジェクトのクーポン オブジェクト ID。 |
LoyaltyObjectPatchRequest
フィールド | |
---|---|
resource_id |
オブジェクトの一意識別子。この ID は、発行者のすべてのオブジェクトに対して、一意である必要があります。この値には issuer ID.identifier の形式を使用する必要があります。前の部分は Google が発行するものであり、後の部分はご自身で選択するものです。一意識別子には、英数字、「.」、「_」、「-」のみを使用できます。 |
resource |
リクエストの本文。 |
LoyaltyObjectUpdateRequest
フィールド | |
---|---|
resource_id |
オブジェクトの一意識別子。この ID は、発行者のすべてのオブジェクトに対して、一意である必要があります。この値には issuer ID.identifier の形式を使用する必要があります。前の部分は Google が発行するものであり、後の部分はご自身で選択するものです。一意識別子には、英数字、「.」、「_」、「-」のみを使用できます。 |
resource |
リクエストの本文。 |
LoyaltyPoints
フィールド | |
---|---|
label |
ポイントのラベル(「ポイント」など)。9 文字以下にすることをおすすめします。 |
balance |
アカウント所有者の保有ポイント数(「500」や「$10.00」など)。7 文字以下にすることをおすすめします。これは、 |
localized_label |
ラベルの翻訳文字列。9 文字以下にすることをおすすめします。 |
LoyaltyPointsBalance
フィールド | |
---|---|
string |
文字列型の保有ポイント数。値は、これらのサブタイプ(string、int、double、money)のいずれかに設定する必要があります。 |
int |
整数型の保有ポイント数。値は、これらのサブタイプ(string、int、double、money)のいずれかに設定する必要があります。 |
double |
ダブル型の保有ポイント数。値は、これらのサブタイプ(string、int、double、money)のいずれかに設定する必要があります。 |
money |
通貨型の保有ポイント数。値は、これらのサブタイプ(string、int、double、money)のいずれかに設定する必要があります。 |