Order

注文エンティティ。注: 1. 特に指定されていない限り、すべてのレベルの文字列はすべて 1,000 文字未満にする必要があります。2. 特に指定されていない限り、すべてのレベルの繰り返しフィールドの数は 50 未満にする必要があります。3. 指定する場合、すべてのレベルのタイムスタンプは有効なタイムスタンプである必要があります。

JSON 表現
{
  "googleOrderId": string,
  "merchantOrderId": string,
  "userVisibleOrderId": string,
  "userVisibleStateLabel": string,
  "buyerInfo": {
    object (UserInfo)
  },
  "image": {
    object (Image)
  },
  "createTime": string,
  "lastUpdateTime": string,
  "transactionMerchant": {
    object (Merchant)
  },
  "contents": {
    object (Contents)
  },
  "priceAttributes": [
    {
      object (PriceAttribute)
    }
  ],
  "followUpActions": [
    {
      object (Action)
    }
  ],
  "paymentData": {
    object (PaymentData)
  },
  "termsOfServiceUrl": string,
  "note": string,
  "promotions": [
    {
      object (Promotion)
    }
  ],
  "disclosures": [
    {
      object (Disclosure)
    }
  ],
  "vertical": {
    "@type": string,
    field1: ...,
    ...
  },

  // Union field verticals can be only one of the following:
  "purchase": {
    object (PurchaseOrderExtension)
  },
  "ticket": {
    object (TicketOrderExtension)
  }
  // End of list of possible types for union field verticals.
}
フィールド
googleOrderId

string

Google が割り当てた注文 ID。

merchantOrderId

string

必須: 販売者が割り当てた内部注文 ID。この ID は一意でなければならず、後続の注文更新操作に必要です。この ID は、指定された googleOrderId などの固有の値に設定できます。ユーザーに表示される ID は userVisibleOrderId ですが、ユーザー フレンドリーな別の値にすることもできます。最大文字数は 128 文字です。

userVisibleOrderId

string

現在の注文を参照する、ユーザーに表示される ID。この ID は、ウェブサイト、アプリ、メールなど、他のコンテキストで表示されるこの注文に表示される ID と一致している必要があります。

userVisibleStateLabel
(deprecated)

string

非推奨: 代わりに OrderExtensions ステータスを使用してください。この注文の状態についてユーザーに表示されるラベル。

buyerInfo

object (UserInfo)

購入者に関する情報。

image

object (Image)

注文が関連付けられている画像。

createTime

string (Timestamp format)

必須: この注文が作成された日時。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒(例: "2014-10-02T15:01:23.045123456Z")。

lastUpdateTime

string (Timestamp format)

この注文が最後に更新された日時。OrderUpdate の場合は必須です。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒。(例: "2014-10-02T15:01:23.045123456Z")。

transactionMerchant

object (Merchant)

購入手続きを処理した販売者。項目レベルのプロバイダとは異なる場合があります。例: ANA の項目を含む Expedia の注文。

contents

object (Contents)

必須: 広告申込情報のグループである注文コンテンツ。

priceAttributes[]

object (PriceAttribute)

価格、割引、税金など。

followUpActions[]

object (Action)

注文レベルでのフォローアップ アクション。

paymentData

object (PaymentData)

注文の支払い関連のデータ。

termsOfServiceUrl

string

注文/提案された注文に適用される利用規約へのリンク。

note

string

注文に添付されたメモ。

promotions[]

object (Promotion)

この注文に関連付けられているすべてのプロモーション。

disclosures[]

object (Disclosure)

この注文に関連する開示。

vertical
(deprecated)

object

非推奨: 代わりにカテゴリを使用してください。一部の項目で上書きされない限り、これらのプロパティはすべての項目に適用されます。このカテゴリは項目レベルのカテゴリタイプと一致している必要があります。有効な値: google.actions.orders.v3.verticals.purchase.PurchaseOrderExtension google.actions.orders.v3.verticals.ticket.TicketOrderExtension

任意の型のフィールドを含むオブジェクト。タイプを識別する URI を含むフィールド "@type" を追加できます。例: { "id": 1234, "@type": "types.example.com/standard/id" }

共用体フィールド verticals。一部の項目で上書きされない限り、これらのプロパティはすべての項目に適用されます。このカテゴリは項目レベルのカテゴリタイプと一致している必要があります。verticals は次のいずれかになります。
purchase

object (PurchaseOrderExtension)

注文書

ticket

object (TicketOrderExtension)

チケットの注文

UserInfo

ユーザーに関する情報。これは、注文に関連付けられたユーザーの情報を表すために使用されます。

JSON 表現
{
  "email": string,
  "firstName": string,
  "lastName": string,
  "displayName": string,
  "phoneNumbers": [
    {
      object (PhoneNumber)
    }
  ]
}
フィールド
email

string

ユーザーのメールアドレス(例: janedoe@gmail.com)。

firstName

string

ユーザーの名(名)。

lastName

string

ユーザーの姓。

displayName

string

ユーザーの表示名。姓または名とは異なる場合があります。

phoneNumbers[]

object (PhoneNumber)

ユーザーの電話番号。

PhoneNumber

電話番号の標準表現。

JSON 表現
{
  "e164PhoneNumber": string,
  "extension": string,
  "preferredDomesticCarrierCode": string
}
フィールド
e164PhoneNumber

string

国際電気通信連合(ITU)勧告 E.164 で定義されている E.164 形式の電話番号。Wiki リンク: https://en.wikipedia.org/wiki/E.164

extension

string

内線番号については、長さが最大 40 桁の一連の番号であることを除き、ITU 勧告で標準化されていません。ここでは、内線番号の先頭にゼロを使用できるようにするため、文字列として定義されています(標準は定められていないため、自由に決定できます)。桁数以外に、「,」(ポーズを指します)などの他のダイヤル文字もここに保存されます。たとえば、xxx-xxx-xxxx 拡張子が 123 の場合は、「123」が拡張子です。

preferredDomesticCarrierCode

string

国内でこの電話番号を発信する際に推奨される携帯通信会社の選択コード。これには、固定電話から携帯電話(またはその逆)への通話時に一部の国で発信する必要があるコードも含まれます。たとえば、コロンビアでは、携帯電話から国内の固定電話(またはその逆)にかけるときに電話番号の前に「3」をダイヤルする必要があります(https://en.wikipedia.org/wiki/Telephone_numbers_in_Colombiahttps://en.wikipedia.org/wiki/Brazilian_Carrier_Selection_Code)。

これは「推奨」コードなので、他のコードも使用できます。

画像

カードに表示される画像。

JSON 表現
{
  "url": string,
  "accessibilityText": string,
  "height": number,
  "width": number
}
フィールド
url

string

画像のソース URL。JPG、PNG、GIF(アニメーション GIF と非アニメーション GIF)を使用できます。例: https://www.agentx.com/logo.png。必須。

accessibilityText

string

スクリーン リーダーなどのユーザー補助機能で使用される画像の説明テキスト。必須。

height

number

画像の高さ(ピクセル単位)。省略可能。

width

number

画像の幅(ピクセル単位)。省略可能。

販売者

カート / 注文 / 項目の販売者。

JSON 表現
{
  "id": string,
  "name": string,
  "image": {
    object (Image)
  },
  "phoneNumbers": [
    {
      object (PhoneNumber)
    }
  ],
  "address": {
    object (Location)
  }
}
フィールド
id

string

販売者に割り当てられているオプションの ID(ある場合)。

name

string

「Panera Bread」などの販売者名。

image

object (Image)

販売者に関連付けられた画像。

phoneNumbers[]

object (PhoneNumber)

販売者の電話番号。

address

object (Location)

販売者の住所。

ロケーション

場所を表すコンテナ。

JSON 表現
{
  "coordinates": {
    object (LatLng)
  },
  "formattedAddress": string,
  "zipCode": string,
  "city": string,
  "postalAddress": {
    object (PostalAddress)
  },
  "name": string,
  "phoneNumber": string,
  "notes": string,
  "placeId": string
}
フィールド
coordinates

object (LatLng)

地理座標。[DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] 権限が必要です。

formattedAddress

string

表示住所。例: 「1600 Amphitheatre Pkwy, Mountain View, CA 94043」。[DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] 権限が必要です。

zipCode

string

郵便番号。[DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] または [DEVICE_COARSE_LOCATION] [google.actions.v2.Permission.DEVICE_COARSE_LOCATION] の権限が必要です。

city

string

市区町村。[DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] または [DEVICE_COARSE_LOCATION] [google.actions.v2.Permission.DEVICE_COARSE_LOCATION] の権限が必要です。

postalAddress

object (PostalAddress)

郵便住所。[DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] または [DEVICE_COARSE_LOCATION] [google.actions.v2.Permission.DEVICE_COARSE_LOCATION] の権限が必要です。

name

string

場所の名前。

phoneNumber

string

ビジネス拠点の電話番号(例: ビジネス拠点の連絡先電話番号、配送先の電話番号)。

notes

string

ロケーションに関するメモ。

placeId

string

placeId は、場所の詳細をフェッチするために Places API で使用されます。https://developers.google.com/places/web-service/place-id をご覧ください。

LatLng

緯度と経度のペアを表すオブジェクト。これは緯度を表す倍精度値と経度を表す倍精度値のペアで表現されます。特に明記されていない場合、これは WGS84 規格に準拠する必要があります。値は正規化範囲内で指定する必要があります。

JSON 表現
{
  "latitude": number,
  "longitude": number
}
フィールド
latitude

number

緯度(度単位)。[-90.0, +90.0] の範囲内で指定する必要があります。

longitude

number

経度(度単位)。[-180.0, +180.0] の範囲内で指定する必要があります。

PostalAddress

郵便の配達先や支払場所などに使用される住所を表します。郵便住所がわかっていれば、郵便サービスによって住宅や私書箱などに商品を配達できます。これは地理的な場所(道路、町、山)を指し示すものではありません。

通常の用途では、住所はユーザーによる入力か既存データのインポートによって作成されます(プロセスの種類によります)。

住所の入力または編集に関するアドバイス: - i18n 対応の住所ウィジェット(https://github.com/google/libaddressinput など)を使用してください。- 特定の国で使用されるフィールドの入力または編集用の UI 要素は、その国以外のユーザーには表示しないでください。

このスキーマの使用方法の詳細については、https://support.google.com/business/answer/6397478 をご覧ください。

JSON 表現
{
  "revision": number,
  "regionCode": string,
  "languageCode": string,
  "postalCode": string,
  "sortingCode": string,
  "administrativeArea": string,
  "locality": string,
  "sublocality": string,
  "addressLines": [
    string
  ],
  "recipients": [
    string
  ],
  "organization": string
}
フィールド
revision

number

PostalAddress のスキーマ リビジョン。最新のリビジョンである 0 に設定する必要があります。

新しいリビジョンはすべて、古いリビジョンとの下位互換性を保つ必要があります

regionCode

string

必須。住所の国 / 地域に対応する CLDR 地域コード。この値は推測されることはなく、正確な値が確保されるかどうかはユーザー次第です。詳細については、http://cldr.unicode.org/http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html をご覧ください。例: スイスの場合は「CH」。

languageCode

string

(省略可)この住所の表記に使われている BCP-47 言語コード(わかっている場合)。多くの場合、これは入力フォームの UI 言語です。あるいは、住所の国や地域で使用されているいずれかの言語、またはそれらの言語を音訳したものと一致する場合もあります。これは特定の国で住所のフォーマットに影響する可能性がありますが、データの正確性にとっては重要でなく、検証やその他のフォーマット関連以外の操作には影響しません。

この値が不明な場合は省略してください(間違っている可能性があるデフォルトは指定しないでください)。

例: 「zh-Hant」、「ja」、「ja-Latn」、「en」。

postalCode

string

(省略可)住所の郵便番号。すべての国で、郵便番号の使用または必須要件というわけではありませんが、郵便番号が使用されている場合、住所の他の部分(米国での州や郵便番号の検証など)で追加の検証が行われることがあります。

sortingCode

string

(省略可)国固有の付加的な並べ替えコード。ほとんどの地域では、これは使用されていません。使用する場合、値は「CEDEX」のような文字列か、必要に応じて数字の後に数字(例: 「CEDEX 7」)、または数字のみ(「セクターコード」(ジャマイカ)、「配達地域インジケーター」(マラウイ)、または「郵便局インジケーター」(例: コートジボワール)を表します。

administrativeArea

string

(省略可)その国 / 地域の郵便住所に使用される最上位の行政区域。たとえば、州、省、都道府県などがこれに該当します。特にスペインでは、これは自治州ではなく県になります(例: 「カタルーニャ」ではなく「バルセロナ」)。州や県などの行政区域が郵便住所に使用されない国もあります。たとえばスイスでは、このフィールドを未設定のままにする必要があります。

locality

string

(省略可)通常は住所の市区町村の部分を指します。たとえば、米国の市、イタリアのコムーネ、英国の郵便町名などがこれに該当します。地域区分が明確に定義されていない地域や、この構造に当てはまらない地域では、locality を空にして addressLines を使用します。

sublocality

string

(省略可)住所の市区町村部分より下位の区分。たとえば、地区、特別区、地区などです。

addressLines[]

string

構造化されていない住所の下位部分を記述する行。

addressLines の値は型情報を持たず、単一のフィールドに複数の値を含めることができるため(例: 「Austin, TX」)、行の順序が明確であることが重要です。住所行の順序は、その住所の国 / 地域の「宛名書きの順序」にします。これが一定でない可能性のある場所(日本など)では、address_language を使用して明示的に指定します(例: 順序が大区分から小区分の場合は「ja」、小区分から大区分の場合は「ja-Latn」または「en」)。そうすることで、住所の最も細かい部分の行を言語に基づいて選択できます。

住所の構造化表現として許容される最小限の形式は、regionCode を設定し、残りすべての情報を addressLines に格納するというものです。そのような住所はジオコーディングしなくてもおおよそフォーマットできますが、住所の構成要素の意味は、少なくとも部分的にわからなければ推測できません。

完全に構造化されていない住所を処理するには、(住所のどの部分が地域区分で、どの部分が行政区域であるかを推測するのではなく)regionCode と addressLines のみを含む住所を作成してからジオコーディングを行うことをおすすめします。

recipients[]

string

(省略可)その住所にいる受取人。このフィールドには、場合によっては複数の情報を含めることができます。たとえば、「様方」の情報などです。

organization

string

(省略可)その住所にある組織の名前。

目次

項目のラッパー。

JSON 表現
{
  "lineItems": [
    {
      object (LineItem)
    }
  ]
}
フィールド
lineItems[]

object (LineItem)

注文の項目のリスト。少なくとも 1 つの lineItem が必要です。最大 50 個の項目を含めることができます。すべての広告申込情報が同じカテゴリに属している必要があります。

LineItem

1 つの項目に 1 つのカテゴリが含まれます。注文またはカートに、同じカテゴリの複数の項目を含めることができます。サブ項目やアドオンなどは、使用事例に応じてカテゴリ プロトコルで定義する必要があります。注: 1. 特に指定されていない限り、すべてのレベルの文字列はすべて 1,000 文字未満にする必要があります。2. 特に指定されていない限り、すべてのレベルの繰り返しフィールドの数は 50 未満にする必要があります。3. 指定する場合、すべてのレベルのタイムスタンプは有効なタイムスタンプである必要があります。

JSON 表現
{
  "id": string,
  "name": string,
  "userVisibleStateLabel": string,
  "provider": {
    object (Merchant)
  },
  "priceAttributes": [
    {
      object (PriceAttribute)
    }
  ],
  "followUpActions": [
    {
      object (Action)
    }
  ],
  "recipients": [
    {
      object (UserInfo)
    }
  ],
  "image": {
    object (Image)
  },
  "description": string,
  "notes": [
    string
  ],
  "disclosures": [
    {
      object (Disclosure)
    }
  ],
  "vertical": {
    "@type": string,
    field1: ...,
    ...
  },

  // Union field verticals can be only one of the following:
  "purchase": {
    object (PurchaseItemExtension)
  },
  "reservation": {
    object (ReservationItemExtension)
  }
  // End of list of possible types for union field verticals.
}
フィールド
id

string

必須: 項目に対して割り当てられた販売者 ID。部分更新を適用する際に既存の項目を識別するために使用されます。最大文字数は 64 文字です。

name

string

領収書に表示される項目の名前。最大文字数は 100 文字です。

userVisibleStateLabel
(deprecated)

string

非推奨。代わりに、カテゴリレベルのステータスを使用します。たとえば、購入の場合、PurchaseOrderExtension.status を使用します。この項目の状態についてユーザーに表示されるラベルです。

provider

object (Merchant)

特定の項目のプロバイダ(注文全体と異なる場合)。例: 広告申込情報プロバイダ ANA を使用した Expedia の注文。

priceAttributes[]

object (PriceAttribute)

広告申込情報レベルの価格と調整。

followUpActions[]

object (Action)

広告申込情報でフォローアップ アクションを行います。

recipients[]

object (UserInfo)

項目レベルの購入者。これは注文レベルの購入者とは異なる場合があります。例: ユーザー X がユーザー Y の名前でレストランを予約した。

image

object (Image)

このアイテムに関連付けられている小さい画像(存在する場合)。

description

string

広告申込情報の説明。

notes[]

string

キャンセル ポリシーなど、この特定の項目に適用される追加情報です。

disclosures[]

object (Disclosure)

この広告申込情報に関連付けられている開示。

vertical
(deprecated)

object

非推奨: 代わりにカテゴリを使用してください。必須: タイプまたはカテゴリに基づく項目のセマンティック コンテンツ。すべてのカテゴリに、固有のフルフィルメントの詳細を含める必要があります。次のいずれかの値にする必要があります。google.actions.orders.v3.verticals.purchase.PurchaseItemExtension google.actions.orders.v3.verticals.reservation.ReservationItemExtension google.actions.orders.v3.verticals.ticket.TicketItemExtension

任意の型のフィールドを含むオブジェクト。タイプを識別する URI を含むフィールド "@type" を追加できます。例: { "id": 1234, "@type": "types.example.com/standard/id" }

共用体フィールド verticals。必須: タイプまたはカテゴリに基づく項目のセマンティック コンテンツ。すべてのカテゴリに、固有のフルフィルメントの詳細を含める必要があります。verticals は次のいずれかになります。
purchase

object (PurchaseItemExtension)

商品や食品などの注文書

reservation

object (ReservationItemExtension)

レストランやヘアカットなどの予約注文

PriceAttribute

注文または項目の価格属性。

JSON 表現
{
  "type": enum (Type),
  "name": string,
  "state": enum (State),
  "taxIncluded": boolean,

  // Union field spec can be only one of the following:
  "amount": {
    object (Money)
  },
  "amountMillipercentage": number
  // End of list of possible types for union field spec.
}
フィールド
type

enum (Type)

必須: 金額属性のタイプ。

name

string

必須: ユーザーに表示される価格属性の文字列。これは販売者によって送信され、ローカライズされます。

state

enum (State)

必須: 価格の状態: 見積もりと実際の比較。

taxIncluded

boolean

価格が税込みかどうか。

共用体フィールド spec。金額または割合(1,000 分の 1)を表します。spec は次のいずれかになります。
amount

object (Money)

金額。

amountMillipercentage
(deprecated)

number

割合の spec で、0.001 パーセントが 1 で表されます。たとえば、8.750% は 8,750 として表されます。負の割合は割引率を表します。このフィールドは非推奨です。堅実なユースケースが求められる場合に、このフィールドの使用を検討できます。

種類

価格のタイプを表します。

列挙型
TYPE_UNSPECIFIED タイプは指定されていません。クライアントでこれを明示的に設定しないでください。
REGULAR 通常の表示価格。割引などが適用される前の価格です。
DISCOUNT 小計から差し引かれます。
TAX 小計に加算されます。
DELIVERY 小計に加算されます。
SUBTOTAL 手数料や追加料金が加算される前の小計。
FEE 追加料金。
GRATUITY 小計に加算されます。
TOTAL 注文または項目の表示価格。

状態

価格の状態を表します。

列挙型
STATE_UNSPECIFIED 指定なし。
ESTIMATE 価格は見積もりです。
ACTUAL ユーザーに請求される実際の価格。

通貨

金額をその通貨タイプで表します。

JSON 表現
{
  "currencyCode": string,
  "amountInMicros": string
}
フィールド
currencyCode

string

ISO 4217 で定義されている 3 文字の通貨コード。

amountInMicros

string (int64 format)

100 万分の 1 単位で表された金額。たとえば、このフィールドを $1.99 の場合は 1990000 に設定します。

行動

注文または品目に関連付けられたフォローアップ アクション。

JSON 表現
{
  "type": enum (Type),
  "title": string,
  "openUrlAction": {
    object (OpenUrlAction)
  },
  "actionMetadata": {
    object (ActionMetadata)
  }
}
フィールド
type

enum (Type)

必須: アクションのタイプ。

title

string

ユーザーに表示されるアクションのタイトルまたはラベル。最大文字数は 100 文字です。

openUrlAction

object (OpenUrlAction)

必要な対応。

actionMetadata

object (ActionMetadata)

アクションに関連付けられたメタデータ。

種類

有効なフォローアップ アクション。

列挙型
TYPE_UNSPECIFIED アクションは指定されていません。
VIEW_DETAILS 注文の詳細を表示するアクション。
MODIFY 注文の変更アクション。
CANCEL 注文のキャンセル アクション。
RETURN 注文の返品アクション。
EXCHANGE 注文の交換アクション。
EMAIL

メール アクション。EMAIL と CALL タイプは非推奨です。openUrlAction.url は、電話番号やメールアドレスとして使用できます。

CALL

通話アクション。

REORDER 再注文アクション。
REVIEW 注文の確認アクション。
CUSTOMER_SERVICE カスタマー サービスへのお問い合わせ。
FIX_ISSUE 問題を解決するために販売者サイトまたはアプリへ誘導。
DIRECTION 誘導リンク。

OpenUrlAction

指定された URL を開きます。

JSON 表現
{
  "url": string,
  "androidApp": {
    object (AndroidApp)
  },
  "urlTypeHint": enum (UrlTypeHint)
}
フィールド
url

string

url フィールドでは、次のいずれかを指定できます。- アプリとリンクしたアプリまたはウェブページを開くための http または https の URL

androidApp

object (AndroidApp)

Android アプリに関する情報(URL が Android アプリによって実行されることが想定される場合)。

urlTypeHint

enum (UrlTypeHint)

URL タイプのヒントを示します。

AndroidApp

Android アプリのフルフィルメント制限に関する仕様

JSON 表現
{
  "packageName": string,
  "versions": [
    {
      object (VersionFilter)
    }
  ]
}
フィールド
packageName

string

パッケージ名は、Android Fulfillment を指定するときに指定する必要があります。

versions[]

object (VersionFilter)

複数のフィルタが指定されている場合、フィルタが一致するとアプリがトリガーされます。

VersionFilter

アプリの特定のバージョンが必要な場合は、VersionFilter を含める必要があります。

JSON 表現
{
  "minVersion": number,
  "maxVersion": number
}
フィールド
minVersion

number

最小バージョン コードまたは 0(両端を含む)。

maxVersion

number

最大バージョン コード(指定されたバージョンを含む)。考慮される範囲は [minVersion:maxVersion] です。null の範囲は任意のバージョンを意味します。例: 単一のバージョンを指定するには、[target_version:target_version] を使用します。任意のバージョンを指定するには、minVersion と maxVersion を未指定のままにします。maxVersion までのすべてのバージョンを指定するには、minVersion を未指定のままにします。minVersion からすべてのバージョンを指定するには、maxVersion を指定しないでください。

UrlTypeHint

URL ヒントのタイプ。

列挙型
URL_TYPE_HINT_UNSPECIFIED 指定なし
AMP_CONTENT AMP コンテンツを直接指す URL、または <link rel="amphtml"> を介して AMP コンテンツを参照する正規 URL を指す URL。

ActionMetadata

アクションごとの関連メタデータ。

JSON 表現
{
  "expireTime": string
}
フィールド
expireTime

string (Timestamp format)

このアクションの有効期限が切れる日時。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒。(例: "2014-10-02T15:01:23.045123456Z")。

開示情報

ユーザーに提示される商品、サービス、またはポリシーの開示。

JSON 表現
{
  "title": string,
  "disclosureText": {
    object (DisclosureText)
  },
  "presentationOptions": {
    object (DisclosurePresentationOptions)
  }
}
フィールド
title

string

開示のタイトル。例: 「安全に関する情報」

disclosureText

object (DisclosureText)

開示の内容。ウェブリンクを使用できます。

presentationOptions

object (DisclosurePresentationOptions)

開示のプレゼンテーション オプション。

DisclosureText

ウェブリンク付きの書式なしテキストを表します。

JSON 表現
{
  "template": string,
  "textLinks": [
    {
      object (TextLink)
    }
  ]
}
フィールド
template

string

表示するテキスト。挿入する各テキストリンクに対応する「{0}」や「{1}」などのプレースホルダを含みます。例: 「警告: この製品を使用すると、癌を誘発する可能性があるとカリフォルニア州で認識されている化学物質にさらされるおそれがあります。詳しくは、{0} をご覧ください。」この開示テキストに、宣伝や広告に似たコンテンツを含めることはできません。

DisclosurePresentationOptions

開示の提示オプション。

JSON 表現
{
  "presentationRequirement": enum (PresentationRequirement),
  "initiallyExpanded": boolean
}
フィールド
presentationRequirement

enum (PresentationRequirement)

開示の提示要件。

initiallyExpanded

boolean

開示の内容を最初から展開しておくかどうか。デフォルトでは、最初は折りたたまれています。

PresentationRequirement

開示の表示に関する要件。

列挙型
REQUIREMENT_UNSPECIFIED 要件は指定されていません。これは明示的に設定しないでください。
REQUIREMENT_OPTIONAL 開示は任意です。デバイスが開示をサポートしていない場合は省略できます。
REQUIREMENT_REQUIRED 開示は必須です。デバイスが開示をサポートしていない場合は、会話は電話にパントされます。

PurchaseItemExtension

購入カテゴリの項目コンテンツ。

JSON 表現
{
  "status": enum (PurchaseStatus),
  "userVisibleStatusLabel": string,
  "type": enum (PurchaseType),
  "productId": string,
  "quantity": number,
  "unitMeasure": {
    object (MerchantUnitMeasure)
  },
  "returnsInfo": {
    object (PurchaseReturnsInfo)
  },
  "fulfillmentInfo": {
    object (PurchaseFulfillmentInfo)
  },
  "itemOptions": [
    {
      object (ItemOption)
    }
  ],
  "extension": {
    "@type": string,
    field1: ...,
    ...
  },
  "productDetails": {
    object (ProductDetails)
  }
}
フィールド
status

enum (PurchaseStatus)

必須: 広告申込情報レベルのステータス。

userVisibleStatusLabel

string

必須: ユーザーに表示されるステータスのラベルまたは文字列。最大文字数は 50 文字です。

type

enum (PurchaseType)

必須: 購入のタイプ。

productId
(deprecated)

string

この項目に関連付けられた商品 ID またはオファー ID。

quantity

number

商品アイテムの数量。

unitMeasure

object (MerchantUnitMeasure)

単位。選択した単位で項目のサイズを指定します。サイズと有効な価格を使用して単価が決定されます。

returnsInfo

object (PurchaseReturnsInfo)

この項目の返品情報。設定しない場合、この広告申込情報は注文レベルの返品情報を継承します。

fulfillmentInfo

object (PurchaseFulfillmentInfo)

この項目のフルフィルメント情報。設定しない場合、この広告申込情報は注文レベルのフルフィルメント情報を継承します。

itemOptions[]

object (ItemOption)

追加のアドオンまたはサブアイテム。

extension

object

販売者と Google の間で交換される追加フィールド。

任意の型のフィールドを含むオブジェクト。タイプを識別する URI を含むフィールド "@type" を追加できます。例: { "id": 1234, "@type": "types.example.com/standard/id" }

productDetails

object (ProductDetails)

商品に関する詳細。

PurchaseStatus

注文書または特定の項目に関連付けられた購入ステータス。

列挙型
PURCHASE_STATUS_UNSPECIFIED ステータスの指定なし。
READY_FOR_PICKUP 受け取り可能。
SHIPPED 発送済み。
DELIVERED 配達済み。
OUT_OF_STOCK 在庫なし。
IN_PREPARATION 「IN_PREPARATION」は、別のコンテキストでは異なる意味を持つことがあります。FOOD 注文の場合、料理は準備中です。小売の場合は、荷物はパッケージ中です。
CREATED 注文が作成されました。
CONFIRMED 販売者が注文を確認しました。
REJECTED 販売者が注文または項目を拒否しました。
RETURNED 商品アイテムがユーザーによって返品されました。
CANCELLED 注文または項目がユーザーによってキャンセルされました。
CHANGE_REQUESTED ユーザーが注文の変更をリクエストし、現在インテグレータがこの変更を処理しています。リクエストが処理された後に注文を別の状態に移行する必要があります。

PurchaseType

購入カテゴリ。

列挙型
PURCHASE_TYPE_UNSPECIFIED 不明な値です。
RETAIL 物理的な商品などの購入が含まれます。
FOOD 料理の購入が含まれます。
GROCERY 食料品の購入。
MOBILE_RECHARGE プリペイド モバイルのリチャージ購入。

MerchantUnitMeasure

販売者が設定する単位価格。

JSON 表現
{
  "measure": number,
  "unit": enum (Unit)
}
フィールド
measure

number

値: 例 1.2。

unit

enum (Unit)

単位: POUND、GRAM の例

単位

列挙型
UNIT_UNSPECIFIED 単位は指定されていません。
MILLIGRAM ミリグラム。
GRAM グラム。
KILOGRAM キログラム。
OUNCE オンス。
POUND ポンド。

PurchaseReturnsInfo

注文または特定の項目に関連付けられた返品情報。

JSON 表現
{
  "isReturnable": boolean,
  "daysToReturn": number,
  "policyUrl": string
}
フィールド
isReturnable

boolean

true の場合、戻り値は許可されます。

daysToReturn

number

その日数以内であれば返品が可能です。

policyUrl

string

返品に関するポリシーへのリンク。

PurchaseFulfillmentInfo

注文書または特定の項目に関連付けられたフルフィルメント情報。

JSON 表現
{
  "id": string,
  "fulfillmentType": enum (Type),
  "expectedFulfillmentTime": {
    object (Time)
  },
  "expectedPreparationTime": {
    object (Time)
  },
  "location": {
    object (Location)
  },
  "expireTime": string,
  "price": {
    object (PriceAttribute)
  },
  "fulfillmentContact": {
    object (UserInfo)
  },
  "shippingMethodName": string,
  "storeCode": string,
  "pickupInfo": {
    object (PickupInfo)
  }
}
フィールド
id

string

このサービス オプションの一意の識別子。

fulfillmentType

enum (Type)

必須: フルフィルメントのタイプ。

expectedFulfillmentTime

object (Time)

時間範囲が指定されている場合は時間枠、または単一の時間が指定されている場合は到着予定時刻。 配達または受け取りの予定。

expectedPreparationTime

object (Time)

時間範囲が指定されている場合は時間枠、または単一の時間が指定されている場合は到着予定時刻。 料理の準備にかかる予定時間。1 回限りの設定が推奨されます。

location

object (Location)

受け取りまたは配達の場所。

expireTime

string (Timestamp format)

このフルフィルメント オプションの有効期限が切れる日時。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒(例: "2014-10-02T15:01:23.045123456Z")。

price

object (PriceAttribute)

このオプションの費用。

fulfillmentContact

object (UserInfo)

このフルフィルメントのユーザーの連絡先。

shippingMethodName

string

ユーザーが選択した配送方法の名前。

storeCode

string

店舗の StoreCode。例: 販売者は Walmart、storeCode は注文処理が行われた Walmart の店舗です(https://support.google.com/business/answer/3370250?ref_topic=4596653)。

pickupInfo

object (PickupInfo)

注文の受け取り方法に関する追加情報。このフィールドは、フルフィルメント タイプが PICKUP の場合にのみ適用されます。

種類

フルフィルメント タイプ。

列挙型
TYPE_UNSPECIFIED 未指定
DELIVERY この注文は配達されます。
PICKUP この注文は受け取る必要があります。

時間

ユーザーに注文を表示するときに使用するイベントの時間を表す Time 構造体。

JSON 表現
{
  "timeIso8601": string
}
フィールド
timeIso8601

string

予約時間や配達時間など、注文イベントにおける時間を表します。期間(開始時間と終了時間)、日付、日時などを使用できます。サポートされているすべての形式については、https://en.wikipedia.org/wiki/ISO_8601 をご覧ください。

PickupInfo

注文の受け取り方法に関する詳細。受け取りのタイプや、各タイプに添付されたメタデータなどの詳細が含まれます(追加情報がある場合)。

JSON 表現
{
  "pickupType": enum (PickupType),
  "curbsideInfo": {
    object (CurbsideInfo)
  },
  "checkInInfo": [
    {
      object (CheckInInfo)
    }
  ]
}
フィールド
pickupType

enum (PickupType)

受け取り方法(INSTORE、CURBSIDE など)

curbsideInfo

object (CurbsideInfo)

店舗受け取り情報固有の詳細。 pickupType が「CURBSIDE」でない場合、このフィールドは無視されます。

checkInInfo[]

object (CheckInInfo)

チェックインをサポートするパートナーでサポートされているさまざまな方法のリスト。

PickupType

サポートされている受け取りタイプのリスト。

列挙型
UNSPECIFIED 受け取りタイプが指定されていません。
INSTORE レストラン内で料理を受け取ります。
CURBSIDE レストラン外の指定された場所に駐車して、そこに料理が届けられます。

CurbsideInfo

店舗受け取り注文をどのように行うかに関する詳細。

JSON 表現
{
  "curbsideFulfillmentType": enum (CurbsideFulfillmentType),
  "userVehicle": {
    object (Vehicle)
  }
}
フィールド
curbsideFulfillmentType

enum (CurbsideFulfillmentType)

店舗受け取り注文には追加情報が必要です。選択したフルフィルメント タイプに応じて、対応する詳細がユーザーから収集されます。

userVehicle

object (Vehicle)

注文を行ったユーザーの車両の詳細。

CurbsideFulfillmentType

店舗受け取りのフルフィルメント タイプに指定可能な値。

列挙型
UNSPECIFIED 店舗受け取りのフルフィルメント タイプが指定されていません。
VEHICLE_DETAIL 店舗受け取りに必要な自動車の詳細。

車両

乗り物に関する詳細。

JSON 表現
{
  "make": string,
  "model": string,
  "licensePlate": string,
  "colorName": string,
  "image": {
    object (Image)
  }
}
フィールド
make

string

自動車のメーカー(例: 「Honda」)。これはユーザーに表示されるため、ローカライズする必要があります。必須。

model

string

自動車のモデル(例: 「Grom」)。これはユーザーに表示されるため、ローカライズする必要があります。必須。

licensePlate

string

自動車のナンバー プレート番号(例: 「1ABC234」)。必須。

colorName

string

車両の色の名前(例: 黒)。省略可。

image

object (Image)

自動車の写真の URL。写真は約 256 x 256 ピクセルで表示されます。jpg または png である必要があります。省略可能。

CheckInInfo

チェックイン方法をサポートするためにパートナーが必要とするメタデータ。

JSON 表現
{
  "checkInType": enum (CheckInType)
}
フィールド
checkInType

enum (CheckInType)

チェックイン手順の送信に使用するメソッド。

CheckInType

チェックイン手順を送信するさまざまな方法。

列挙型
CHECK_IN_TYPE_UNSPECIFIED 不明な値です。
EMAIL チェックイン情報はメールで送信されます。
SMS チェックイン情報は SMS で送信されます。

ItemOption

アドオンまたはサブ項目を表します。

JSON 表現
{
  "id": string,
  "name": string,
  "prices": [
    {
      object (PriceAttribute)
    }
  ],
  "note": string,
  "quantity": number,
  "productId": string,
  "subOptions": [
    {
      object (ItemOption)
    }
  ]
}
フィールド
id

string

オプションがアイテムの場合、一意のアイテム ID。

name

string

オプション名。

prices[]

object (PriceAttribute)

オプションの合計金額。

note

string

オプションに関する注意事項。

quantity

number

オプションがアイテムの場合、数量。

productId

string

このオプションに関連付けられた商品 ID または特典 ID。

subOptions[]

object (ItemOption)

他のネストされたサブオプションを定義する場合。

ProductDetails

商品に関する詳細。

JSON 表現
{
  "productId": string,
  "gtin": string,
  "plu": string,
  "productType": string,
  "productAttributes": {
    string: string,
    ...
  }
}
フィールド
productId

string

この広告申込情報に関連付けられている商品 ID またはオファー ID。

gtin

string

商品の国際取引商品番号。Merchant Center に offerId がない場合に役立ちます。省略可能。

plu

string

価格検索コード(一般的に PLU コード、PLU 番号、PLU、生産コード、または生産ラベルと呼ばれる)は、食料品店やスーパーマーケットで大量に販売される農産物を一意に識別する番号のシステムです。

productType

string

販売者が定義した商品カテゴリ。例: 「日用品 > 食料品 > 乳製品、卵 > 牛乳 > 全ミルク」

productAttributes

map (key: string, value: string)

販売者が提供する商品に関する詳細情報。例: { "アレルゲン": "ピーナッツ" }。Merchant Center に offerId がない場合に役立ちます。省略可。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

ReservationItemExtension

レストランやヘアカットなどの予約注文の項目コンテンツ。次の ID: 15

JSON 表現
{
  "status": enum (ReservationStatus),
  "userVisibleStatusLabel": string,
  "type": enum (ReservationType),
  "reservationTime": {
    object (Time)
  },
  "userAcceptableTimeRange": {
    object (Time)
  },
  "confirmationCode": string,
  "partySize": number,
  "staffFacilitators": [
    {
      object (StaffFacilitator)
    }
  ],
  "location": {
    object (Location)
  },
  "extension": {
    "@type": string,
    field1: ...,
    ...
  }
}
フィールド
status

enum (ReservationStatus)

必須: 予約ステータス。

userVisibleStatusLabel

string

必須: ユーザーに表示されるステータスのラベルまたは文字列。最大文字数は 50 文字です。

type

enum (ReservationType)

予約のタイプ。どのタイプ オプションも適用できない場合は未設定になることがあります。

reservationTime

object (Time)

サービスまたはイベントの予約時間。期間、日付、または正確な日時を指定できます。

userAcceptableTimeRange

object (Time)

ユーザーが許容できる期間。

confirmationCode

string

この予約の確認コード。

partySize

number

人数。

staffFacilitators[]

object (StaffFacilitator)

予約を担当するスタッフ。例: ヘアスタイリスト。

location

object (Location)

サービス/イベントの場所。

extension

object

販売者と Google の間で交換される追加フィールド。

任意の型のフィールドを含むオブジェクト。タイプを識別する URI を含むフィールド "@type" を追加できます。例: { "id": 1234, "@type": "types.example.com/standard/id" }

ReservationStatus

予約のステータス。

列挙型
RESERVATION_STATUS_UNSPECIFIED ステータスは指定されていません。
PENDING 予約は保留中です。
CONFIRMED 予約は確定しています。
CANCELLED 予約はユーザーによってキャンセルされました。
FULFILLED 予約は実施されました。
CHANGE_REQUESTED 予約の変更がリクエストされました。
REJECTED 予約が期限切れになったか、インテグレータによって拒否されました。

ReservationType

予約のタイプ。

列挙型
RESERVATION_TYPE_UNSPECIFIED 未指定のタイプ。
RESTAURANT レストランの予約。
HAIRDRESSER 美容院の予約。

StaffFacilitator

サービス担当者に関する情報。

JSON 表現
{
  "name": string,
  "image": {
    object (Image)
  }
}
フィールド
name

string

担当スタッフの名前。例: 「田中太郎」

image

object (Image)

パフォーマーの画像。

PaymentData

注文に関連する支払いデータ。

JSON 表現
{
  "paymentResult": {
    object (PaymentResult)
  },
  "paymentInfo": {
    object (PaymentInfo)
  }
}
フィールド
paymentResult

object (PaymentResult)

取引を完了するためにインテグレータによって使用される支払い結果。このフィールドは、購入手続きが Actions on Google によって管理されている場合、Actions on Google によって入力されます。

paymentInfo

object (PaymentInfo)

注文に関する支払い情報。ユーザーが行う操作に役立ちます。

PaymentResult

取引を完了するためにインテグレータによって使用された支払い結果。

JSON 表現
{

  // Union field result can be only one of the following:
  "googlePaymentData": string,
  "merchantPaymentMethodId": string
  // End of list of possible types for union field result.
}
フィールド
共用体フィールド result。Google の支払いデータと販売者の支払い方法のどちらかが提供されます。result は次のいずれかになります。
googlePaymentData

string

Google によって提供される支払い方法に関するデータ。お客様の決済代行業者が Google でサポートされている決済代行業者のリスト(https://developers.google.com/pay/api/)にある場合、このリンクからお客様の決済代行業者にアクセスし、詳細情報を確認してください。それ以外の場合は、次のドキュメントでペイロードの詳細をご覧ください。https://developers.google.com/pay/api/payment-data-cryptography

merchantPaymentMethodId

string

ユーザーが選択した販売者/アクション提供の支払い方法。

PaymentInfo

行われている注文に関する支払い情報。このプロトコルは、ユーザーに表示される操作に役立つ情報をキャプチャします。

JSON 表現
{
  "paymentMethodDisplayInfo": {
    object (PaymentMethodDisplayInfo)
  },
  "paymentMethodProvenance": enum (PaymentMethodProvenance)
}
フィールド
paymentMethodDisplayInfo

object (PaymentMethodDisplayInfo)

取引に使用されたお支払い方法の表示情報。

paymentMethodProvenance

enum (PaymentMethodProvenance)

取引に使用された支払い方法の提供元。ユーザーが Google と販売者の両方で同じお支払い方法を登録している可能性があります。

PaymentMethodDisplayInfo

取引を完了するためにインテグレータによって使用された支払い結果。

JSON 表現
{
  "paymentType": enum (PaymentType),
  "paymentMethodDisplayName": string,
  "paymentMethodVoiceName": string
}
フィールド
paymentType

enum (PaymentType)

支払いの種類。

paymentMethodDisplayName

string

ユーザーに表示される支払い方法の名前。例: VISA **** 1234 当座預金口座 **** 5678

paymentMethodVoiceName

string

音声のみのアシスタント デバイスでユーザーに読み上げられるお支払い方法の名前。例: 「ビザ末尾が one two three four」、「当座預金口座 末尾 5 6 7 8」など。注: これは、音声のみのアシスタント デバイスで paymentMethodDisplayName の代わりに使用される、音声に最適化された文字列です。この文字列が設定されていない場合、代わりに paymentMethodDisplayName がユーザーに読み上げられます。

PaymentType

PaymentType は、販売者が指定した支払い方法に使用される支払いの形式を示します。アクションでお支払い方法の表示名も指定する必要があります。

列挙型
PAYMENT_TYPE_UNSPECIFIED 未指定の支払いタイプ。
PAYMENT_CARD クレジット / デビットカードまたはプリペイド カード。
BANK 支払い方法は銀行口座です。
LOYALTY_PROGRAM 支払い方法はポイント プログラムです。
CASH 支払い方法は現金です。
GIFT_CARD 支払い方法はギフトカードです。
WALLET サードパーティ ウォレット(例: PayPal)。

PaymentMethodProvenance

取引に使用された支払い方法の策定元を表します。

列挙型
PAYMENT_METHOD_PROVENANCE_UNSPECIFIED 策定元は不明です。
PAYMENT_METHOD_PROVENANCE_GOOGLE 策定元は Google です。
PAYMENT_METHOD_PROVENANCE_MERCHANT 策定元は販売者です。

プロモーション

カートに追加されたプロモーションまたはクーポン。

JSON 表現
{
  "coupon": string
}
フィールド
coupon

string

必須: この特典に適用されるクーポンコード。

PurchaseOrderExtension

購入カテゴリの注文拡張。項目で上書きされない限り、これらのプロパティは注文内のすべての項目に適用されます。

JSON 表現
{
  "status": enum (PurchaseStatus),
  "userVisibleStatusLabel": string,
  "type": enum (PurchaseType),
  "returnsInfo": {
    object (PurchaseReturnsInfo)
  },
  "fulfillmentInfo": {
    object (PurchaseFulfillmentInfo)
  },
  "extension": {
    "@type": string,
    field1: ...,
    ...
  },
  "purchaseLocationType": enum (PurchaseLocationType),
  "errors": [
    {
      object (PurchaseError)
    }
  ]
}
フィールド
status

enum (PurchaseStatus)

必須: 注文の全体的なステータス。

userVisibleStatusLabel

string

ユーザーに表示されるステータスのラベルまたは文字列。最大文字数は 50 文字です。

type

enum (PurchaseType)

必須: 購入のタイプ。

returnsInfo

object (PurchaseReturnsInfo)

注文の返品情報。

fulfillmentInfo

object (PurchaseFulfillmentInfo)

注文のフルフィルメント情報。

extension

object

販売者と Google の間で交換される追加フィールド。

任意の型のフィールドを含むオブジェクト。タイプを識別する URI を含むフィールド "@type" を追加できます。例: { "id": 1234, "@type": "types.example.com/standard/id" }

purchaseLocationType

enum (PurchaseLocationType)

購入場所(店舗 / オンライン)

errors[]

object (PurchaseError)

省略可: この注文が拒否された原因となったエラー。

PurchaseLocationType

購入場所のタイプ。

列挙型
UNSPECIFIED_LOCATION 不明な値です。
ONLINE_PURCHASE すべてオンラインで購入されます。
INSTORE_PURCHASE すべて店舗で購入されます。

PurchaseError

注文書が拒否される原因となるエラー。

JSON 表現
{
  "type": enum (ErrorType),
  "description": string,
  "entityId": string,
  "updatedPrice": {
    object (PriceAttribute)
  },
  "availableQuantity": number
}
フィールド
type

enum (ErrorType)

必須: 販売者によって注文が拒否された詳しい理由を表します。

description

string

追加のエラーの説明。

entityId

string

エラーに対応するエンティティ ID。たとえば、これが PlacementId / ItemOptionId に対応している場合があります。

updatedPrice

object (PriceAttribute)

PRICE_CHANGED / INCORRECT_PRICE のエラータイプの場合に関連します。

availableQuantity

number

現在入手可能な数量。AVAILABILITY_CHANGED の場合に適用されます。

ErrorType

発生する可能性があるエラーのタイプ。

列挙型
ERROR_TYPE_UNSPECIFIED 不明なエラー
NOT_FOUND エンティティが見つかりません。Item、FulfillmentOption、Promotion のいずれかでなければなりません。エンティティ ID は必須です。
INVALID エンティティ データが無効です。Item、FulfillmentOption、Promotion のいずれかでなければなりません。エンティティ ID は必須です。
AVAILABILITY_CHANGED 商品を入手できないか、商品が不足していてリクエストを履行できません。エンティティ ID は必須です。
PRICE_CHANGED アイテムの価格とアイテム エンティティの価格が異なります。エンティティ ID と最新の価格が必要です。
INCORRECT_PRICE 手数料、合計金額に誤りがあります。エンティティ ID と最新の価格が必要です。
REQUIREMENTS_NOT_MET 最小バスケット サイズなど、受注の制約を満たしていません。
TOO_LATE FulfillmentOption が期限切れです。
NO_CAPACITY 利用可能なサービス容量がありません。
INELIGIBLE ユーザーに発注する資格がありません(ブラックリストに登録済み)。
OUT_OF_SERVICE_AREA 輸出規制などが原因で、リクエストされた住所に配送できません。
CLOSED レストランのラストオーダーの時間を過ぎています。
PROMO_NOT_APPLICABLE 一般的なエラーコード。プロモーション コードの適用に失敗した原因が次のいずれにも該当しない場合に使用されます。エンティティ ID としてプロモーション コードを追加します。
PROMO_NOT_RECOGNIZED クーポンコードがパートナーによって認識されませんでした。エンティティ ID としてプロモーション コードを追加します。
PROMO_EXPIRED プロモーション期間が終了したため、適用できませんでした。エンティティ ID としてプロモーション コードを追加します。
PROMO_USER_INELIGIBLE 現在のユーザーはこのクーポンを利用する資格を持っていません。エンティティ ID としてプロモーション コードを追加します。
PROMO_ORDER_INELIGIBLE 現在の注文はこのクーポンの対象ではありません。エンティティ ID としてプロモーション コードを追加します。
UNAVAILABLE_SLOT 事前注文枠が使用できません。
FAILED_PRECONDITION 最小バスケット サイズなど、受注の制約を満たしていません。
PAYMENT_DECLINED 支払いが無効です。
MERCHANT_UNREACHABLE 販売者に接続できません。パートナーがアグリゲータであるものの、販売者に連絡できない場合に役立ちます。

TicketOrderExtension

映画、スポーツなどのチケット注文の注文内容。

JSON 表現
{
  "ticketEvent": {
    object (TicketEvent)
  }
}
フィールド
ticketEvent

object (TicketEvent)

すべての項目チケットに適用されるイベント。

TicketEvent

単一のイベントを表します。

JSON 表現
{
  "type": enum (Type),
  "name": string,
  "description": string,
  "url": string,
  "location": {
    object (Location)
  },
  "eventCharacters": [
    {
      object (EventCharacter)
    }
  ],
  "startDate": {
    object (Time)
  },
  "endDate": {
    object (Time)
  },
  "doorTime": {
    object (Time)
  }
}
フィールド
type

enum (Type)

必須: チケット イベントのタイプ(映画、コンサートなど)。

name

string

必須: イベントの名前。たとえば、イベントが映画の場合は、映画の名前を指定します。

description

string

イベントの説明。

url

string

イベント情報への URL。

location

object (Location)

イベントが行われる場所、または組織の所在地。

eventCharacters[]

object (EventCharacter)

このイベントの関係者。映画イベントの監督や俳優、コンサートのパフォーマーなどが該当します。

startDate

object (Time)

開始時間。

endDate

object (Time)

終了時間。

doorTime

object (Time)

入場時間。イベントの開始時間とは異なる場合があります。たとえば、イベントは午前 9 時に開始されますが、入場時間は午前 8 時 30 分です。

種類

イベントのタイプ。

列挙型
EVENT_TYPE_UNKNOWN 不明なイベントタイプ。
MOVIE 映画
CONCERT コンサート
SPORTS スポーツ

EventCharacter

イベントに関する人物。たとえば主催者、演奏者など。

JSON 表現
{
  "type": enum (Type),
  "name": string,
  "image": {
    object (Image)
  }
}
フィールド
type

enum (Type)

イベントのキャラクターのタイプ(俳優、ディレクターなど)。

name

string

キャラクターの名前。

image

object (Image)

キャラクターの画像

種類

イベントに関係する人物のタイプ。

列挙型
TYPE_UNKNOWN 不明なタイプ。
ACTOR 俳優
PERFORMER 出演者
DIRECTOR 監督
ORGANIZER 主催者