Package google.walletobjects.v1.giftcard

インデックス

GiftCardClassService

AddMessage

rpc AddMessage(GiftCardClassAddMessageRequest) returns (GiftCardClassAddMessageResponse)

指定されたクラス ID のギフトカード クラスにメッセージを追加します。

承認スコープ

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

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

rpc Get(GiftCardClassGetRequest) returns (GiftCardClass)

指定されたクラス ID のギフトカード クラスを返します。

承認スコープ

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

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

rpc Insert(GiftCardClassInsertRequest) returns (GiftCardClass)

指定された ID とプロパティのギフトカード クラスを挿入します。

承認スコープ

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

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

rpc List(GiftCardClassListRequest) returns (GiftCardClassListResponse)

指定された発行者 ID のすべてのギフトカード クラスのリストを返します。

承認スコープ

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

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

rpc Patch(GiftCardClassPatchRequest) returns (GiftCardClass)

指定されたクラス ID のギフトカード クラスを更新します。このメソッドは、パッチの動作をサポートします。

承認スコープ

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

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

rpc Update(GiftCardClassUpdateRequest) returns (GiftCardClass)

指定されたクラス ID のギフトカード クラスを更新します。

承認スコープ

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

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

GiftCardObjectService

AddMessage

rpc AddMessage(GiftCardObjectAddMessageRequest) returns (GiftCardObjectAddMessageResponse)

指定されたオブジェクト ID のギフトカード オブジェクトにメッセージを追加します。

承認スコープ

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

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

rpc Get(GiftCardObjectGetRequest) returns (GiftCardObject)

指定されたオブジェクト ID のギフトカード オブジェクトを返します。

承認スコープ

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

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

rpc Insert(GiftCardObjectInsertRequest) returns (GiftCardObject)

指定された ID とプロパティのギフトカード オブジェクトを挿入します。

承認スコープ

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

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

rpc List(GiftCardObjectListRequest) returns (GiftCardObjectListResponse)

指定された発行者 ID のすべてのギフトカード オブジェクトのリストを返します。

承認スコープ

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

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

rpc Patch(GiftCardObjectPatchRequest) returns (GiftCardObject)

指定されたオブジェクト ID のギフトカード オブジェクトを更新します。このメソッドは、パッチの動作をサポートします。

承認スコープ

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

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

rpc Update(GiftCardObjectUpdateRequest) returns (GiftCardObject)

指定されたオブジェクト ID のギフトカード オブジェクトを更新します。

承認スコープ

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

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

GiftCardClass

フィールド
kind
(deprecated)

string

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

string

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

string

PIN について表示するラベル（「4 桁の PIN」など）。
event_number_label

string

イベント番号について表示するラベル（「対象イベント #」など）。
allow_barcode_redemption

bool

バーコードを使用したギフトカードの利用をサポートするかどうかを決定します。true の場合、アプリでギフトカード情報画面にギフトカードのバーコードが表示されます。false の場合、バーコードは表示されません。
localized_merchant_name

LocalizedString

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

LocalizedString

pin_label の翻訳文字列。
localized_event_number_label

LocalizedString

event_number_label の翻訳文字列。
card_number_label

string

カード番号に表示するラベル（「カード番号」など）。
localized_card_number_label

LocalizedString

card_number_label の翻訳文字列。
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

必須。クラスのステータス。挿入、パッチ、更新の 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

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

GiftCardClassAddMessageRequest

フィールド
resource_id

string

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

AddMessageRequest

リクエストの本文。

GiftCardClassAddMessageResponse

フィールド
resource

GiftCardClass

更新される GiftCardClass リソース。

GiftCardClassGetRequest

フィールド
resource_id

string

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

GiftCardClassInsertRequest

フィールド
resource

GiftCardClass

リクエストの本文。

GiftCardClassListRequest

フィールド
issuer_id

int64

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

string

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

int32

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

GiftCardClassListResponse

フィールド
resources[]

GiftCardClass

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

Pagination

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

GiftCardClassPatchRequest

フィールド
resource_id

string

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

GiftCardClass

リクエストの本文。

GiftCardClassUpdateRequest

フィールド
resource_id

string

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

GiftCardClass

リクエストの本文。

GiftCardObject

フィールド
kind
(deprecated)

string

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

GiftCardClass

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

string

必須。カードの番号。
pin

string

カードの PIN。
balance

Money

カードの金額の残高。
balance_update_time

DateTime

残高が最後に更新された日時。

オフセットが必要です。

残高が更新され、このプロパティが指定されない場合、現在の時刻にデフォルト設定されます。
event_number

string

カードのイベント番号。一部のギフトカードで使用される省略可能なフィールドです。
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 個です。

GiftCardObjectAddMessageRequest

フィールド
resource_id

string

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

AddMessageRequest

リクエストの本文。

GiftCardObjectAddMessageResponse

フィールド
resource

GiftCardObject

更新される GiftCardObject リソース。

GiftCardObjectGetRequest

フィールド
resource_id

string

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

GiftCardObjectInsertRequest

フィールド
resource

GiftCardObject

リクエストの本文。

GiftCardObjectListRequest

フィールド
class_id

string

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

string

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

int32

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

GiftCardObjectListResponse

フィールド
resources[]

GiftCardObject

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

Pagination

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

GiftCardObjectPatchRequest

フィールド
resource_id

string

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

GiftCardObject

リクエストの本文。

GiftCardObjectUpdateRequest

フィールド
resource_id

string

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

GiftCardObject

リクエストの本文。