パッケージ google.walletobjects.v1.loyalty

目次

LoyaltyClassService

AddMessage

rpc AddMessage(LoyaltyClassAddMessageRequest) returns (LoyaltyClassAddMessageResponse)

指定されたクラス ID のポイントクラスにメッセージを追加します。

認証スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/wallet_object.issuer
Get

rpc Get(LoyaltyClassGetRequest) returns (LoyaltyClass)

指定されたクラス ID のポイントクラスを返します。

認証スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/wallet_object.issuer
Insert

rpc Insert(LoyaltyClassInsertRequest) returns (LoyaltyClass)

指定された ID とプロパティのポイントクラスを挿入します。

認証スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/wallet_object.issuer
List

rpc List(LoyaltyClassListRequest) returns (LoyaltyClassListResponse)

指定された発行者 ID のすべてのポイントクラスのリストを返します。

認証スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/wallet_object.issuer
Patch

rpc Patch(LoyaltyClassPatchRequest) returns (LoyaltyClass)

指定されたクラス ID のポイントクラスを更新します。このメソッドは、パッチのセマンティクスをサポートします。

認証スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/wallet_object.issuer
Update

rpc Update(LoyaltyClassUpdateRequest) returns (LoyaltyClass)

指定されたクラス ID のポイントクラスを更新します。

認証スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/wallet_object.issuer

LoyaltyObjectService

AddMessage

rpc AddMessage(LoyaltyObjectAddMessageRequest) returns (LoyaltyObjectAddMessageResponse)

指定されたオブジェクト ID のポイント オブジェクトにメッセージを追加します。

認証スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/wallet_object.issuer
Get

rpc Get(LoyaltyObjectGetRequest) returns (LoyaltyObject)

指定されたオブジェクト ID のポイント オブジェクトを返します。

認証スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/wallet_object.issuer
Insert

rpc Insert(LoyaltyObjectInsertRequest) returns (LoyaltyObject)

指定された ID とプロパティのポイント オブジェクトを挿入します。

認証スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/wallet_object.issuer
List

rpc List(LoyaltyObjectListRequest) returns (LoyaltyObjectListResponse)

指定された発行者 ID のすべてのポイント オブジェクトのリストを返します。

認証スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/wallet_object.issuer
ModifyLinkedOfferObjects

rpc ModifyLinkedOfferObjects(LoyaltyObjectModifyLinkedOfferObjectsRequest) returns (LoyaltyObject)

指定された ID のポイント オブジェクトのリンク済みクーポン オブジェクトを修正します。

認証スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/wallet_object.issuer
Patch

rpc Patch(LoyaltyObjectPatchRequest) returns (LoyaltyObject)

指定されたオブジェクト ID のポイント オブジェクトを更新します。このメソッドは、パッチのセマンティクスをサポートします。

認証スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/wallet_object.issuer
Update

rpc Update(LoyaltyObjectUpdateRequest) returns (LoyaltyObject)

指定されたオブジェクト ID のポイント オブジェクトを更新します。

認証スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/wallet_object.issuer

LoyaltyClass

フィールド
kind
(deprecated)

string

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

string

必須。プログラム名（「Adam's Apparel」など）。小さな画面でも文字列全体が表示されるように、アプリで最初の 20 文字の後に省略記号を表示できます。
account_name_label

string

アカウント名のラベル（「会員名」など）。小さな画面でも文字列全体が表示されるように、15 文字以下にすることをおすすめします。
account_id_label

string

アカウント ID ラベル（「会員 ID」など）。小さな画面でも文字列全体が表示されるように、15 文字以下にすることをおすすめします。
rewards_tier_label

string

特典階層のラベル（「特典階層」など）。小さな画面でも文字列全体が表示されるように、9 文字以下にすることをおすすめします。
rewards_tier

string

特典階層（「ゴールド」、「プラチナ」など）。小さな画面でも文字列全体が表示されるように、7 文字以下にすることをおすすめします。
localized_program_name

LocalizedString

program_name の翻訳文字列。小さな画面でも文字列全体が表示されるように、アプリで最初の 20 文字の後に省略記号を表示できます。
localized_account_name_label

LocalizedString

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

LocalizedString

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

LocalizedString

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

LocalizedString

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

string

特典のサブ階層のラベル（「特典階層」など）。
localized_secondary_rewards_tier_label

LocalizedString

secondary_rewards_tier_label の翻訳文字列。
secondary_rewards_tier

string

特典のサブ階層（「ゴールド」、「プラチナ」など）。
localized_secondary_rewards_tier

LocalizedString

secondary_rewards_tier の翻訳文字列。
discoverable_program

DiscoverableProgram

Google Pay アプリ内でクラスが検出され、インスタンス化される方法。
class_template_info

ClassTemplateInfo

クラスの表示方法に関するテンプレート情報。設定しない場合、デフォルトの表示フィールドになります。
id

string

必須。クラスの一意識別子。この ID は、発行者のすべてのクラスに対して、一意である必要があります。この値には issuer ID.identifier の形式を使用する必要があります。前の部分は Google が発行するものであり、後の部分はご自身で選択するものです。一意識別子には、英数字、「.」、「_」、「-」のみを使用できます。
version
(deprecated)

int64

非推奨
issuer_name

string

必須。発行者の名前。小さな画面でも文字列全体が表示されるように、20 文字以下にすることをおすすめします。
messages[]

Message

アプリに表示されるメッセージの配列。このオブジェクトのすべてのユーザーが、関連するメッセージを受信します。このフィールドの最大数は 10 です。
allow_multiple_users_per_object
(deprecated)

bool

非推奨。代わりに multipleDevicesAndHoldersAllowedStatus を使用してください。
homepage_uri

Uri

アプリケーションのホームページの URI。このフィールドに URI を指定したときの動作は、linksModuleData に URI を指定したときの動作とまったく同じです（オブジェクトがレンダリングされると、通常はそのオブジェクトの linksModuleData セクションと考えられる場所にホームページのリンクが表示されます）。
locations[]

LatLongPoint

オブジェクトを使用できる場所のリスト。この情報は、位置情報の通知をトリガーするために使用されます。オブジェクト内の場所、クラス内の場所、Google プレイス ID の場所の順に優先されます。
review_status

ReviewStatus

必須。クラスのステータス。Insert / patch / update API 呼び出しを使用して draft または underReview に設定することもできます。レビュー ステータスが draft から変更されると、その後 draft に戻すことはできません。

クラスが開発中の場合は、このフィールドを draft のままにしてください。draft クラスはオブジェクトの作成には使用できません。

クラス使用の準備が整ったら、このフィールドを underReview に設定する必要があります。プラットフォームはこのフィールドを自動的に approved に設定し、オブジェクトの作成と移行にすぐに利用できるようにします。

すでに approved とマークされたクラスを更新する場合、このフィールドを underReview に設定しておく必要があります。
review

Review

クラスが approved または rejected とマークされたときにプラットフォームによって設定されるレビュー コメント。
info_module_data
(deprecated)

InfoModuleData

非推奨。代わりに textModulesData を使用してください。
image_modules_data[]

ImageModuleData

画像モジュールのデータ。このフィールドが表示される数には上限があり、オブジェクト レベルから 1 個、クラス オブジェクト レベルでは 1 個が最大数になります。
text_modules_data[]

TextModuleData

テキスト モジュールのデータ。テキスト モジュールのデータがクラスにも定義されている場合、両方が表示されます。このフィールドが表示される数には上限があり、オブジェクトから 10 個、クラスから 10 個が最大数になります。
redemption_issuers[]

int64

スマートタップ対応のパートナーのみが利用できます。詳細については、サポートにお問い合わせください。
country_code

string

カードの国を表示するために使用される国コード（ユーザーがその国にいない場合）。あるいは、ユーザーのロケールでコンテンツが利用できない場合にローカライズされたコンテンツを表示するために使用される国コード。
hero_image

Image

カードの表面に表示されるオプションのバナー画像。バナー画像がない場合は、何も表示されません。画像は 100% の幅で表示されます。
word_mark
(deprecated)

Image

非推奨。
enable_smart_tap

bool

スマートタップ対応のパートナーのみが利用できます。詳細については、サポートにお問い合わせください。
hex_background_color

string

カードの背景色。設定されていない場合は、ヒーロー画像の主要色が使用され、ヒーロー画像が設定されていない場合は、ロゴの主要色が使用されます。形式は #rrggbb です（#ffcc00 など）。rrggbb は 16 進数の RGB トリプレットです。#fc0 など、RGB トリプレットの省略形 #rgb も使用できます。
localized_issuer_name

LocalizedString

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

MultipleDevicesAndHoldersAllowedStatus

複数のユーザーやデバイスについて、このクラスを参照する同じオブジェクトを保存しているかどうかを示します。
callback_options

CallbackOptions

コールバック オプション。エンドユーザーがこのクラスのオブジェクトを保存または削除するたびに発行者をコールバックするために使用します。このクラスのすべてのオブジェクトは、コールバックの対象となります。

LoyaltyClassAddMessageRequest

フィールド
resource_id

string

クラスの一意識別子。この ID は、発行者のすべてのクラスに対して、一意である必要があります。この値には issuer ID.identifier の形式を使用する必要があります。前の部分は Google が発行するものであり、後の部分はご自身で選択するものです。一意識別子には、英数字、「.」、「_」、「-」のみを使用できます。
add_message_request

AddMessageRequest

リクエストの本文。

LoyaltyClassAddMessageResponse

フィールド
resource

LoyaltyClass

更新された LoyaltyClass リソース。

LoyaltyClassGetRequest

フィールド
resource_id

string

クラスの一意識別子。この ID は、発行者のすべてのクラスに対して、一意である必要があります。この値には issuer ID.identifier の形式を使用する必要があります。前の部分は Google が発行するものであり、後の部分はご自身で選択するものです。一意識別子には、英数字、「.」、「_」、「-」のみを使用できます。

LoyaltyClassInsertRequest

フィールド
resource

LoyaltyClass

リクエストの本文。

LoyaltyClassListRequest

フィールド
issuer_id

int64

クラスをリストする権限を持つ発行者の ID。
token

string

maxResults が指定されているが、maxResults より多数のクラスがリストに含まれる場合に、次の結果を取得するために使用します。たとえば、200 個のクラスを含むリストがあり、maxResults を 20 に設定してリストを呼び出した場合、リストからは最初の 20 個のクラスとトークンが返されます。次の 20 個のクラスを取得するには、maxResults を 20 に設定し、このトークンを指定して再度リストを呼び出します。
max_results

int32

リストから返される結果の最大数を示します。maxResults が定義されない場合は、すべての結果が返されます。

LoyaltyClassListResponse

フィールド
resources[]

LoyaltyClass

リスト リクエストに対応するリソース。
pagination

Pagination

レスポンスのページ分け。

LoyaltyClassPatchRequest

フィールド
resource_id

string

クラスの一意識別子。この ID は、発行者のすべてのクラスに対して、一意である必要があります。この値には issuer ID.identifier の形式を使用する必要があります。前の部分は Google が発行するものであり、後の部分はご自身で選択するものです。一意識別子には、英数字、「.」、「_」、「-」のみを使用できます。
resource

LoyaltyClass

リクエストの本文。

LoyaltyClassUpdateRequest

フィールド
resource_id

string

クラスの一意識別子。この ID は、発行者のすべてのクラスに対して、一意である必要があります。この値には issuer ID.identifier の形式を使用する必要があります。前の部分は Google が発行するものであり、後の部分はご自身で選択するものです。一意識別子には、英数字、「.」、「_」、「-」のみを使用できます。
resource

LoyaltyClass

リクエストの本文。

LoyaltyObject

フィールド
kind
(deprecated)

string

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

LoyaltyClass

親クラスの継承されたフィールドのコピー。このフィールドは、GET 中に取得されます。
account_name

string

ポイント プログラムのアカウント所有者の名前（「John Smith」など）。小さな画面でも文字列全体が表示されるように、20 文字以下にすることをおすすめします。
account_id

string

ポイント プログラムのアカウントの識別子。20 文字以下にすることをおすすめします。
loyalty_points

LoyaltyPoints

特典ポイントのラベル、保有ポイント数、タイプ。
linked_offer_ids[]

string

このポイントカードにリンクされているクーポン オブジェクトのリスト。クーポン オブジェクトがすでに存在している必要があります。

クーポン オブジェクト ID には issuer ID.identifier の形式を使用する必要があります。前の部分は Google が発行するものであり、後の部分はご自身で選択するものです。
secondary_loyalty_points

LoyaltyPoints

予備の特典ポイントのラベル、保有ポイント数、タイプ。一次的なポイントに加えて表示されます。
id

string

必須。オブジェクトの一意識別子。この ID は、発行者のすべてのオブジェクトに対して、一意である必要があります。この値には issuer ID.identifier の形式を使用する必要があります。前の部分は Google が発行するものであり、後の部分はご自身で選択するものです。一意識別子には、英数字、「.」、「_」、「-」のみを使用できます。
class_id

string

必須。このオブジェクトに関連付けられたクラス。クラスはこのオブジェクトと同じ型で、すでに存在し、承認される必要があります。

クラス ID には、issuer ID.identifier の形式を使用する必要があります。前の部分は Google が発行するものであり、後の部分はご自身で選択するものです。
version
(deprecated)

int64

非推奨
state

State

必須。オブジェクトの状態。このフィールドは、アプリでのオブジェクトの表示方法を決定するために使用されます。たとえば、inactive オブジェクトを「期限切れのパス」セクションに移動する場合に使用します。
barcode

Barcode

バーコードのタイプと値。
messages[]

Message

アプリに表示されるメッセージの配列。このオブジェクトのすべてのユーザーが、関連するメッセージを受信します。このフィールドの最大数は 10 です。
valid_time_interval

TimeInterval

このオブジェクトが active になり、オブジェクトが使用可能である期間。この期間が経過すると、オブジェクトの状態は expired に変更されます。
locations[]

LatLongPoint

オブジェクトを使用できる場所のリスト。この情報は、位置情報の通知をトリガーするために使用されます。オブジェクト内の場所、クラス内の場所、Google プレイス ID の場所の順に優先されます。
has_users

bool

オブジェクトにユーザーが存在するかどうかを示します。このフィールドはプラットフォームによって設定されます。
smart_tap_redemption_value

string

スマートタップ対応のパートナーのみが利用できます。詳細については、サポートにお問い合わせください。
has_linked_device

bool

このオブジェクトが現在 1 つのデバイスにリンクされているかどうか。このフィールドは、ユーザーがオブジェクトを保存し、オブジェクトがデバイスにリンクされているときに、プラットフォームによって設定されます。一部のパートナーが使用することを想定しています。詳細については、サポートにお問い合わせください。
disable_expiration_notification

bool

通知を明示的に止めるかどうかを示します。このフィールドが true に設定されている場合、messages フィールドに関係なく、ユーザーへの有効期限通知が抑制されます。このフィールドはデフォルトで false に設定されています。

現在、これはクーポンにのみ設定できます。
info_module_data

InfoModuleData

非推奨。代わりに textModulesData を使用してください。
image_modules_data[]

ImageModuleData

画像モジュールのデータ。このフィールドが表示される数には上限があり、オブジェクト レベルから 1 個、クラス オブジェクト レベルでは 1 個が最大数になります。
text_modules_data[]

TextModuleData

テキスト モジュールのデータ。テキスト モジュールのデータがクラスにも定義されている場合、両方が表示されます。このフィールドが表示される数には上限があり、オブジェクトから 10 個、クラスから 10 個が最大数になります。

LoyaltyObjectAddMessageRequest

フィールド
resource_id

string

オブジェクトの一意識別子。この ID は、発行者のすべてのオブジェクトに対して、一意である必要があります。この値には issuer ID.identifier の形式を使用する必要があります。前の部分は Google が発行するものであり、後の部分はご自身で選択するものです。一意識別子には、英数字、「.」、「_」、「-」のみを使用できます。
add_message_request

AddMessageRequest

リクエストの本文。

LoyaltyObjectAddMessageResponse

フィールド
resource

LoyaltyObject

更新された LoyaltyObject リソース。

LoyaltyObjectGetRequest

フィールド
resource_id

string

オブジェクトの一意識別子。この ID は、発行者のすべてのオブジェクトに対して、一意である必要があります。この値には issuer ID.identifier の形式を使用する必要があります。前の部分は Google が発行するものであり、後の部分はご自身で選択するものです。一意識別子には、英数字、「.」、「_」、「-」のみを使用できます。

LoyaltyObjectInsertRequest

フィールド
resource

LoyaltyObject

リクエストの本文。

LoyaltyObjectListRequest

フィールド
class_id

string

オブジェクトがリストされるクラスの ID。
token

string

maxResults が指定されているが、maxResults より多数のオブジェクトがリストに含まれる場合に、次の結果を取得するために使用します。たとえば、200 個のオブジェクトを含むリストがあり、maxResults を 20 に設定してリストを呼び出した場合、リストからは最初の 20 個のオブジェクトとトークンが返されます。次の 20 個のオブジェクトを取得するには、maxResults を 20 に設定し、このトークンを指定して再度リストを呼び出します。
max_results

int32

リストから返される結果の最大数を示します。maxResults が定義されない場合は、すべての結果が返されます。

LoyaltyObjectListResponse

フィールド
resources[]

LoyaltyObject

リスト リクエストに対応するリソース。
pagination

Pagination

レスポンスのページ分け。

LoyaltyObjectModifyLinkedOfferObjectsRequest

フィールド
resource_id

string

オブジェクトの一意識別子。この ID は、発行者のすべてのオブジェクトに対して、一意である必要があります。この値には issuer ID.identifier の形式を使用する必要があります。前の部分は Google が発行するものであり、後の部分はご自身で選択するものです。一意識別子には、英数字、「.」、「_」、「-」のみを使用できます。
modify_linked_offer_objects_request

ModifyLinkedOfferObjectsRequest

ポイント オブジェクトのクーポン オブジェクト ID。

LoyaltyObjectPatchRequest

フィールド
resource_id

string

オブジェクトの一意識別子。この ID は、発行者のすべてのオブジェクトに対して、一意である必要があります。この値には issuer ID.identifier の形式を使用する必要があります。前の部分は Google が発行するものであり、後の部分はご自身で選択するものです。一意識別子には、英数字、「.」、「_」、「-」のみを使用できます。
resource

LoyaltyObject

リクエストの本文。

LoyaltyObjectUpdateRequest

フィールド
resource_id

string

オブジェクトの一意識別子。この ID は、発行者のすべてのオブジェクトに対して、一意である必要があります。この値には issuer ID.identifier の形式を使用する必要があります。前の部分は Google が発行するものであり、後の部分はご自身で選択するものです。一意識別子には、英数字、「.」、「_」、「-」のみを使用できます。
resource

LoyaltyObject

リクエストの本文。

LoyaltyPoints

フィールド
label

string

ポイントのラベル（「ポイント」など）。9 文字以下にすることをおすすめします。
balance

LoyaltyPointsBalance

アカウント所有者の保有ポイント数（「500」や「$10.00」など）。7 文字以下にすることをおすすめします。これは、loyaltyPoints と secondaryLoyaltyPoints の必須フィールドです。
localized_label

LocalizedString

ラベルの翻訳文字列。9 文字以下にすることをおすすめします。

LoyaltyPointsBalance

フィールド
string

string

文字列型の保有ポイント数。値は、これらのサブタイプ（string、int、double、money）のいずれかに設定する必要があります。
int

int32

整数型の保有ポイント数。値は、これらのサブタイプ（string、int、double、money）のいずれかに設定する必要があります。
double

double

ダブル型の保有ポイント数。値は、これらのサブタイプ（string、int、double、money）のいずれかに設定する必要があります。
money

Money

通貨型の保有ポイント数。値は、これらのサブタイプ（string、int、double、money）のいずれかに設定する必要があります。